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 |
|---|---|---|
| libraryCode | string | The Code of the library template this entity was imported from, or null if the entity |
The Code of the library template this entity was imported from, or null if the entity | ||
| libraryStatus | enum | Describes a library-imported entity's relationship to its source library template. |
Describes a library-imported entity's relationship to its source library template. | ||
| isImported | boolean | True if the tenant has already imported this library item. |
True if the tenant has already imported this library item. | ||
| code | string | Unique identifier for the template |
Unique identifier for the template | ||
| name | string | Display name (e.g., "Standard Engagement Letter", "Year-End Proposal") |
Display name (e.g., "Standard Engagement Letter", "Year-End Proposal") | ||
| type | enum | EngagementLetter Proposal AdHoc |
EngagementLetter Proposal AdHoc | ||
| bodyHtml | string | The template content using Liquid/Fluid syntax with variables ({{ client.Name }}), |
The template content using Liquid/Fluid syntax with variables ({{ client.Name }}), | ||
| description | string | Optional description explaining the template's purpose and usage |
Optional description explaining the template's purpose and usage | ||
| outputNameTemplate | string | Optional template for naming rendered documents using {{ token }} placeholders. |
Optional template for naming rendered documents using {{ token }} placeholders. | ||
| 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
{
"libraryCode": "string",
"libraryStatus": "NotFromLibrary",
"isImported": false,
"code": "string",
"name": "string"
}
Used By Operations
-
POST
Create DocumentTemplate
/tenants/{tenant}/document-templates
-
GET
Get DocumentTemplate
/tenants/{tenant}/document-templates/{code}
-
PUT
Update DocumentTemplate
/tenants/{tenant}/document-templates/{code}
-
GET
Get Library DocumentTemplate
/tenants/{tenant}/document-templates/library/{code}
-
PUT
Revert DocumentTemplate to Library
/tenants/{tenant}/document-templates/{code}/library-version
-
POST
Import from Library
/tenants/{tenant}/document-templates/library/{libraryCode}/import