Fieldmotion API Getting started

Goods Received

Read the printable receipt header

POST /a/GoodsReceivedNote_get

Fetch supplier address and PO reference fields for the legacy receipt-note view.

When to use this endpoint

Fetch supplier address and PO reference fields for the legacy receipt-note view.

Authentication and permissions

Authenticate with signed API-key fields or a logged-in CRM session. Session CSRF, account-active and IP restrictions still apply. These handlers add no receipt-specific page, finance, department or record-owner permission check.

Records are scoped to the authenticated tenant. CRM1 displays Goods Received with employer feature bit 262144; CRM2 checks features2.goodsReceivedNotes. Those screen gates are not enforced by these handlers. Mobile receipt routes run separately through the mobile intermediary and have different permission and ownership checks.

Parameters

ParameterTypeRequiredDescription
idIntegerYesPresence required, then intval-coerced; zero/negative values simply query that ID.

Example request

FM_api('GoodsReceivedNote_get', ['id'=>'531']);

Example response

{"name":"Parts supplier","street_address1":null,"street_address2":null,"town":null,"county":null,"postcode":null,"tax_id":"","reference":null,"po_id":"482","date_approved":null,"grn_date":"2026-10-09 00:00:00","grn_notes":"Checked"}

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":"no grn id supplied"}id omitted.

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 one joined object, not an array. Unknown receipt / read failure returns false. The receipt is left-joined to its current supplier and PO; missing linked records produce null fields.
  • The full response selects name, street_address1, street_address2, town, county, postcode, tax_id, reference, po_id, date_approved, grn_date and grn_notes. It does not return header id, supplier invoice/delivery references, supplier ID, job ID or lines.
  • No active/deleted, approval, ownership or department filter. No pagination or operation-specific writes.

See it in Fieldmotion

CRM1

Open a receipt note from Goods Received; pageGoodsReceivedNote loads this header and GoodsReceivedEntries_get, then offers the browser print view.

CRM2

CRM2 receipt detail uses layoutGoodsReceivedMain / GoodReceived_getLayoutDetails, not this printable-header API.

Related endpoints