Fieldmotion API Getting started

Invoices

Retrieve invoice notes

POST /a/Invoice_getNotes

Return only the notes stored on one active invoice.

When to use this endpoint

Use this lightweight read when a caller does not need the full invoice record.

Authentication and permissions

The request must use a logged-in CRM session or valid signed API credentials and is scoped to that tenant.

Users whose legacy crm_access mask contains bit 64 receive {"error":"no permission to access api"}. No record-owner check is made.

Parameters

ParameterTypeRequiredDescription
idPositive integerYesActive invoice ID.

Example request

$notes = FM_api('Invoice_getNotes', ['id' => 981]);

Example response

{
  "notes": "Payment due within 30 days"
}

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 such invoice"}The invoice is absent or deleted.

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

Behaviour and edge cases

  • The stored notes value is returned without formatting or JSON decoding.

See it in Fieldmotion

CRM1

No direct production CRM1 caller was found for this route.

CRM2

No direct production CRM2 caller was found for this route.

Related endpoints