Skip to main content

DocumentTemplate

A tenant's Liquid template for one document type. Printing uses its published revision.

type DocumentTemplate {
  activeRevisionId: ID
  createdAt: DateTime!
  docType: String!
  handle: String!
  id: ID!
  isDefault: Boolean!
  name: String!
  origin: DocumentTemplateOrigin!
  updatedAt: DateTime!
}

Fields​

DocumentTemplate.activeRevisionId ● ID scalar​

The revision that prints. Null until a revision is published.

DocumentTemplate.createdAt ● DateTime! non-null scalar​

When the template was created.

DocumentTemplate.docType ● String! non-null scalar​

The document type, e.g. invoice.

DocumentTemplate.handle ● String! non-null scalar​

Stable name for this template within its document type.

DocumentTemplate.id ● ID! non-null scalar​

The template's id.

DocumentTemplate.isDefault ● Boolean! non-null scalar​

True when this template prints for its document type by default.

DocumentTemplate.name ● String! non-null scalar​

The name people see in Settings.

DocumentTemplate.origin ● DocumentTemplateOrigin! non-null enum​

Where the template came from.

DocumentTemplate.updatedAt ● DateTime! non-null scalar​

When the template last changed.

Returned By​

copyBuiltinDocumentTemplate mutation ● documentTemplate query ● documentTemplates query ● publishDocumentTemplateRevision mutation ● setDefaultDocumentTemplate mutation