Declarations

List Available Templates

Changed on

List available declaration templates for the user's company.

Returns system defaults + company-specific overrides. Each row carries prints_internal_notes (0/1), and when subject_id is given on module 11 the response also carries subject_internal_notes — the vehicle's private note, so the UI can quote exactly what a customer would read off the printed sheet.

The note rides on this response rather than a dedicated endpoint because the picker already blocks on this call: one round trip, and no window in which a template can be selected before its warning text exists.

get/api/declarations/templates

Request

  • Base URL
    https://api.multigest.pt (the document declares no server; this is the origin it was published from)
  • URL
    https://api.multigest.pt/api/declarations/templates
  • Auth
    API key in header x-api-token and API key in header x-origin-verify

Query parameters

id_modulointeger nullable

Filter by module (11=Viaturas, 5=Contratos, 12=Clientes)

trigger_actionstring nullable

Filter by trigger action (on_purchase, on_sale, etc.)

subject_idinteger nullable

Subject record id. Supplies the vehicle's internal note so the picker can warn before printing it — id_modulo 11 only.

Headers

x-api-tokenstring nullable

Response

Successful Response

unknown required

Changes