Fieldmotion API Getting started

Purchase orders

Change the displayed order number

POST /a/PurchaseOrder_setNum

Replace po_num while preserving the internal Purchase Order ID.

When to use this endpoint

Use for the editable number in legacy Purchase Order lists/details. Existing links continue to use the internal id.

Authentication and permissions

Authenticate with signed API-key fields or a logged-in CRM session. Session requests use dispatcher CSRF protection when configured.

Requires explicit View on Purchase Order or Purchase Orders. Writes also require the matching Edit permission; clearing invoice details requires Delete. A non-administrator blocked by the legacy Purchase Orders visibility flag (crm_access bit 256) is denied. API keys use their owner’s permissions.

The primary order is checked against the current tenant and Purchase Order record scope. Configured TeamAccess follows permitted linked Contracts, Customers, Jobs, Quotes and Departments; the legacy department filter follows direct Customer/Quote/customer-Job links. An inaccessible or missing order returns purchase order does not exist.

Parameters

ParameterTypeRequiredDescription
idInteger-compatibleYesPositive local Purchase Order ID/digit string; not the displayed po_num. Missing, malformed or inaccessible IDs fail.
valInteger-compatibleYesPositive integer or digit string; fractional/nonnumeric values are rejected. No uniqueness policy is imposed.

Example request

$result = FM_api('PurchaseOrder_setNum', [
	'id'=>'1042',
	'val'=>'318',
]);

Example response

{
  "ok": 1
}

Errors and unusual responses

ResponseCondition
{"error":"not logged in"}No authenticated tenant context is available. Invalid signed credentials can be rejected by the dispatcher before the handler runs.
{"error": "missing or invalid parameter: id"}id integer-converts below 1.
{"error": "missing or invalid parameter: val"}val absent/null or integer-converts below 1.
{"error": "purchase order does not exist"}No matching row.
{"error": "permission denied"}The required page/action or legacy visibility setting denies access.

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

Behaviour and edge cases

  • Requires a positive integer ID and number. Fractional, malformed and nonnumeric values are rejected rather than truncated.
  • No uniqueness/number-reservation policy is imposed. The internal order ID and linked receipt IDs stay unchanged. Identical numbers are idempotent no-ops.

Side effects

  • Header writes lock the existing order and tenant owner, check persistence and record history in the same transaction. Errors roll back the header and audit; a true no-op returns {ok:1,warning:"no change needed"} without a new event/history entry. Cache invalidation and edit-event follow-ups run after the owning transaction commits; an event exception returns saved=1 and a no-replay warning.
  • A changed header emits PurchaseOrder_edit after commit; configured account listeners may perform integration work. No order email/PDF is sent directly by this route.

See it in Fieldmotion

CRM1

In CRM1 Purchase Orders, click the number cell and edit it; the detail page also edits this value through PurchaseOrder_setNum.

CRM2

No direct caller was found in CRM2 source. Its Purchase Order screen uses mapped reads and generic field saves rather than this legacy endpoint.

Related endpoints