Purchase Orders

Get purchase orders

Use the following endpoints to retrieve all or filtered purchase orders.

GET /v1/companies/1234/purchase_orders Get all purchase orders for a company
GET /v1/companies/1234/purchase_orders/received Get all received purchase orders
GET /v1/companies/1234/purchase_orders/placed Get all placed purchase orders
GET /v1/companies/1234/sites/456/purchase_orders Get all purchase orders for a site
GET /v1/companies/1234/suppliers/789/purchase_orders Get all purchase orders for a supplier
GET /v1/companies/1234/purchase_orders ?created_gte=2017-04-05T10:00:00 Get all purchase orders created on or after a given time
GET /v1/companies/1234/purchase_orders ?created_lte=2017-04-05T10:00:00 Get all purchase orders created on or before a given time
GET /v1/companies/1234/purchase_orders ?received_gte=2017-04-05T10:00:00 Get all purchase orders received on or after a given time
GET /v1/companies/1234/purchase_orders ?received_lte=2017-04-05T10:00:00 Get all purchase orders received on or before a given time
  • When filtering purchase orders by created_gte, created_lte, placed_lte, placed_gte, received_lte or received_gte the date must be in ISO 8601 format.
  • Any combination of created_gte, created_lte, placed_lte, placed_gte, received_lte and received_gte are accepted.

Get a purchase order

GET /v1/companies/123/sites/456/purchase_orders/78 Get a purchase order by ID

Webhooks

Here is a list of the supported webhook topics.

purchase_orders/received

When a purchase order is marked as received. You will receive the complete purchase order.