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
code	string	Stable identifier. For library-shipped items this is the library code; for tenant-imported items this is the tenant entity's own code.
Stable identifier. For library-shipped items this is the library code; for tenant-imported items this is the tenant entity's own code.
name	string	Display name shown to users in lists, dialogs, and the import browser.
Display name shown to users in lists, dialogs, and the import browser.
description	string	Optional human-readable summary of what this entity is for.
Optional human-readable summary of what this entity is for.
libraryCode	string	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".
libraryStatus	enum	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
isImported	boolean	True if the tenant has already imported this library item.
True if the tenant has already imported this library item.
deprecated	boolean	True if this library item has been retired. Deprecated items are hidden from the import browser (so new tasks cannot be created from them) but remain available for revert-to-library on existing imports.
True if this library item has been retired. Deprecated items are hidden from the import browser (so new tasks cannot be created from them) but remain available for revert-to-library on existing imports.
type	enum	EngagementLetter Proposal AdHoc
EngagementLetter Proposal AdHoc
bodyHtml	string	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
outputNameTemplate	string	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.
isActive	boolean	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)
defaultDesignTheme	CodeAndNameDto
createdDate	string	When this template was created
When this template was created
updatedDate	string	When this template was last updated
When this template was last updated

JSON Example

{
  "code": "string",
  "name": "string",
  "description": "string",
  "libraryCode": "string",
  "libraryStatus": "NotFromLibrary"
}

Used By Operations

Contained in Schemas

DocumentTemplateDtoPagedResult