Sign in

v2

latestOpenAPI 3.0.42026-08-084694591.6 MB
Purchase Order

Find purchase orders based on search parameters.

post/api/purchase-orders/list

Query parameters

Sort.Fieldstring

Sort field

Sort.Dir'ascending' | 'descending'

Specify sorting direction.

Sort direction

Skipinteger

Number of records to skip.

Takeinteger

Number of records to return (maximum)

Request body

numbersinteger[] nullable

Filter purchase orders to only given numbers

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

Purchase order status

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

Purchase order receipt status

includeReceiptDataboolean

If set to true, receipt data will be included in the results

vendorIdstring nullable

The vendor id.

Response

List of purchase orders matching the filters

idstring required

Unique id associated to this entity.

numberinteger required

Number

issueDatestring date-time nullable

PO creation date

orderDatestring date-time nullable

PO order date (null until status set to Ordered)

vendorIdstring required

Vendor Id

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

expectedReceiveDatestring date-time nullable

PO Expected receipt date

customFieldDataobject nullable

Custom Fields

externalReferencesobject nullable

External references associated with this entity.

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

vendorNotestring nullable

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