Fieldmotion API Getting started

Invoices

Get the Word invoice template

POST /a/Invoices_templateWordGet

Return the tenant’s stored Word/HTML invoice template.

When to use this endpoint

Use this to populate the invoice template editor.

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_templateWordGet', []);

Example response

"<html>...template...</html>"

The raw invoice-template-word setting is returned without a wrapper.

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 sanitization is performed while reading; sanitization occurs in the setter.
  • The endpoint does not require tenant-admin status, only authentication.

See it in Fieldmotion

CRM1

The invoice Word-template settings page loads its editor from this route.

CRM2

No direct CRM2 caller was found.

Related endpoints