Item Receipts GET API Documentation

Purpose

This API retrieves a paginated list of all item receipt records available in the system. It returns high-level details for each receipt, including receipt ID, status, linked purchase order, tracking number, warehouse, received quantity, and audit details. This helps users or systems access and review all recorded item receipts in a centralized view.

Use Case

Use this API to display or synchronize all item receipt records across the organization. Common use cases include generating reports, verifying pending receipts, tracking incoming goods by purchase order, and validating received quantities during inventory reconciliation.

Path Parameters

This endpoint does not require any path parameters.

Query Parameters

Parameter	Type	Description
limit	Integer	Maximum number of records to return per page. Default: 20.
offset	Integer	Number of records to skip before starting to return results.

Request Body

This API does not require a request body.

Response

The response contains a list of all item receipts along with pagination metadata. Each record includes core receipt information such as ID, status, date, tracking number, linked purchase order ID, notes, item-level receipt details (including quantity received and remaining), and audit fields for tracking changes. Pagination metadata is also included to manage large datasets efficiently.

Response Body

                JSON
              

                      {
    "item_receipts": [
        {
            "receipt_status": "{{receipt_status}}",
            "date": "{{receipt_date}}",
            "id": "{{receipt_id}}",
            "purchase_order_id": "{{purchase_order_id}}",
            "tracking_number": "{{tracking_number}}",
            "note": "{{receipt_note}}",
            "receipts": [
                {
                    "line_uuid": "{{line_uuid}}",
                    "item_id": "{{item_id}}",
                    "uom": "{{unit_of_measure}}",
                    "warehouse": "{{warehouse_name}}",
                    "receipt_quantity": "{{received_quantity}}",
                    "receipt_left": "{{remaining_quantity}}"
                }
            ],
            "created_by": "{{created_by_user}}",
            "created_on": "{{created_timestamp}}",
            "last_updated_by": "{{last_updated_by_user}}",
            "last_updated_on": "{{last_updated_timestamp}}",
            "uuid": "{{receipt_uuid}}",
            "version": "{{record_version}}"
        }
    ],
    "pagination": {
        "records": "{{total_records}}",
        "limit": "{{limit_value}}",
        "offset": "{{offset_value}}",
        "previous_page": "{{previous_page_link}}",
        "next_page": "{{next_page_link}}"
    }
}

                    

Attribute	Type	Description
item_receipts	Array	List of all item receipt records.
item_receipts.receipt_status	String	Current status of the receipt (example: PENDING, CLOSED).
item_receipts.date	String	Date when the receipt was recorded, in ISO 8601 format.
item_receipts.id	String	Unique identifier of the item receipt.
item_receipts.purchase_order_id	String	Identifier of the purchase order associated with this receipt.
item_receipts.tracking_number	String	Tracking number for the received shipment.
item_receipts.note	String	Additional note or comment about the receipt.
item_receipts.receipts	Array	List of items included in this receipt.
item_receipts.receipts.line_uuid	String	Unique identifier for the receipt line item.
item_receipts.receipts.item_id	String	Unique identifier of the received item.
item_receipts.receipts.uom	String	Unit of measurement for the item.
item_receipts.receipts.warehouse	String	Name of the warehouse where items were received.
item_receipts.receipts.receipt_quantity	String	Quantity of items received in this transaction.
item_receipts.receipts.receipt_left	String	Remaining quantity yet to be received for the item.
item_receipts.created_by	String	User who created the receipt record.
item_receipts.created_on	String	Timestamp when the receipt record was created.
item_receipts.last_updated_by	String	User who last updated the receipt record.
item_receipts.last_updated_on	String	Timestamp of the last update.
item_receipts.uuid	String	System-generated unique identifier for the receipt.
item_receipts.version	String	Version number of the receipt record.
pagination	Object	Contains pagination metadata.
pagination.records	Integer	Total number of records returned.
pagination.limit	Integer	Number of records per page.
pagination.offset	Integer	Number of records skipped.
pagination.previous_page	String	URL for the previous page of results (if available).
pagination.next_page	String	URL for the next page of results (if available).

Purpose

This API retrieves the full details of a specific item receipt using its unique identifier. It returns comprehensive data about the receipt, including linked purchase order details, tracking number, item-level quantities, and audit metadata.

Use Case

Use this API when a user or system needs to view or verify the full details of a specific item receipt record, for example, during inspection, auditing, or reporting processes where a single receipt must be reviewed in detail.

Path Parameters

Parameter	Type	Description
item_receipt_id	String	Unique identifier of the item receipt to retrieve.

Query Parameters

This endpoint does not support query parameters.

Request Body

This API does not require a request body.

Response

The response contains all details of a specific item receipt, including metadata, item-level breakdowns, warehouse details, and linked order identifiers. It ensures complete traceability and accuracy of received items within the inventory workflow.

Response Body

                JSON
              

                      {
    "item_receipt": {
        "receipt_status": "{{receipt_status}}",
        "date": "{{receipt_date}}",
        "id": "{{receipt_id}}",
        "purchase_order_id": "{{purchase_order_id}}",
        "tracking_number": "{{tracking_number}}",
        "note": "{{receipt_note}}",
        "receipts": [
            {
                "line_uuid": "{{line_uuid}}",
                "item_id": "{{item_id}}",
                "uom": "{{unit_of_measure}}",
                "warehouse": "{{warehouse_name}}",
                "receipt_quantity": "{{received_quantity}}",
                "receipt_left": "{{remaining_quantity}}"
            }
        ],
        "created_by": "{{created_by_user}}",
        "created_on": "{{created_timestamp}}",
        "last_updated_by": "{{last_updated_by_user}}",
        "last_updated_on": "{{last_updated_timestamp}}",
        "uuid": "{{receipt_uuid}}",
        "version": "{{record_version}}"
    }
}

                    

Attribute	Type	Description
item_receipt	Object	Contains detailed data of the requested item receipt.
item_receipt.receipt_status	String	Status of the receipt (example: PENDING, CLOSED).
item_receipt.date	String	Date of the receipt record.
item_receipt.id	String	Identifier of the receipt.
item_receipt.purchase_order_id	String	Linked purchase order ID.
item_receipt.tracking_number	String	Tracking number for the received shipment.
item_receipt.note	String	Optional note related to the receipt.
item_receipt.receipts	Array	List of received items under this receipt.
item_receipt.receipts.line_uuid	String	Unique identifier for each receipt line.
item_receipt.receipts.item_id	String	Identifier for the received item.
item_receipt.receipts.uom	String	Unit of measurement used for the item.
item_receipt.receipts.warehouse	String	Warehouse where the items were received.
item_receipt.receipts.receipt_quantity	String	Quantity received.
item_receipt.receipts.receipt_left	String	Remaining quantity yet to be received.
item_receipt.created_by	String	User who created the record.
item_receipt.created_on	String	Timestamp of creation.
item_receipt.last_updated_by	String	User who last updated the record.
item_receipt.last_updated_on	String	Timestamp of last update.
item_receipt.uuid	String	System-generated unique identifier.
item_receipt.version	String	Version number of the record.

Purpose

This API retrieves all item receipt records associated with a specific purchase order. It is used to track the receiving process of ordered goods, providing insights into how many items have been received and what is still pending.

Use Case

Use this API to view all item receipts linked to a particular purchase order. It is useful for procurement and warehouse teams to monitor the fulfillment progress of purchase orders, manage partial receipts, and reconcile deliveries.

Path Parameters

Parameter	Type	Description
purchase_order_id	String	Unique identifier of the purchase order whose item receipts need to be retrieved.

Query Parameters

Parameter	Type	Description
limit	Integer	Maximum number of item receipt records to return.
offset	Integer	Number of records to skip before returning results.

Request Body

This API does not require a request body.

Response

The response contains all item receipts linked to the specified purchase order. Each receipt provides details such as receipt ID, status, tracking number, warehouse, received quantities, and audit details. Pagination data is included to handle multiple receipt records efficiently.

Response Body

                JSON
              

                      {
    "purchase_order": {
        "item_receipts": [
            {
                "receipt_status": "{{receipt_status}}",
                "date": "{{receipt_date}}",
                "id": "{{receipt_id}}",
                "purchase_order_id": "{{purchase_order_id}}",
                "tracking_number": "{{tracking_number}}",
                "note": "{{receipt_note}}",
                "receipts": [
                    {
                        "line_uuid": "{{line_uuid}}",
                        "item_id": "{{item_id}}",
                        "uom": "{{unit_of_measure}}",
                        "warehouse": "{{warehouse_name}}",
                        "receipt_quantity": "{{received_quantity}}",
                        "receipt_left": "{{remaining_quantity}}"
                    }
                ],
                "created_by": "{{created_by_user}}",
                "created_on": "{{created_timestamp}}",
                "last_updated_by": "{{last_updated_by_user}}",
                "last_updated_on": "{{last_updated_timestamp}}",
                "uuid": "{{receipt_uuid}}",
                "version": "{{record_version}}"
            }
        ],
        "pagination": {
            "records": "{{total_records}}",
            "limit": "{{limit_value}}",
            "offset": "{{offset_value}}",
            "previous_page": "{{previous_page_link}}",
            "next_page": "{{next_page_link}}"
        }
    }
}

                    

Attribute	Type	Description
purchase_order	Object	Root object containing item receipt data linked to the purchase order.
purchase_order.item_receipts	Array	List of all item receipt records for the specified purchase order.
purchase_order.item_receipts.receipt_status	String	Status of the item receipt.
purchase_order.item_receipts.date	String	Date when the receipt was recorded.
purchase_order.item_receipts.id	String	Unique identifier of the item receipt.
purchase_order.item_receipts.purchase_order_id	String	Purchase order associated with the receipt.
purchase_order.item_receipts.tracking_number	String	Tracking number for the received goods.
purchase_order.item_receipts.note	String	Optional note for the receipt.
purchase_order.item_receipts.receipts	Array	Details of items included in the receipt.
purchase_order.item_receipts.receipts.line_uuid	String	Unique identifier for the receipt line.
purchase_order.item_receipts.receipts.item_id	String	Item identifier.
purchase_order.item_receipts.receipts.uom	String	Unit of measurement used for the item.
purchase_order.item_receipts.receipts.warehouse	String	Warehouse where items were received.
purchase_order.item_receipts.receipts.receipt_quantity	String	Quantity received.
purchase_order.item_receipts.receipts.receipt_left	String	Quantity yet to be received.
purchase_order.item_receipts.created_by	String	Creator of the receipt record.
purchase_order.item_receipts.created_on	String	Creation timestamp.
purchase_order.item_receipts.last_updated_by	String	User who last modified the record.
purchase_order.item_receipts.last_updated_on	String	Last modification timestamp.
purchase_order.item_receipts.uuid	String	Unique identifier for the record.
purchase_order.item_receipts.version	String	Record version number.
purchase_order.pagination	Object	Pagination details.
purchase_order.pagination.records	Integer	Total number of records returned.
purchase_order.pagination.limit	Integer	Maximum number of records per page.
purchase_order.pagination.offset	Integer	Number of skipped records.
purchase_order.pagination.previous_page	String	URL for the previous page of results (if available).
purchase_order.pagination.next_page	String	URL for the next page of results (if available).

Retrieve All Item Receipts: /item-receipts

Purpose

Use Case

Path Parameters

Query Parameters

Request Body

Response

Response Body

Retrieve Specific Item Receipt Details: /item-receipts/{item_reciept_id}

Purpose

Use Case

Path Parameters

Query Parameters

Request Body

Response

Response Body

Retrieve All Item Receipts for an Specific Purchase Order: /purchase-orders/{purchase_order_id}/item-receipts

Purpose

Use Case

Path Parameters

Query Parameters

Request Body

Response

Response Body