API Docs / Schemas / TemplateVariables

TemplateVariables

Root object containing all variables available for document template rendering.
This class serves as the data model for Liquid/Fluid template rendering,
providing access to client, practice, proposal, and document-level data.

Properties

Name Type Description
titlestring

Document-level title (e.g., "Engagement Letter", "Annual Proposal").
Used in cover pages and headers.

Document-level title (e.g., "Engagement Letter", "Annual Proposal").
Used in cover pages and headers.

subtitlestring

Document-level subtitle providing additional context.
Typically appears below the main title.

Document-level subtitle providing additional context.
Typically appears below the main title.

secondarySubtitlestring

Optional secondary subtitle for additional document identification.

Optional secondary subtitle for additional document identification.

postalAddressstring
addresseestring
datestring

Formatted date string (e.g., "27th June 2025").
Used for displaying the current date in documents and emails.

Formatted date string (e.g., "27th June 2025").
Used for displaying the current date in documents and emails.

logostring

URL or base64-encoded image data for the practice logo.
Can be used with filters like: {{ Logo | width: 200 }}

URL or base64-encoded image data for the practice logo.
Can be used with filters like: {{ Logo | width: 200 }}

clientClientDto
primaryContactContactDto
partnerTenantUserDto
managerTenantUserDto
practicePracticeDetailsDto
proposalProposalDto
htmlBlocksobject

Dictionary of custom HTML blocks that can be injected into templates.
This is used for dynamic content that is provided by the client at render time,
such as rendered cost tables, custom sections, or other HTML fragments.
Usage in templates: {{ HtmlBlocks.ProposalCosts }}, {{ HtmlBlocks.CustomSection }}

Dictionary of custom HTML blocks that can be injected into templates.
This is used for dynamic content that is provided by the client at render time,
such as rendered cost tables, custom sections, or other HTML fragments.
Usage in templates: {{ HtmlBlocks.ProposalCosts }}, {{ HtmlBlocks.CustomSection }}

schedulesContentBlockCollection
urlstring

Generic URL for use in templates (e.g., authorization links, callback URLs, external resources).
Usage in templates: {{ Url }}

Generic URL for use in templates (e.g., authorization links, callback URLs, external resources).
Usage in templates: {{ Url }}

contactContactDto

JSON Example

{
  "title": "string",
  "subtitle": "string",
  "secondarySubtitle": "string",
  "postalAddress": "string",
  "addressee": "string"
}

Contained in Schemas