API Docs / Schemas / RenderDocumentTemplateRequest

RenderDocumentTemplateRequest

Request to render a document template with dynamic data.
The template will be processed with the provided data to generate final HTML output.

Properties

Name Type Description
designThemeCodestring

Optional design theme code to override the template's default theme.
Priority: Request theme > Template default > Tenant default

Optional design theme code to override the template's default theme.
Priority: Request theme > Template default > Tenant default

dataTemplateVariables
clientCodestring

Code of the client whose services the pricing table is built from.
Required when ServiceCodes is supplied.

Code of the client whose services the pricing table is built from.
Required when ServiceCodes is supplied.

serviceCodesarray of string

Codes of the client billable services to include in the proposal costs table.
When supplied, the server computes the Costs template data from these live services
(prices, VAT, setup fees) so the 'proposal_costs' content block can render the table.

Codes of the client billable services to include in the proposal costs table.
When supplied, the server computes the Costs template data from these live services
(prices, VAT, setup fees) so the 'proposal_costs' content block can render the table.

JSON Example

{
  "designThemeCode": "string",
  "data": {
    "title": "string",
    "subtitle": "string",
    "secondarySubtitle": "string",
    "postalAddress": "string",
    "addressee": "string"
  },
  "clientCode": "string",
  "serviceCodes": [
    "string"
  ]
}

Used By Operations