Update Receipt

PATCH /inventory/receipts/{id}

Group: Inventory › Receipts · Operation ID: updateReceipt

Updates the receipt with the given identifier. Only the fields in the request body change.

Updates one draft receipt. Only the fields in the request body change. Only a draft can be edited. Once committed, a receipt is corrected with a purchase return or a credit instead.

Lines change through three arrays, applied in order: deleteLines, then updateLines, then createLines, so one call can remove a line and add its replacement. A line's batches, serials and binLocations arrays each replace what the line had when you send them, and are left untouched when you omit them. A line id that belongs to another receipt is rejected.

The response is the updated receipt in full.

Open in the interactive reference

Parameters

Name In Type Required Description
Api-Version header "v1" yes The API version this request targets, named by its public identifier. Required on every request; omitting it, or naming a version this company does not have, is answered with 400. This document describes version v1.
Idempotency-Key header string no An opaque caller-chosen string (1-255 characters) that makes this request safe to retry. Repeating the same key with an identical request body replays the original response instead of re-executing - but only once that original request succeeded; a failed attempt re-executes on retry. Repeating the key with a different body is answered with 422. A key still in flight is answered with 409 - as is a key whose original request was interrupted before it finished, for a few minutes afterwards, until that attempt is presumed dead. A completed response stays replayable for 24 hours. The key is scoped to the caller, not to the action: reusing it for a different action is answered with 409 or 422 rather than treated independently. On read actions this header is ignored. On write actions that cannot offer the guarantee it is answered with 400 IDEMPOTENCY_NOT_SUPPORTED rather than silently ignored.
id path string yes The unique identifier for the receipt to update.

Request body

Required, application/json: updateReceiptInput.

Field Type Required Description
businessPartnerId string no A new vendor for the receipt.
documentDate string (date) no A new date for the receipt. Use format YYYY-MM-DD.
deliveryDate string (date) no A new delivery date. Use format YYYY-MM-DD.
currency string no A new currency for the receipt's amounts. Format ISO 4217, for example 'EUR'.
referenceNumber string no A new vendor reference.
notes string no New free text. Send an empty string to clear it.
deleteLines array of string no The ids of lines to remove. Applied before updateLines and createLines.
updateLines array of object no The lines to change, addressed by id. Applied after deleteLines and before createLines.
updateLines[].id string yes The unique identifier for the line to change. A line that belongs to another receipt is rejected.
updateLines[].lineType string, one of "Inventory", "Service", "Expense" no A new type for the line.
updateLines[].itemId string no A new item for the line.
updateLines[].serviceDescription string no A new description, on a Service or Expense line.
updateLines[].locationId string no A new warehouse for the line.
updateLines[].unitId string no A new unit for the line's quantity.
updateLines[].quantity string (decimal) no A new quantity, in the line's unit. Greater than zero when given.
updateLines[].unitPrice string (decimal) no A new unit price, in the receipt's currency.
updateLines[].lineTotal string (decimal) no A new line total, in the receipt's currency.
updateLines[].expenseAccountId string no A new GL account for a Service or Expense line.
updateLines[].notes string no New free text. Send an empty string to clear it.
updateLines[].batches array of object no The batches received on this line. Required for a batch-tracked item, and the quantities must add up to the line's quantity. When you send it on update, it replaces the line's batches.
updateLines[].batches[].batchNumberId string no The unique identifier for an existing batch. Omit it and give batchNumber for a batch arriving for the first time, and the batch record is created.
updateLines[].batches[].batchNumber string no The batch number as printed on the delivery. Required unless batchNumberId is given.
updateLines[].batches[].expirationDate string (date) no The expiration date of the batch. Format YYYY-MM-DD.
updateLines[].batches[].quantity string (decimal) yes The quantity of this batch received, in the line's unit. The batch quantities of a line must add up to the line's quantity.
updateLines[].serials array of object no The serialized units received, one entry per unit. Required for a serialized item, and the count must equal the line's quantity. When you send it on update, it replaces the line's serials.
updateLines[].serials[].serialNumberId string no The unique identifier for an existing serial record. Omit it and give serialNumber for a unit arriving for the first time.
updateLines[].serials[].serialNumber string no The serial number stamped on the unit. Required unless serialNumberId is given.
updateLines[].binLocations array of object no The bins the goods go into, in a bin-tracked warehouse. One flat array, where an entry may name a batchNumber or serialNumber of its own line. When you send it on update, it replaces the line's bin entries.
updateLines[].binLocations[].binLocationId string yes The bin the goods go into.
updateLines[].binLocations[].quantity string (decimal) yes The quantity going into this bin, in the line's unit.
updateLines[].binLocations[].batchNumber string no Names one of this line's batches, when the bin entry belongs to it.
updateLines[].binLocations[].serialNumber string no Names one of this line's serialized units, when the bin entry belongs to it.
createLines array of object no The lines to add.
createLines[].lineType string, one of "Inventory", "Service", "Expense" no What this line receives. Defaults to Inventory. An Inventory line needs itemId, unitId, locationId and quantity, because it moves stock into a warehouse. A Service or Expense line needs serviceDescription and an amount, and has no item or warehouse. A line with a description and no item is taken as a Service line.
createLines[].itemId string no The item received. Required on an Inventory line, and not used on a Service or Expense line.
createLines[].serviceDescription string no What was bought. Required on a Service or Expense line, and not used on an Inventory line.
createLines[].locationId string no The warehouse the goods go into. Required on an Inventory line.
createLines[].unitId string no The unit the quantity is counted in. Required on an Inventory line.
createLines[].quantity string (decimal) no The quantity received, in that unit. Required on an Inventory line, and greater than zero.
createLines[].unitPrice string (decimal) no The price of one unit, in the receipt's currency.
createLines[].lineTotal string (decimal) no The total for the line, in the receipt's currency. On a Service or Expense line, give this or a unitPrice.
createLines[].expenseAccountId string no The GL account to charge. Required on a Service or Expense line, and not used on an Inventory line. Without it, the commit fails when it posts the journal entry.
createLines[].sourceDocumentLineId string no The purchase order line this line receives against, as its id under lines on GET accounting/purchase-orders/:id. Its numeric id in string form is also accepted. The line type is set from it.
createLines[].notes string no Free text on the line.
createLines[].batches array of object no The batches received on this line. Required for a batch-tracked item, and the quantities must add up to the line's quantity. When you send it on update, it replaces the line's batches.
createLines[].batches[].batchNumberId string no The unique identifier for an existing batch. Omit it and give batchNumber for a batch arriving for the first time, and the batch record is created.
createLines[].batches[].batchNumber string no The batch number as printed on the delivery. Required unless batchNumberId is given.
createLines[].batches[].expirationDate string (date) no The expiration date of the batch. Format YYYY-MM-DD.
createLines[].batches[].quantity string (decimal) yes The quantity of this batch received, in the line's unit. The batch quantities of a line must add up to the line's quantity.
createLines[].serials array of object no The serialized units received, one entry per unit. Required for a serialized item, and the count must equal the line's quantity. When you send it on update, it replaces the line's serials.
createLines[].serials[].serialNumberId string no The unique identifier for an existing serial record. Omit it and give serialNumber for a unit arriving for the first time.
createLines[].serials[].serialNumber string no The serial number stamped on the unit. Required unless serialNumberId is given.
createLines[].binLocations array of object no The bins the goods go into, in a bin-tracked warehouse. One flat array, where an entry may name a batchNumber or serialNumber of its own line. When you send it on update, it replaces the line's bin entries.
createLines[].binLocations[].binLocationId string yes The bin the goods go into.
createLines[].binLocations[].quantity string (decimal) yes The quantity going into this bin, in the line's unit.
createLines[].binLocations[].batchNumber string no Names one of this line's batches, when the bin entry belongs to it.
createLines[].binLocations[].serialNumber string no Names one of this line's serialized units, when the bin entry belongs to it.

Example:

{
  "businessPartnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "documentDate": "2026-01-15",
  "deliveryDate": "2026-01-15",
  "currency": "<currency>",
  "referenceNumber": "DN-77121",
  "notes": "<notes>",
  "deleteLines": [
    "<deleteLines>"
  ],
  "updateLines": [
    {
      "id": "8c14a6f2-3b70-4d59-9e02-6f5a1d38b47c",
      "quantity": "196.00"
    }
  ],
  "createLines": [
    {
      "lineType": "Inventory",
      "itemId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "serviceDescription": "<serviceDescription>",
      "locationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "quantity": "19.99",
      "unitPrice": "19.99",
      "lineTotal": "19.99",
      "expenseAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "sourceDocumentLineId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "notes": "<notes>",
      "batches": [
        {
          "batchNumberId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "batchNumber": "<batchNumber>",
          "expirationDate": "2026-01-15",
          "quantity": "19.99"
        }
      ],
      "serials": [
        {
          "serialNumberId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "serialNumber": "<serialNumber>"
        }
      ],
      "binLocations": [
        {
          "binLocationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "quantity": "19.99",
          "batchNumber": "<batchNumber>",
          "serialNumber": "<serialNumber>"
        }
      ]
    }
  ]
}

Response

200 Success

Under data (updateReceiptOutput):

Field Type Required Description
id string yes The unique identifier for the receipt.
documentNumber string no The receipt number, for example 'GR-2291'. Assigned when the receipt is created.
documentStatus string yes The status of the receipt. It is DRAFT when the receipt is created through this API and COMMITTED once you commit it with POST inventory/receipts/:id/commit. The receiving and invoicing processes set the other statuses.
documentDate string (date) yes The date of the receipt. Format YYYY-MM-DD.
deliveryDate string (date) no The date the goods arrived or are expected. Format YYYY-MM-DD.
entityId string yes The legal entity the receipt belongs to.
entityName string no The name of that legal entity.
businessPartnerId string yes The vendor the goods came from.
businessPartnerName string no The name of that vendor.
referenceNumber string no The vendor's own reference, typically their delivery note number.
currency string no The currency of the receipt's amounts. Format ISO 4217, for example 'EUR'. This is the vendor's currency, which need not be the entity's functional currency. See functionalUnitPrice on the line for the functional-currency amounts.
totalAmount string (decimal) no The total value of the receipt, in the receipt's currency.
notes string no Free text on the receipt.
createdDate string (date-time) no The date and time the receipt was created, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ.
lastModifiedDate string (date-time) no The date and time the receipt last changed, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ.
lines array of object yes The lines of the receipt, oldest first. A receipt always has at least one line.
lines[].id string yes The unique identifier for the line. Use it in updateLines and deleteLines.
lines[].lineType string no The type of the line. Possible values: 'Inventory', 'Service', 'Expense'. Only an Inventory line moves stock. A Service or Expense line records something bought that does not enter a warehouse and has a description instead of an item.
lines[].itemId string no The item received. Absent on a Service or Expense line.
lines[].itemCode string no The short code of that item.
lines[].itemName string no The name of that item.
lines[].serviceDescription string no What a Service or Expense line is for. Absent on an Inventory line.
lines[].locationId string no The warehouse the goods went into. Absent on a Service or Expense line.
lines[].locationCode string no The short code of that warehouse.
lines[].locationName string no The name of that warehouse.
lines[].unitId string no The unit the quantity is counted in.
lines[].unitCode string no The short code of that unit.
lines[].quantity string (decimal) no The quantity received, in the line's unit.
lines[].inventoryQuantity string (decimal) no The same quantity in the item's stocking unit.
lines[].receivedQuantity string (decimal) no The quantity actually received, where the receiving process records it separately.
lines[].openQuantity string (decimal) no The quantity still to be invoiced.
lines[].returnedQuantity string (decimal) no The quantity that has gone back on a purchase return.
lines[].unitPrice string (decimal) no The price of one unit, in the receipt's currency.
lines[].lineTotal string (decimal) no The total for the line, in the receipt's currency.
lines[].functionalUnitPrice string (decimal) no The unit price in the entity's functional currency. Present when the receipt is in another currency.
lines[].functionalLineTotal string (decimal) no The line total in the entity's functional currency.
lines[].expenseAccountId string no The GL account a Service or Expense line is charged to. Absent on an Inventory line.
lines[].expenseAccountNumber string no The number of that account.
lines[].expenseAccountName string no The name of that account.
lines[].status string no Where the line is in the receiving process. This is free text, with no fixed set of values.
lines[].sourceDocumentLineId string no The purchase order line this line was received against. It is a numeric id in string form, not a UUID. Purchase order lines are not individually addressable, so there is no endpoint that takes it.
lines[].sourceDocumentLineType string, one of "IMInventorySalesOrderLine", "IMInventorySalesDeliveryLine", "IMSalesOrderLine", "IMInventoryPurchaseReturnLine", "IMInventorySalesReturnLine", "IMWarehouseTransferLine", "IMInventoryDecreaseLine", "IMInventoryIncreaseLine", "IMInventoryRevaluationLine", "IMInventoryTransferLine", "IMInventoryAdjustmentLine", "IMInventoryCountLine", "IMInventoryPutAwayTask", "IMInventoryPurchaseReturnReversal", "PurchaseOrderLine", "IMLandedCostAllocationLine", "SalesOrderProductItem", "IMWarehouseTransferOrderLine", "VendorBillItemBase", "InvPurchaseDeliveryLine" no The kind of source document line this receipt line was created from.
lines[].notes string no Free text on the line.
lines[].batches array of object no The batches received on this line, for a batch-tracked item. Absent when the item is not batch-tracked.
lines[].batches[].batchNumberId string no The unique identifier for the batch record this entry created or matched.
lines[].batches[].batchNumber string yes The batch number as printed.
lines[].batches[].expirationDate string (date) no The expiration date of the batch. Format YYYY-MM-DD.
lines[].batches[].quantity string (decimal) yes The quantity of this batch received, in the line's unit.
lines[].batches[].inventoryQuantity string (decimal) no The same quantity in the item's stocking unit.
lines[].batches[].openQuantity string (decimal) no The quantity of this batch still to be invoiced.
lines[].batches[].returnedQuantity string (decimal) no The quantity of this batch that has gone back to the vendor.
lines[].batches[].unitCost string (decimal) no The cost of one unit of this batch, in the receipt's currency.
lines[].serials array of object no The serialized units received, one entry per unit. Absent when the item is not serialized.
lines[].serials[].serialNumberId string no The unique identifier for the serial record this entry created or matched.
lines[].serials[].serialNumber string yes The serial number as stamped on the unit.
lines[].serials[].openQuantity string (decimal) no The quantity of this unit still to be invoiced.
lines[].serials[].returnedQuantity string (decimal) no The quantity of this unit that has gone back to the vendor.
lines[].serials[].unitCost string (decimal) no The cost of this unit, in the receipt's currency.
lines[].binLocations array of object no The bins the goods went into, in a bin-tracked warehouse. One flat array per line: an entry that names a batchNumber or serialNumber belongs to that batch or unit, and one that names neither belongs to the line.
lines[].binLocations[].binLocationId string yes The bin the goods went into.
lines[].binLocations[].binLocationCode string no The short code of that bin.
lines[].binLocations[].quantity string (decimal) yes The quantity put into this bin, in the line's unit.
lines[].binLocations[].inventoryQuantity string (decimal) no The same quantity in the item's stocking unit.
lines[].binLocations[].batchNumber string no The batch this bin entry belongs to, when it belongs to one of the line's batches.
lines[].binLocations[].serialNumber string no The serialized unit this bin entry belongs to, when it belongs to one of the line's units.

Response headers

Errors

Code Status
NOT_FOUND 400
WRONG_STATUS 400
REFERENCE_NOT_FOUND 400
NO_LINES 400
INVALID_QUANTITY 400
INCOMPLETE_LINE 400
DUPLICATE_TRACKING_NUMBER 400
UNKNOWN_TRACKING_REFERENCE 400
POSTING_REJECTED 400
IDEMPOTENCY_KEY_CONFLICT 409
IDEMPOTENCY_PAYLOAD_MISMATCH 422

Statuses