API Docs / Schemas / DocumentTemplateDto

DocumentTemplateDto

Reusable document template for generating HTML documents such as proposals, engagement letters, reports, and invoices.
Templates use Liquid/Fluid syntax for dynamic content, variables, loops, and conditionals.
Can reference content blocks and be styled with design themes for consistent branding.

Properties

Name Type Description
libraryCodestring

The Code of the library template this entity was imported from, or null if the entity
is not from the library. Read-only — cannot be changed once set. Example: "vat_returns".

The Code of the library template this entity was imported from, or null if the entity
is not from the library. Read-only — cannot be changed once set. Example: "vat_returns".

libraryStatusenum

Describes a library-imported entity's relationship to its source library template.

NotFromLibrary UpToDate LocallyModified LibraryUpdated

Describes a library-imported entity's relationship to its source library template.

NotFromLibrary UpToDate LocallyModified LibraryUpdated

isImportedboolean

True if the tenant has already imported this library item.

True if the tenant has already imported this library item.

codestring

Unique identifier for the template

Unique identifier for the template

namestring

Display name (e.g., "Standard Engagement Letter", "Year-End Proposal")

Display name (e.g., "Standard Engagement Letter", "Year-End Proposal")

typeenum

EngagementLetter Proposal AdHoc

EngagementLetter Proposal AdHoc

bodyHtmlstring

The template content using Liquid/Fluid syntax with variables ({{ client.Name }}),
loops ({% for %}), conditionals ({% if %}), and content block references

The template content using Liquid/Fluid syntax with variables ({{ client.Name }}),
loops ({% for %}), conditionals ({% if %}), and content block references

descriptionstring

Optional description explaining the template's purpose and usage

Optional description explaining the template's purpose and usage

outputNameTemplatestring

Optional template for naming rendered documents using {{ token }} placeholders.
When null, documents use the template's Name.

Optional template for naming rendered documents using {{ token }} placeholders.
When null, documents use the template's Name.

isActiveboolean

Whether this template is available for use (inactive templates are hidden but preserved)

Whether this template is available for use (inactive templates are hidden but preserved)

defaultDesignThemeCodeAndNameDto
createdDatestring

When this template was created

When this template was created

updatedDatestring

When this template was last updated

When this template was last updated

JSON Example

{
  "libraryCode": "string",
  "libraryStatus": "NotFromLibrary",
  "isImported": false,
  "code": "string",
  "name": "string"
}

Used By Operations

Contained in Schemas