List purchase orders

Operation ID: purchaseOrders

Group: Accounting › Purchase Orders

Open in the interactive reference

GET /accounting/purchase-orders

Read-only: Reads and returns; changes nothing.

Lists purchase orders. Each item is the order's main fields, without its lines. To get the lines, use GET accounting/purchase-orders/:id or POST accounting/purchase-orders/search.

To filter by vendor or legal entity, use POST accounting/purchase-orders/search.

Parameters

Query surface

• id — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
• poNumber — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
• externalPONumber — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
• approvalStatus — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
• budgetStatus — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
• status — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
• currency — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
• startDate — filter by eq, ne, gt, gte, lt, lte, in, notIn, between
• endDate — filter by eq, ne, gt, gte, lt, lte, in, notIn, between
• needByDate — filter by eq, ne, gt, gte, lt, lte, in, notIn, between
• paymentTerms — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
• lastModifiedDate — filter by eq, ne, gt, gte, lt, lte, in, notIn, between
• Orderable: id, poNumber, approvalStatus, budgetStatus, status, currency, totalAmount, invoicedTotalAmount, receivedTotalAmount, startDate, endDate, needByDate, lastModifiedDate
• Selectable: id, poNumber, description, internalDescription, externalMemo, externalPONumber, approvalStatus, budgetStatus, status, currency, totalAmount, invoicedTotalAmount, receivedTotalAmount, startDate, endDate, needByDate, paymentTerms, vendorName, vendorContactEmail, entityName, lastModifiedDate
• page[size] — Page size
• page[cursor] — Opaque continuation cursor

Response

200 Success

Under data, an array of purchaseOrdersRow:

{
  "data": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "poNumber": "<poNumber>",
      "description": "<description>",
      "internalDescription": "<internalDescription>",
      "externalMemo": "<externalMemo>",
      "externalPONumber": "<externalPONumber>",
      "approvalStatus": "<approvalStatus>",
      "budgetStatus": "<budgetStatus>",
      "status": "<status>",
      "currency": "<currency>",
      "totalAmount": "19.99",
      "invoicedTotalAmount": "19.99",
      "receivedTotalAmount": "19.99",
      "startDate": "2026-01-15",
      "endDate": "2026-01-15",
      "needByDate": "2026-01-15",
      "paymentTerms": "<paymentTerms>",
      "vendorName": "<vendorName>",
      "vendorContactEmail": "<vendorContactEmail>",
      "entityName": "<entityName>",
      "lastModifiedDate": "2026-01-15T09:30:00.000Z"
    }
  ],
  "pagination": {
    "hasMore": true,
    "nextCursor": "<nextCursor>"
  }
}

Statuses

• 400 — Invalid request or business failure
• 401 — The request carries no valid access token.
• 403 — Not authorized
• 404 — Not found
• 429 — Too many requests from this client address. The response has no body and no Retry-After header.
• 500 — Internal server error