Sign in
Purchase Order

Get a specific purchase order

get/api/purchase-orders/{purchaseOrderId}

Path parameters

purchaseOrderIdstring required

Response

The purchase order for the given id

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 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

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

Changes

Changed in 1 of the 12 revisions of this API.4

  • c4b2ba5fc2704See the full diff
    • ▲

      the response property contactId became nullable for the status 200 (media type: application/json)

      response-property-became-nullable

    • ▲

      the response property contactId became nullable for the status 200 (media type: application/problem+json)

      response-property-became-nullable

    • ▲

      the response property contactId became optional for the status 200 (media type: application/json)

      response-property-became-optional

    • ▲

      the response property contactId became optional for the status 200 (media type: application/problem+json)

      response-property-became-optional