v1

latestOpenAPI 3.0.3Apache 2.02026-08-062991191002.1 KB
PurchaseOrder

Retrieves the collection of PurchaseOrder resources.

Retrieves the collection of PurchaseOrder resources.

get/purchase_orders

Query parameters

pageinteger

The collection page number

itemsPerPageinteger

The number of items per page

Response

PurchaseOrder collection

idstring
integrationstring

The key of the integration source e.g. "quickbooks", or "xero"

srcIdstring
vendorIdstring

Vendor Id

vendorNamestring nullable

Vendor name

currencystring nullable

Currency code e.g. USD

totalAmountinteger

Total amount of the purchase e.g. 1000

poStatusstring nullable

Purchase order status, either open or closed e.g. Open

createdstring date-time nullable

Date entry was created

modifiedstring date-time nullable

Date entry was last modified

referenceNumberstring nullable

Purchase order reference number

deliveryDatestring nullable

Date purchase order was delivered

subtotalinteger nullable

Subtotal

txnStatusstring nullable

Transaction status

Example response

[
  {
    "integration": "quickbooks"
  }
]