Document - Templates

Document templates using Liquid syntax for dynamic content generation. Supports CRUD operations with filtering by template type. Includes library access for using predefined templates, and a render endpoint to generate PDFs from templates with provided data (client, partner, manager, practice, proposal details). Templates support design theme integration for consistent branding.

OpenAPI Spec

Guides Operations Schemas

GET List DocumentTemplates
Lists all DocumentTemplates for the given tenant. Requires: ViewAll on Templates.
/tenants/{tenant}/document-templates
POST Create DocumentTemplate
Creates a new DocumentTemplate for the specified tenant. Requires: Create on Templates.
/tenants/{tenant}/document-templates
GET Get DocumentTemplate
Gets a DocumentTemplate for the specified tenant. Requires: ViewAll on Templates.
/tenants/{tenant}/document-templates/{code}
PUT Update DocumentTemplate
Updates a DocumentTemplate for the specified tenant. Requires: Update on Templates.
/tenants/{tenant}/document-templates/{code}
DELETE Delete DocumentTemplate
Deletes a DocumentTemplate for the specified tenant. Requires: Delete on Templates.
/tenants/{tenant}/document-templates/{code}
GET List Library DocumentTemplates
List all DocumentTemplates available in the library as templates. Use optional 'search' query parameter to filter by Code, Name, or Description. Requ...
/tenants/{tenant}/document-templates/library
GET Get Library DocumentTemplate
Get details of a specific DocumentTemplate template from the library Requires: ViewAll on Templates.
/tenants/{tenant}/document-templates/library/{code}
PUT Revert DocumentTemplate to Library
Reverts the DocumentTemplate to the current library template version, overwriting any local edits. The DocumentTemplate's code is preserved so it rema...
/tenants/{tenant}/document-templates/{code}/library-version
POST Render DocumentTemplate as PDF
Renders a document template with the provided data to PDF format. The template receives the TemplateVariables data structure from the request. All pr...
/tenants/{tenant}/document-templates/{code}/render
POST Import from Library
Imports a document template from the library, creating any associated custom tokens that don't already exist. Re-imports of the same library item are ...
/tenants/{tenant}/document-templates/library/{libraryCode}/import
GET Get Custom Tokens
Extracts custom token names from a document template's body HTML, excluding standard template variables. Requires: ViewAll on Templates.
/tenants/{tenant}/document-templates/{code}/custom-tokens
POST Validate Template Syntax
Parses a Liquid template fragment under the real rendering engine and returns any syntax error with its location. Does not render or require data. Op...
/tenants/{tenant}/document-templates/validate