Change the required delivery date

When to use this endpoint

Use for the legacy Delivery Date field. It records an expectation, not the actual Goods Received date.

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

Parameter	Type	Required	Description
`id`	Integer-compatible	Yes	Positive local Purchase Order ID/digit string; not the displayed po_num. Missing, malformed or inaccessible IDs fail.
`delivery_date`	String	Yes	Required real calendar date in exact YYYY-MM-DD format. Blank and invalid dates are rejected.

Example request

$result = FM_api('PurchaseOrder_setDeliveryDate', [
	'id'=>'1042',
	'delivery_date'=>'2026-11-20',
]);

Example response

{
  "ok": 1
}

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": "missing or invalid parameter: id"}`	id integer-converts below 1.
`{"error": "missing or invalid parameter: delivery_date"}`	No matching date-shaped substring, including missing/blank.
`{"error": "permission denied"}`	The required page/action or legacy visibility setting denies access.
`{"error": "purchase order does not exist"}`	The primary order is missing or outside the caller’s permitted scope.

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 complete, real calendar date in YYYY-MM-DD format. Surrounding text, malformed values, invalid dates and blank clearing are rejected before SQL.
Stores an expected delivery date without timezone conversion, reminders, delivery scheduling or received-state changes.

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.

See it in Fieldmotion

CRM1

In CRM1 Purchase Order details, change Delivery Date and filter for PurchaseOrder_setDeliveryDate.

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

PurchaseOrder_get — Read the current raw header.
PurchaseOrder_setDeliveryDetails — Save attention, address and instructions.