Get Purchase Orders

get

https://api.apicbase.com/api/v2/procurement/purchase_orders/

Returns a list of all purchase orders in the library.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

page

int32

A page number within the paginated result set.

ordering

string

A field to order results by.

supplier

string

Filter on a supplier ID.

outlet

string

Filter on an outlet ID.

order_number

string

Filter on an order number. Only queries exact matches.

order_number__contains

string

Filter on an order number. Queries partial matches on this field.

owned_by

string

A user ID.

status

string

enum

Filter on a status.

Allowed:

status__in

array of strings

Filter on multiple status.

status__in

delivery_closed

boolean

Filter on orders that are or are not accepting more deliveries. When true, no more deliveries are expected.

ordered_on

date

Filter on the order's ordered on date.

ordered_on__gt

date

Filter on the order's ordered on date (greater than).

ordered_on__lt

date

Filter on the order's ordered on date (lower than).

expected_delivery_date

date

Filter on the order's expected delivery date.

expected_delivery_date__gt

date

Filter on the order's expected delivery date (greater than).

expected_delivery_date__lt

date

Filter on the order's expected delivery date (lower than).

discount

float

Filter on a discount amount (exact).

discount__gt

float

Filter on a discount amount (greater than).

discount__lt

float

Filter on a discount amount (lower than).

invoice_number

string

Filter on an invoice number

invoice_status

string

enum

Filter on an invoice status.

Allowed:

viewed_by_supplier

boolean

Filter on orders that have/have not been viewed by the supplier.

viewed_by_supplier_at

date

Filter on the order's viewed by supplier date.

viewed_by_supplier_at__gt

date

Filter on the order's viewed by supplier date (greater than).

viewed_by_supplier_at__lt

date

Filter on the order's viewed by supplier date (lower than).

fetched_by_supplier

boolean

Filter on orders that have/have not been fetched by the supplier.

fetched_by_supplier_at

date

Filter on the order's fetched by supplier date.

fetched_by_supplier_at__gt

date

Filter on the order's fetched by supplier date (greater than).

fetched_by_supplier_at__lt

date

Filter on the order's fetched by supplier date (lower than).

Response

200200