Getting Item Receipts List

Function: item_receipt_list()

Purpose

This API retrieves a list of all item receipts within the system. Item receipts are documents that record the receipt of goods from suppliers against purchase orders. This endpoint allows users to view all existing receipts, including their statuses, associated purchase orders, tracking numbers, quantities received, warehouse details, and metadata such as creation and update timestamps. It is primarily used for auditing, monitoring incoming goods, or verifying received quantities against purchase orders.

Parameters

This function does not require any input parameters.

Use Case

Organizations often receive multiple shipments corresponding to various purchase orders. To manage inventory effectively and maintain transparency across procurement operations, they may need to list all item receipts available in the system. This API helps retrieve detailed information for each receipt, including the receipt ID, purchase order reference, tracking number, warehouse name, and quantities received or remaining. For instance, a warehouse manager can use this data to validate whether the goods received match the expected quantities, while an accounts department may use it for payment verification. The following examples demonstrate how to retrieve item receipt data using both Python and PHP SDKs.

Response

Upon a successful call, the API returns a list of all available item receipts along with pagination details. Each record contains the receipt status (example: PENDING or CLOSED), date of receipt, purchase order reference, tracking number, warehouse name, and details of the received items such as quantity received and remaining balance. Metadata like created and last updated timestamps, along with version and unique identifiers, are also included. This information enables users to track the flow of received goods, verify delivery status, and maintain consistency between physical and digital records.

Getting Item Receipt Details

Function: item_receipt_details()

Purpose

This API retrieves detailed information about a specific item receipt within the system. An item receipt records the goods received against a purchase order and includes item details, quantities received, warehouse location, and receipt status. This endpoint allows users to view all relevant information related to a single receipt, including tracking number, purchase order reference, and metadata such as creation and update information. It is primarily used for verifying received goods, validating supplier deliveries, and supporting auditing or reconciliation processes.

Parameters

Use Case

In a procurement workflow, when goods are received from a supplier, an item receipt is generated to confirm that the items have arrived as per the purchase order. A warehouse manager or quality inspector may need to verify the receipt details to ensure accuracy in item quantities, warehouse allocation, and tracking information. This API is used to fetch all such details for a specific receipt, including receipt status, date, tracking number, and item-level details. It also helps identify discrepancies between expected and actual quantities received, ensuring accountability and proper inventory recording. The following examples demonstrate how to retrieve item receipt details using both Python and PHP SDKs.

Response

A successful response returns the complete details of the specified item receipt. The response includes the receipt’s current status (example: PENDING or CLOSED), the date it was created, purchase order reference, tracking number, and notes if any. It also includes a list of items with their unique identifiers, quantity received, unit of measurement, and remaining balance. Additionally, metadata fields such as created by, created on, last updated by, and last updated on provide a full audit trail for record management. This helps ensure transparency and traceability for every goods receipt transaction within the system.

Getting Item Receipts for a Specific Purchase Order

Function: item_receipt_list_purchase_order()

Purpose

This API retrieves all item receipt records associated with a specific purchase order. An item receipt represents the confirmation of goods received against a purchase order and includes important information such as receipt status, tracking number, quantities received, and warehouse details. This endpoint enables users to view all receipts generated for a particular purchase order, allowing for efficient tracking of deliveries, validation of received quantities, and better visibility of inventory updates.

Parameters

Use Case

When goods are received in multiple batches or at different times for a single purchase order, each delivery is recorded as a separate item receipt. A procurement officer or warehouse manager can use this API to view all item receipts related to a specific purchase order, along with their current status and item details. This helps in tracking delivery progress, identifying pending quantities, and ensuring that all ordered items have been received as expected. It also aids in auditing and reconciliation between purchase orders and received goods. The following code snippets demonstrate how to retrieve item receipts for a purchase order using both Python and PHP SDKs.

Response

A successful response returns a list of all item receipts linked to the specified purchase order. Each item receipt contains details such as receipt status (example: PENDING or COMPLETED), receipt date, tracking number, and warehouse information. The response also includes item-level details like quantity received, remaining quantity, and unit of measurement. Pagination metadata is also included to handle large datasets, allowing clients to retrieve results in manageable chunks. This response provides complete traceability of all goods received against a purchase order, enabling users to monitor receipt progress and maintain accurate inventory records.