Sign in

v2

latestOpenAPI 3.0.42026-08-084694591.6 MB
Purchase Order

Partially update a purchase order

patch/api/purchase-orders/{purchaseOrderId}

Path parameters

purchaseOrderIdstring required

Response

Purchase order item

idstring required

Unique id associated to this entity.

numberinteger required

Number

issueDatestring date-time nullable

PO creation date

earliestReceiveDatestring date-time nullable

Earliest Receive Date

orderDatestring date-time nullable

PO order date (null until status set to Ordered)

expectedReceiveDatestring date-time nullable

PO Expected receipt date

promiseDatestring date-time nullable

PO Promise date.

vendorIdstring required

Vendor Id

contactIdstring required

Vendor Contact Id

paymentTermsIdstring nullable

Payment terms key identifier. Please reference /api/payment-terms endpoint.

type'standard' | 'outsideProcessing' | 'vendorCredit' required

Purchase order type

status'draft' | 'needsApproval' | 'approved' | 'ordered' | 'paid' | 'cancelled' required

Purchase order status

receivingStatus'notReceived' | 'partiallyReceived' | 'received' required

Purchase order receipt status

vendorCreditnumber double nullable

Vendor credit applied to this purchase order, if applicable

discountnumber double nullable

Discount applied to this purchase order, if applicable

subTotalnumber double

Total cost of this purchase order, sans tax (if applicable)

totalnumber double

Total cost of this purchase order, tax included (if applicable)

companyInfoIdstring required

Company Information Id;

vendorNotestring nullable

The vendor note is a string property that represents a note provided to the vendor.

notesstring[] nullable

Notes

externalReferencesobject nullable

External references associated with this entity.

customFieldsobject nullable

Custom fields that have been defined on this entity.

deletedboolean

Indicates whether this purchase order has been deleted

currencyCodestring nullable

Currency code/denomination associated to this vendor. If not provided, default to the primary currency code for the organization.

vendorOrderNumberstring nullable

The vendor's purchase order number