Documentation
Documentation
    • English (United States)
Document Template
Close API Documentation
Document Template

A document template contains the customizations for a particular document template type.

A document template represents the customization of a document type (e.g invoices). A document enables to define different designs including different layouts, fonts and content.

States
  • Create
    The create state indicates that the Document Template is in creation.
  • Active
    The active state indicates that the Document Template is active and may be used.
  • Inactive
    The inactive state indicates that the Document Template is inactive and may not be used.
  • Deleting
    The deleting state indicates that the Document Template is in the process to be deleted.
  • Deleted
    The deleted state marks the entity for purging from the database.
Properties
  • Default Template
    Whether this is the default document template which is used whenever no specific template is specified for the same template type.
  • Delivery Enabled
    Whether documents of this template should be delivered.
  • ID
    A unique identifier for the object.
  • Linked Space ID
    The ID of the space this object belongs to.
  • Name
    The name used to identify the document template.
  • Planned Purge Date
    The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.
  • Space ID
    The ID of the space this object belongs to.
  • State
    The object's current state.
  • Template Resource
    The resource path to a custom template to be used to generate PDF documents.
  • Type
    The document template's type.
  • Version
    The version is used for optimistic locking and incremented whenever the object is updated.