Skip to main content

DocumentTemplateCreateInput

Document template creation data with document-specific configuration.

Extends base template functionality with document-specific fields including file naming patterns, default template designations for automated document generation workflows.

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

Fields​

DocumentTemplateCreateInput.contents ● [LocalizedTemplateContentInput!]! non-null input​

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: Array must not be empty, must contain unique language entries.

DocumentTemplateCreateInput.names ● [LocalizedStringInput!]! non-null input​

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: Array must not be empty, must contain unique language entries.

DocumentTemplateCreateInput.customQuery ● String scalar​

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.

DocumentTemplateCreateInput.queryVariables ● String scalar​

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.

DocumentTemplateCreateInput.fileNames ● [LocalizedStringInput!]! non-null input​

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: Array must not be empty, must contain unique language entries.

DocumentTemplateCreateInput.isDefaultOrderPdf ● Boolean! non-null scalar​

Designates this template as the default for order PDF generation.

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

DocumentTemplateCreateInput.isDefaultQuotePdf ● Boolean! non-null scalar​

Designates this template as the default for 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​

documentTemplateCreate mutation