Skip to main content

Interface: DocumentTemplate

Defined in: type/DocumentTemplate.ts:6

Object class for DocumentTemplate

Properties

content?

optional content?: string

Defined in: type/DocumentTemplate.ts:14

The content of the template


contents?

optional contents?: LocalizedTemplateContent[]

Defined in: type/DocumentTemplate.ts:10

Uploaded handlebars template content, per given language


createdAt

createdAt: string

Defined in: type/DocumentTemplate.ts:20

The creation date of this Template


createdBy?

optional createdBy?: number

Defined in: type/DocumentTemplate.ts:24

ID of the user who created this Template


customQuery?

optional customQuery?: string

Defined in: type/DocumentTemplate.ts:16

GraphQL query to be executed before rendering the template to fetch additional data not in the original event payload.


fileNames

fileNames: LocalizedString[]

Defined in: type/DocumentTemplate.ts:28

File name to use when rendering a document template per given language, supports handlebars variables


id

id: string

Defined in: type/DocumentTemplate.ts:8

A unique identifier for the template


isDefaultOrderPdf

isDefaultOrderPdf: boolean

Defined in: type/DocumentTemplate.ts:30

Indicates whether the template is used for default order PDF generation


isDefaultQuotePdf

isDefaultQuotePdf: boolean

Defined in: type/DocumentTemplate.ts:32

Indicates whether the template is used for default quote PDF generation


lastModifiedAt

lastModifiedAt: string

Defined in: type/DocumentTemplate.ts:22

The last modified date of this Template


lastModifiedBy?

optional lastModifiedBy?: number

Defined in: type/DocumentTemplate.ts:26

ID of the user who last modified this Template


names

names: LocalizedString[]

Defined in: type/DocumentTemplate.ts:12

The name of the template per given language


queryVariables?

optional queryVariables?: string

Defined in: type/DocumentTemplate.ts:18

Variables that are use in the custom query, can use handlebars variables. Has to be a valid JSON string after rendering