Skip to main content

DocumentTemplateUpdateInput

Document template update data with document-specific configuration.

Extends base template update functionality with document-specific fields including file naming patterns and default template designations. All fields are optional for partial updates.

input DocumentTemplateUpdateInput {
  names: [LocalizedStringInput!]
  contents: [LocalizedTemplateContentInput!]
  customQuery: String
  queryVariables: String
  fileNames: [LocalizedStringInput!]
  isDefaultOrderPdf: Boolean
  isDefaultQuotePdf: Boolean
}

Fields​

DocumentTemplateUpdateInput.names ● [LocalizedStringInput!] list input​

Updated localized template names for different languages.

Human-readable names for the template in various languages, used for template identification and management in multilingual environments.

Validation: When provided, array must not be empty and must contain unique language entries.

DocumentTemplateUpdateInput.contents ● [LocalizedTemplateContentInput!] list input​

Updated Handlebars template content for each supported language.

The actual template markup using Handlebars syntax for dynamic content generation, stored per language for localization support.

Validation: When provided, array must not be empty and must contain unique language entries.

DocumentTemplateUpdateInput.customQuery ● String scalar​

Updated GraphQL query for additional data enrichment.

Custom query executed before template rendering to fetch supplementary data not included in the original event payload, enabling rich template content with external data sources.

DocumentTemplateUpdateInput.queryVariables ● String scalar​

Updated variables for custom GraphQL query execution.

JSON object containing variables used in the custom query, supports Handlebars expressions for dynamic variable generation based on event data. Only valid when customQuery is provided or already exists.

DocumentTemplateUpdateInput.fileNames ● [LocalizedStringInput!] list input​

Updated dynamic file names for document template outputs.

File naming patterns per language using Handlebars variables to generate contextual file names for generated documents and attachments, enabling personalized document naming.

Validation: When provided, array must not be empty and must contain unique language entries.

DocumentTemplateUpdateInput.isDefaultOrderPdf ● Boolean scalar​

Updated designation for default order PDF generation.

When enabled, this template will be automatically selected for generating order confirmation PDFs in the system, streamlining the order processing workflow.

DocumentTemplateUpdateInput.isDefaultQuotePdf ● Boolean scalar​

Updated designation for default quote PDF generation.

When enabled, this template will be automatically selected for generating quotation PDFs in the system, streamlining the quote processing workflow.

Member Of​

documentTemplateUpdate mutation