Fieldmotion API Getting started

Quotes: queries, documents and delivery

Read the legacy quote Word template

POST /a/Quotes_templateWordGet

Read the account’s saved Word/HTML template setting.

When to use this endpoint

Use only for the legacy account template editor/settings flow. It does not generate a document or return a URL.

Authentication and permissions

Authenticate with signed API-key fields or a CRM session. Requires Quotes View (pageQuotes_view); non-admin users blocked by legacy crm_access bit 32 are denied. Client administrators inherit page permissions.

Quote visibility follows the account’s department/account-manager customer filters for non-admin users, including signed keys. Export routes additionally require pageMain_exportTableData. Linked Jobs require Jobs View and their TeamAccess scope; invoice enrichment requires Invoices View and the legacy invoice access check.

Parameters

This endpoint has no operation-specific parameters.

Example request

$template = FM_api('Quotes_templateWordGet');

Example response

""

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":"permission denied"}Required Quotes/Export permission is absent or legacy access restrictions apply.

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 setting quote-template-word as a bare value, with no ok wrapper. settingGet trims database/default text and can decode JSON-looking object/array content; an unset value can be an empty string.
  • No ID, field selector, pagination, version or per-quote template resolution. The inspected current Quote report service renders quote Form fields/autodocs_doc and does not consume this legacy setting.
  • No direct caller for this endpoint was found in the mobile app or its m-service intermediary.

Side effects

  • Read-only for business records: no implicit quote cost save, history, mail or Job-count cache repair. PDF generation/settings getters may populate their existing document/settings cache.

See it in Fieldmotion

CRM1

Quote Word settings loads Quotes_templateWordGet into CKEditor in pageQuoteSettingsWord; filter Network when opening that editor.

CRM2

No direct caller found in CRM2. Quote layout/PDF actions use Forms and Quote_getPdf.

Related endpoints