Sign in

v2

latestOpenAPI 3.0.42026-08-084694591.6 MB
Receiving Receipt

Create a receipt for a specific purchase or sales order

post/api/receiving/receipts

Request body

orderType'purchaseOrder' | 'salesOrder' required

Order type enum

orderIdstring required

Id of parent order to which this receipt belongs

Response

Receipt created

idstring required

Unique id associated to this entity.

receivedBystring nullable

Id of the user who received the item(s)

numbernumber double nullable

Number

datestring date-time nullable

Received date

dateOriginalstring date-time nullable

Original received date

dateOverridestring date-time nullable

Override received date

accountingHeldUtcstring date-time nullable

Set while the receipt's accounting events are withheld because it contains material held for incoming inspection (tenant invoice timing = after-inspection). Held receipts are excluded from the receipt list until their inspections resolve; cleared when the deferred events fire.

orderType'purchaseOrder' | 'salesOrder'

Order type enum

orderIdstring nullable

Id of parent order to which this receipt belongs

externalReferencesobject nullable

Arbitrary key-value-pair like data that can be used to later on search for this receipt object.

customFieldsobject nullable

Custom fields that have been defined on this entity.

invoiceNumberstring nullable

The vendor invoice invoice number associated to the receipt.