Retrieves Purchase Order records matching the provided query filters.
At least one filter must be supplied. All filters are combined with AND
and use exact equality matching.
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| id | string | Internal Purchase Order ID. |
| ref | string | External reference number. |
| supplierId | string | Vendor ID. |
| amount | number | Total amount of the PO. |
| isClosed | integer | 0 = open, 1 = closed. |
Response Fields
The response uses the same Purchase Order data model documented under
the Import tag. See PurchaseOrder and PurchaseOrderLineItem
schemas below for the field definitions.
Enter your API token.
Internal Purchase Order ID.
External reference number.
Vendor ID.
Total amount of the PO.
0 = open, 1 = closed.
Records retrieved
Open Purchase Orders
{
"status": "OK",
"msg": "2 records retrieved.",
"result": [
{
"id": "PO-001",
"ref": "PO-2024-001",
"supplierId": "SUP-123",
"created": "2025-01-15T10:00:00Z",
"modified": "2025-01-15T10:00:00Z",
"date": "2024-01-15",
"dueDate": "2024-02-15",
"amount": 1500.0,
"description": "Office supplies order",
"notes": "Deliver before noon",
"isClosed": 0,
"lineItems": [
{
"id": "LINE-001",
"itemId": "ITEM-001",
"accountId": "EXP-100",
"classId": "CLASS-100",
"description": "Paper",
"qty": 100,
"price": 10.0,
"total": 1000.0
},
{
"id": "LINE-002",
"itemId": "ITEM-002",
"accountId": "EXP-100",
"classId": "CLASS-100",
"description": "Pens",
"qty": 50,
"price": 10.0,
"total": 500.0
}
]
},
{
"id": "PO-002",
"ref": "PO-2024-002",
"supplierId": "SUP-456",
"created": "2025-02-01T09:00:00Z",
"modified": "2025-02-01T09:00:00Z",
"date": "2024-02-01",
"dueDate": "2024-03-01",
"amount": 750.0,
"description": "Restock toner",
"notes": null,
"isClosed": 0,
"lineItems": [
{
"id": "LINE-003",
"itemId": "ITEM-003",
"accountId": "EXP-100",
"classId": "CLASS-100",
"description": "Toner cartridges",
"qty": 10,
"price": 75.0,
"total": 750.0
}
]
}
]
}Result message (e.g., "N records retrieved.").
Purchase Order record. Shares the same data model used by the Import endpoint.
Internal Purchase Order ID.
External reference number.
Vendor ID.
AP account reference ID.
Accounting class reference ID.
Issue date (YYYY-MM-DD).
Payment due date (YYYY-MM-DD).
Date received (YYYY-MM-DD). Populated for Item Receipts.
PO memo or description.
Notes to the vendor.
0 = open, 1 = closed.
0 = no, 1 = yes.
Total amount of the PO.
Timestamp record was created (YYYY-MM-DD HH:mm:ss).
Timestamp record was last modified (YYYY-MM-DD HH:mm:ss).
Line items on the PO.
Line item identifier.
Reference to item master record.
GL account reference ID.
Customer reference for billable items.
Accounting class reference ID.
Item description.
Quantity.
Unit price.
Line total.
Quantity received. Populated for Item Receipts.
Received line total. Populated for Item Receipts.
Bad Request (no recognized query parameter, or invalid type)
No Recognized Query Parameters
{
"status": "Error",
"msg": "Invalid query parameters.",
"result": null
}Invalid Parameter Type
{
"status": "Error",
"msg": "Value 'foo' does not match type 'int' at path 'isClosed'.",
"result": null
}Unauthorized
No Purchase Orders matched the supplied filters.
No Records
{
"status": "Error",
"msg": "No record matching your query.",
"result": null
}