API Docs / Schemas / CreateClientDocumentFromTemplateRequest

CreateClientDocumentFromTemplateRequest

Request to generate a PDF document from a template and save it as a client document.

Properties

Name Type Description
templateCode*string

Code of the document template to render.

Code of the document template to render.

designThemeCodestring

Optional design theme code. If not specified, the template's default or tenant default is used.

Optional design theme code. If not specified, the template's default or tenant default is used.

title*string

Title for the generated document.

Title for the generated document.

documentCategoryCodestring

Optional document category code.

Optional document category code.

customTokensobject

Custom token values to inject into the template. Keys are token names, values are the text to substitute.
Accessible in templates as {{ CustomFields.TokenName }}.

Custom token values to inject into the template. Keys are token names, values are the text to substitute.
Accessible in templates as {{ CustomFields.TokenName }}.

visibleInClientPortalboolean

Whether the generated document should be visible in the client portal. Defaults to true.

Whether the generated document should be visible in the client portal. Defaults to true.

portalFolderPathstring

Portal folder path for the generated document. Defaults to "Generated Documents" if not specified.

Portal folder path for the generated document. Defaults to "Generated Documents" if not specified.

JSON Example

{
  "templateCode": "string",
  "designThemeCode": "string",
  "title": "string",
  "documentCategoryCode": "string",
  "customTokens": {}
}

Used By Operations