Fieldmotion API Getting started

Invoices

Query invoice recurrence details

POST /a/InvoiceRecurring_getRequestedDetails

Retrieve selected mapped fields for one or more invoice recurrences.

When to use this endpoint

Use this for CRM2-style targeted reads instead of returning raw rows. Available mapped fields are id, name, numInvoices, cDate, eDate, active, every, onArr, customerID, customer, customerType, nDate, notes, lastEdited, meta, metaJobRecurrenceID, and metaCopyItems.

Authentication and permissions

The request must authenticate with signed API-key fields or a logged-in CRM session and is scoped to the authenticated tenant.

The handler performs no additional invoice page, record-owner, or department permission check unless stated below.

Parameters

ParameterTypeRequiredDescription
idInteger, array, or JSON arrayYesOne or more recurrence IDs, as accepted by the shared data processor.
fieldsArray or JSON arrayYesMapped field names to return. Unknown or unmapped names are rejected.

Example request

$rows = FM_api('InvoiceRecurring_getRequestedDetails', [
	'id' => ['42'],
	'fields' => ['id', 'name', 'every'],
]);

Example response

[
  {"id": 42, "name": "Monthly service invoice", "every": 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"}The shared mapped-reader validation rejects the ID input.
{"error":"missing or invalid parameter: fields"}No valid requested field list is supplied.

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

Behaviour and edge cases

  • Response keys use mapped camel-case names rather than raw column names.
  • The shared data processor controls type conversion and accepts multiple IDs; this endpoint adds no ordering or pagination.

See it in Fieldmotion

CRM1

No direct CRM1 caller was found.

CRM2

The generic mapped-data components can call this route for recurrence details.

Related endpoints