Sign in
Receiving Receipt

Partially update a specific receipt for a purchase or sales order

patch/api/receiving/receipts/{receiptId}

Path parameters

receiptIdstring required

Response

Receipt

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.

Changes

Changed in 4 of the 23 revisions of this API.18

  • d743ab8b105f11See the full diff
    • ▲

      the / request property type changed from string to no type

      request-property-type-changed

    • ○

      added the new optional request property /

      new-optional-request-property

  • ad309c11f9544See the full diff
    • ○

      added the optional property // to the response with the status (media type: application/json)

      response-optional-property-added

    • ○

      added the optional property // to the response with the status (media type: application/problem+json)

      response-optional-property-added

    • ○

      added the optional property // to the response with the status (media type: application/json)

      response-optional-property-added

    • ○

      added the optional property // to the response with the status (media type: application/problem+json)

      response-optional-property-added

  • c002514312371See the full diff
    • ○

      added the non-success response with the status

      response-non-success-status-added

  • 1b5649cff14a2See the full diff
    • ○

      added the optional property to the response with the status (media type: application/json)

      response-optional-property-added

    • ○

      added the optional property to the response with the status (media type: application/problem+json)

      response-optional-property-added