v1

latestOpenAPI 3.1.12026-07-24260246894.7 KB
Purchase Orders

List purchase orders

Endpoint for retrieving a list of purchase orders.

get/purchase-orders/

Query parameters

branchstring

The unique identifier of the branch.

contactstring

The unique identifier of the contact.

created_ts_afterstring date-time

The timestamp in UTC when the purchase order was created.

created_ts_beforestring date-time

The timestamp in UTC when the purchase order was created.

external_idstring

External identifier.

modified_ts_afterstring date-time

The timestamp in UTC when the purchase order was last modified.

modified_ts_beforestring date-time

The timestamp in UTC when the purchase order was last modified.

pageinteger

A page number within the paginated result set.

page_sizeinteger

Number of results to return per page.

projectstring

The unique identifier of the project.

purchase_order_datestring date

The date of the purchase order.

referencestring

Reference.

statusstring

The status of the purchase order.

Response

countinteger required
nextstring uri nullable
previousstring uri nullable

Example response

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2"
}