Query the mapped Purchase Order table

When to use this endpoint

Use the CRM2 Purchase Orders table and its export ID-selection stage. This is a mapped camelCase contract, distinct from the positional getDT response.

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

Example request

$result = FM_api('PurchaseOrders_getDataTable', [
	'fields'=>['id','poNum','reference','targetType','targetID','orderNet','orderTax'],
	'start'=>'0','length'=>'10','draw'=>'1',
	'orderBy'=>'poNum','orderDesc'=>'asc',
	'sendEmail'=>['1'],
]);

Example response

{
  "data": [
    {
      "id": "1042",
      "poNum": "318",
      "reference": "PO-318",
      "targetType": "0",
      "targetID": "0",
      "orderNet": 25,
      "orderTax": 5,
      "customerID": "",
      "customerName": "",
      "returnedStatus": 0,
      "returnedData": []
    }
  ],
  "draw": 1,
  "recordsTotal": "12",
  "recordsFiltered": "1"
}

Errors and unusual responses

Legacy application errors may be returned with HTTP 200. Check the decoded response for error, not only the HTTP status.

Behaviour and edge cases

• 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. The legacy Department Based Filter follows direct Customer links, Quote customers and ordinary customer-Job links; restricted users cannot discover unlinked or other unsupported targets. Configured TeamAccess uses the same boundary as the singular header readers.
• Header fields use PurchaseOrder’s map: poNum/reference/status, supplier/target pickers and IDs, delivery/contact/date fields, approval/sent timestamps, customValues, invoiceReceived and meta paths. id is always returned. orderNet/orderTax are converted to line-only numeric totals by subtracting carriage from raw persisted amounts.
• When targetType is projected, adds customerID/customerName and returnedStatus/returnedData. Customer data follows direct Customer, Quote or ordinary customer-Job links. Return data groups active Goods Returned headers linked through Goods Received; it is a presence flag, not a net returned quantity.
• Project targetType and targetID for customer enrichment. Returned-status selection is a SQL predicate and works even when these fields are not projected.
• recordsTotal counts active visible headers before search filters. recordsFiltered counts all matching SQL rows before paging, including the returned-order predicate. Returned filtering cannot turn an earlier page into an artificially empty page.
• Related customer/Quote/Job and receipt display lookups apply their corresponding View and record boundary. hasFiles only considers nondeleted files.
• Native field, grouping, sort and structured advanced-search controls are checked; raw where expressions and malformed values are rejected before SQL. Pagination values are nonnegative integers; no maximum size is imposed.

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. CRM1 uses PurchaseOrders_getDT.

CRM2

In CRM2 Purchase Orders, load/search/filter the table and inspect PurchaseOrders_getDataTable. The page is hidden without employer feature bit 262144; this handler does not enforce that feature flag. Export first calls it with fields=[id], isTable=0,limit=0 to obtain the complete filtered header-ID list.

Related endpoints

• PurchaseOrders_exportData — Read selected configurable header export rows.
• PurchaseOrder_get — Read one checked raw header.