Skip to main content

DocumentTemplateConfig

The organization's setup of one document template.

type DocumentTemplateConfig {
accentColor: String
companyAddress: String
companyName: String
documentType: String!
footerText: String
id: ID!
logoAssetKey: String
style: String!
terms: String
updatedAt: DateTime!
visibleColumns: [String!]
}

Fields​

DocumentTemplateConfig.accentColor ● String scalar​

Accent color hex, e.g. #4F46E5

DocumentTemplateConfig.companyAddress ● String scalar​

The company address printed on the document.

DocumentTemplateConfig.companyName ● String scalar​

The company name printed on the document.

DocumentTemplateConfig.documentType ● String! non-null scalar​

'quote' | 'invoice' | 'purchase_order' (covers sales + purchase orders) | 'credit_note' | 'debit_note' | 'payment'

The footer text printed on the document.

DocumentTemplateConfig.id ● ID! non-null scalar​

The unique ID of this record.

DocumentTemplateConfig.logoAssetKey ● String scalar​

MinIO object key of the uploaded logo

DocumentTemplateConfig.style ● String! non-null scalar​

'professional' | 'modern' | 'classic'

DocumentTemplateConfig.terms ● String scalar​

The terms printed on the document.

DocumentTemplateConfig.updatedAt ● DateTime! non-null scalar​

When the record was last changed.

DocumentTemplateConfig.visibleColumns ● [String!] list scalar​

Visible column keys

Returned By​

documentTemplateConfig query ● updateDocumentTemplateConfig mutation