List purchase order rows
Procurement module
GET/purchase-orderspurchaseOrders.list
A purchase order. Its creator cannot approve it; spend authority applies inside the approval RPC. Returns a cursor page of purchase order rows the caller may see. The default order is `created_at` ascending. Supports sparse fieldsets and the filter grammar.
- Requires the capability procurement.po.read.
- OAuth scopes: procurement.
- Cursor-paginated: limit, cursor, fields, sort and filter apply.
- Error statuses: 400, 401, 429. Errors are RFC 9457 problem details.
Path and query parameters
| Field | Type | Required | Description |
|---|---|---|---|
| limit | Limit | No | Page size. Default 50, maximum 200.Constraints: range 1 to 200 |
| cursor | Cursor | No | Opaque cursor from `next_cursor` of the previous page.Constraints: length 1 to any |
| fields | Fields | No | Sparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Constraints: pattern ^[a-z_][a-z0-9_]*(,[a-z_][a-z0-9_]*)*$ |
| sort | Sort | No | Sort keys, comma-separated; a leading `-` sorts descending. Without `sort`, the documented default order applies (coded lists sort in numeric code order).Constraints: pattern ^-?[a-z_][a-z0-9_]*(,-?[a-z_][a-z0-9_]*)*$ |
| filter | Filter | No | Filter grammar `filter[field][op]=value`. Operators: eq, ne, lt, lte, gt, gte, in (comma-separated values), is_null (true or false) and contains. Conditions combine with AND. |
Response 200: a page of PurchaseOrder
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the purchase order. |
| org_id | string (uuid) | Yes | Identifier of the owning organization, derived from the parent row and never accepted from the caller. |
| created_at | string (date-time) | Yes | When the row was created. |
| created_by | string (uuid) | null | Yes | Identifier of the person who created the row; null when a seed, platform or system process created it. |
| updated_at | string (date-time) | Yes | When the row was last updated. |
| updated_by | string (uuid) | null | Yes | Identifier of the person who last updated the row; null when a seed, platform or system process updated it. |
| project_id | string (uuid) | Yes | Identifier of the project. |
| vendor_id | string (uuid) | Yes | Identifier of the vendor. |
| po_number | integer | Yes | Number from the project's display key sequence.Constraints: range 1 to any |
| currency_code | string | Yes | ISO 4217 currency code of every money field.Constraints: pattern ^[A-Z]{3}$ |
| po_state | "Proposed" | "Approved" | "Sent" | "Closed" | "Canceled" | Yes | Purchase order state. |
| rfq_response_id | string (uuid) | null | Yes | Identifier of the awarded RFQ response the order comes from. |
| delivery_due_on | string (date) | null | Yes | Date the order is due to be delivered. |
| payment_terms_days | integer | null | Yes | Days after invoice the order is payable (Net 30 is 30).Constraints: range 0 to any |
| tax_minor | integer (int64) | null | Yes | Tax on the order. Integer minor units of the resource currency; null means unpriced, never zero. |
| shipping_minor | integer (int64) | null | Yes | Shipping charged on the order. Integer minor units of the resource currency; null means unpriced, never zero. |
| sent_at | string (date-time) | null | Yes | When the order moved to Sent (its issue date), from its transition ledger. |
| invoiced_minor | integer (int64) | null | Yes | Subtotal of the invoices matched to the order; null when none is matched or one is unpriced. Integer minor units of the resource currency; null means unpriced, never zero. |
| paid_minor | integer (int64) | null | Yes | Payments applied to the invoices matched to the order; null when none is matched. Integer minor units of the resource currency; null means unpriced, never zero. |
{
"data": [
{
"id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"created_at": "2026-10-08T14:30:00Z",
"created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"updated_at": "2026-10-08T14:30:00Z",
"updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"vendor_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"po_number": 7,
"currency_code": "USD",
"po_state": "Proposed",
"rfq_response_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"delivery_due_on": "2026-10-08",
"payment_terms_days": 30,
"tax_minor": 4200,
"shipping_minor": 15000,
"sent_at": "2026-10-08T14:30:00Z",
"invoiced_minor": 1250000,
"paid_minor": 600000
}
],
"next_cursor": null
}Code samples
curl -X GET "$XOS_BASE_URL/purchase-orders" \
-H "Authorization: Bearer $XOS_API_KEY"for await (const row of xos.purchaseOrders.listAll()) {
console.log(row);
}for row in xos.purchase_orders.list_all():
print(row)xos purchase-orders list --all