Fieldmotion API Getting started

Invoices

Get the PDF invoice template

POST /a/Invoices_templatePdfGet

Return the tenant’s stored PDF invoice-template setting.

When to use this endpoint

Use this to load the legacy PDF invoice layout configuration.

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

This endpoint has no operation-specific parameters.

Example request

$template = FM_api('Invoices_templatePdfGet', []);

Example response

"{...stored template value...}"

The endpoint returns the raw invoice-template setting value. Its JSON type and shape depend on what was stored; it is not wrapped in an object.

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.

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

Behaviour and edge cases

  • No default, parsing, or shape validation is applied by this handler.
  • This endpoint only reads the PDF-template setting; it does not render a PDF.

See it in Fieldmotion

CRM1

No current direct CRM1 caller was found in the client source.

CRM2

No current direct CRM2 caller was found.

Related endpoints