Retrieve a paginated list of purchase_orders. Use filters to narrow results.
Filtering
Use the filter[<attribute>] parameter to filter results. Multiple filters are combined with AND logic.
Basic Examples
# Equality (implicit)GET /api/v4/purchase_orders?filter[external_provider]=active# Multiple values (implicit IN)GET /api/v4/purchase_orders?filter[external_provider]=draft,pending# With explicit operatorGET /api/v4/purchase_orders?filter[created_at][gte]=2024-01-01# Range queryGET /api/v4/purchase_orders?filter[client_org_id][between]=10,100# Multiple filters (AND)GET /api/v4/purchase_orders?filter[external_provider]=active&filter[client_org_id][gte]=10
Available Attributes
Attribute
Type
Operators
Permitted Values
ccy
string
eq, not_eq, in, not_in, like, not_like
-
client_org_id
integer
eq, not_eq, in, not_in, gt, gte, lt, lte, between
-
created_at
datetime
eq, not_eq, gt, gte, lt, lte, between
-
deleted_at
datetime
eq, not_eq, gt, gte, lt, lte, between
-
expiry_date
date
eq, not_eq, gt, gte, lt, lte, between
-
external_id
string
eq, not_eq, in, not_in, like, not_like
-
external_provider
string
eq, not_eq, in, not_in, like, not_like
-
id
integer
eq, not_eq, in, not_in, gt, gte, lt, lte, between
-
po_number
string
eq, not_eq, in, not_in, like, not_like
-
status
integer
eq, not_eq, in, not_in, gt, gte, lt, lte, between
-
updated_at
datetime
eq, not_eq, gt, gte, lt, lte, between
-
updating
boolean
eq, not_eq
-
version
integer
eq, not_eq, in, not_in, gt, gte, lt, lte, between
-
OR Conditions
Use or[group] to combine filter groups with OR logic. Filters within a group are ANDed:
# Simple ORGET /api/v4/purchase_orders?or[1][external_provider]=pending&or[2][external_provider]=active# Complex OR (external_provider=pending AND client_org_id>=10) OR (external_provider=active)GET /api/v4/purchase_orders?or[1][external_provider]=pending&or[1][client_org_id][gte]=10&or[2][external_provider]=active
Sorting
Use sort[<attribute>] to order results. Default direction is ascending.
# Ascending (implicit)GET /api/v4/purchase_orders?sort[created_at]=# DescendingGET /api/v4/purchase_orders?sort[created_at]=desc# Combined with filtersGET /api/v4/purchase_orders?filter[external_provider]=active&sort[created_at]=desc