idstring required
Unique id associated to this entity.
issueDatestring date-time nullable
earliestReceiveDatestring date-time nullable
orderDatestring date-time nullable
PO order date (null until status set to Ordered)
expectedReceiveDatestring date-time nullable
promiseDatestring date-time nullable
contactIdstring nullable
Vendor Contact Id. Null for purchase orders that have no contact.
paymentTermsIdstring nullable
Payment terms key identifier. Please reference /api/payment-terms endpoint.
type'standard' | 'outsideProcessing' | 'vendorCredit' required
status'draft' | 'needsApproval' | 'approved' | 'ordered' | 'paid' | 'cancelled' required
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
vendorNotestring nullable
The vendor note is a string property that represents a note provided to the vendor.
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