Purchase orders
List active Purchase Order IDs
/a/PurchaseOrders_list
Discover active tenant header IDs for follow-up detail requests.
When to use this endpoint
Use only when an unpaged ID discovery list is intended, then call a detail route for known IDs. It is not the office table endpoint or the mobile order list.
Authentication and permissions
Authenticate with signed API-key fields or a logged-in CRM session. Session requests use dispatcher CSRF protection when configured. API keys use their owner’s identity.
Purchase Order View is required on the singular or plural page. Records must be active and inside the configured TeamAccess or legacy Department Based Filter boundary; administrators are exempt from record restrictions. API-key requests use their owner’s identity. Related display names require the corresponding page View and record visibility.
Parameters
This endpoint has no operation-specific parameters.
Example request
$result = FM_api('PurchaseOrders_list');Example response
[
{
"id": "1042"
}
]Errors and unusual responses
| Response | Condition |
|---|---|
{"error":"not logged in"} | No authenticated tenant context is available. Invalid signed credentials can be rejected by the dispatcher before the handler runs. |
{"error":"permission denied"} | The required page permission is missing. Hidden/deleted records are omitted from collections; explicit parent readers reject an inaccessible parent. |
Legacy application errors may be returned with HTTP 200. Check the decoded response for error, not only the HTTP status.
Behaviour and edge cases
- Returns id objects for active visible headers, including Cancelled orders. Received status and supplier do not limit this discovery call.
- No ordering, pagination, counts, checkpoint or maximum result size. Parameters such as start, length, fields and supplier ID are not consumed.
Side effects
- Reads tenant data without modifying orders, lines, stock, approval, history or notifications.
See it in Fieldmotion
CRM1
No direct CRM1 literal caller was found in the searched client source.
CRM2
No direct CRM2 literal caller was found in the searched client source. The mobile app uses the separate m/www PurchaseOrders_list/OrdersM contract: owned Open/Part Received orders, page/page_size/search/status controls and mobile permissions. The same function name does not imply this office response or pagination.
Related endpoints
PurchaseOrders_getDataTable— Select mapped active header rows.PurchaseOrders_exportData— Read selected configurable header export rows.PurchaseOrder_get— Read one checked raw header.