Item Receipts PATCH API Documentation

Purpose

Update an existing item receipt's metadata and receipt line details. This endpoint supports partial updates to an item receipt, allowing modifications to the receipt status, date, note, and the receipt line quantities. It does not create new receipt lines but allows updating the quantities and remaining balance on existing lines. Only the fields provided in the request body are updated; omitted fields retain their current values. The purchase order association remains unchanged from the original receipt.

Use Case

This endpoint is used to modify an existing item receipt after it has been created. Common scenarios include correcting the receipt date or status, updating the note with additional information discovered after initial receipt, and adjusting receipt quantities when a recount reveals discrepancies between the initially recorded quantities and the actual goods received. Warehouse managers use this endpoint during inventory reconciliation to correct receipt records that were entered with incorrect quantities due to counting errors or damaged goods discovered during inspection. It also supports workflows where a receipt is initially created in a pending status and later updated to a confirmed status after quality checks are completed. The receipt_left field on each line can be updated to reflect the remaining quantity still expected from the supplier.

Path Parameters

Parameter	Type	Description
item_receipt_id	String	The unique ID of the item receipt (e.g., IR-65546809)

Query Parameters

No query parameters required.

Request Body

                JSON
              

                      {
    "item-receipt": {
        "receipt_status": "HELLO",
        "date": "2025-11-23",
        "purchase_order_id": "PO-RTO8M6-0006",
        "note": "",
        "receipts": [
            {
                "receipt_quantity": "20",
                "receipt_left": ""
            }
        ]
    }
}
                    

Attribute	Type	Description
receipt_status	String	Updated status of the item receipt (optional)
date	String (ISO 8601)	Updated date of the item receipt (optional)
purchase_order_id	String	Associated purchase order ID (optional)
note	String	Updated note or description for the receipt (optional)
receipts	Array	List of receipt line items to update (optional)
receipts[].receipt_quantity	String	Updated quantity received
receipts[].receipt_left	String	Updated remaining quantity to receive

Response

Returns the complete item receipt object nested under the purchaseOrder wrapper, reflecting the current state after the update. The response includes the itemReceipts array where each receipt contains the updated receipt status, date, human-readable ID, associated purchase order ID, tracking number, note, and a receipts array with the line-level details including line UUID, item ID, unit of measure, warehouse, quantity received, and remaining quantity. Audit fields are updated to reflect the modification, and the version field is incremented for optimistic concurrency control. The pagination object provides metadata for navigating through results.

Response Body

                JSON
              

                      {
    "purchaseOrder": {
        "itemReceipts": [
            {
                "receiptStatus": "RECEIPT_STATUS",
                "date": "RECEIPT_DATE",
                "id": "ITEM_RECEIPT_ID",
                "purchaseOrderId": "PURCHASE_ORDER_ID",
                "trackingNumber": "TRACKING_NUMBER",
                "note": "RECEIPT_NOTE",
                "receipts": [
                    {
                        "lineUuid": "LINE_UUID",
                        "itemId": "ITEM_ID",
                        "uom": "UNIT_OF_MEASURE",
                        "warehouse": "WAREHOUSE",
                        "receiptQuantity": "RECEIPT_QUANTITY",
                        "receiptLeft": "RECEIPT_LEFT"
                    }
                ],
                "createdBy": "CREATED_BY_USER",
                "createdOn": "CREATED_ON_DATETIME",
                "lastUpdatedBy": "LAST_UPDATED_BY_USER",
                "lastUpdatedOn": "LAST_UPDATED_ON_DATETIME",
                "uuid": "ITEM_RECEIPT_UUID",
                "version": "ITEM_RECEIPT_VERSION"
            }
        ],
        "pagination": {
            "records": "TOTAL_RECORD_COUNT",
            "limit": "PAGE_LIMIT",
            "offset": "PAGE_OFFSET",
            "previousPage": "PREVIOUS_PAGE_URL",
            "nextPage": "NEXT_PAGE_URL"
        }
    }
}
                    

Attribute	Type	Description
itemReceipts	Array	List of item receipts
receiptStatus	String	Status of the item receipt
date	String (ISO 8601)	Date of the item receipt
id	String	Human-readable item receipt ID
purchaseOrderId	String	Associated purchase order ID
trackingNumber	String	Shipment tracking number
note	String	Note or description for the receipt
receipts	Array	List of receipt line items
receipts[].lineUuid	String (UUID)	UUID of the purchase order line item
receipts[].itemId	String	Human-readable item identifier
receipts[].uom	String	Unit of measure
receipts[].warehouse	String	Warehouse identifier
receipts[].receiptQuantity	String	Quantity received
receipts[].receiptLeft	String	Remaining quantity to receive
createdBy	String	Username of the receipt creator
createdOn	String (ISO 8601)	Timestamp when the receipt was created
lastUpdatedBy	String	Username of the last editor
lastUpdatedOn	String (ISO 8601)	Timestamp of the last update
uuid	String (UUID)	UUID of the item receipt
version	String	Version number of the item receipt
pagination.records	Integer	Total number of matching records
pagination.limit	Integer	Page size limit
pagination.offset	Integer	Current page offset
pagination.previousPage	String	URL for the previous page of results
pagination.nextPage	String	URL for the next page of results

Update an Item Receipt: /item-receipts/{id}