Sign in
Purchase Orders

List purchase orders

Returns purchase orders you can access. Deleted orders are excluded by default.

get/purchase-orders

Request

  • Base URL: https://next-api.saturation.io/v1
  • URL: https://next-api.saturation.io/v1/purchase-orders
  • Auth: HTTP bearer

Query parameters

projectIdstring

Project ID or slug. Use none for unassigned purchase orders.

limitinteger

Maximum number of items to return on a page. Capped at 100.

cursorstring

Cursor from the previous page's nextCursor. Use it with the same filters and sort.

sort'number' | 'name' | 'dueDate' | 'serviceStartAt' | 'serviceEndAt' | 'status' | 'sort' | 'createdAt' | 'updatedAt'

Fields available for sorting purchase orders.

Field to sort the purchase-order list by. A non-unique field appends ,id as the tiebreaker.

order'asc' | 'desc'

Sort direction.

expandPurchaseOrderExpand[]

Comma list of related data to inline on a purchase order (depth ≤ 2). Unknown key returns 400 expand_invalid.

withCountboolean

Include the total number of matching items. Defaults to false.

status'draft' | 'pending' | 'approved' | 'rejected' | 'actualizing' | 'paid' | 'void'

Current purchase order status.

Example:pending

Purchase order status.

contactIdstring

Vendor contact ID.

budgetLineIdstring

Budget line ID.

numberstring

Purchase order number. Matching is exact.

qstring

Search purchase order names.

includeDeletedboolean

Include deleted purchase orders. Defaults to false.

Response

A page of purchase orders.

nextCursorstring nullable

Cursor for the next page. Pass it as cursor with the same filters and sort. Null on the last page.

countinteger

Total number of matches. Included when withCount=true.

truncatedboolean

Whether the page contains fewer results than requested.

Example response

{
  "data": [
    {
      "id": "po_8f2a1c9e",
      "workspaceId": "ws_3b1",
      "projectId": "prj_demo",
      "number": "PO-0042",
      "name": "Camera package rental",
      "status": "pending",
      "contactId": "con_77a",
      "budgetLineId": "bud_5510",
      "dueDate": "2026-05-20",
      "serviceStartAt": "2026-05-21",
      "serviceEndAt": "2026-05-24",
      "notes": "Net-30",
      "sort": 1000,
      "createdById": "usr_aa1",
      "amount": {
        "amount": 152900,
        "currency": "USD"
      },
      "createdAt": "2026-05-18T14:02:11.000Z",
      "updatedAt": "2026-05-20T09:31:00.000Z"
    }
  ],
  "nextCursor": "eyJpZCI6InR4bl84ZjJhMWM5ZSJ9"
}

Changes

No operation changes recorded.