Document Types

Document types are PDF templates used to generate financial documents — invoices, proposals, and purchase orders. They define content blocks, layout, and branding applied when rendering documents.

Assign document types to subsidiaries to set the default template for generated PDFs.

Attributes

archived_at string
Response

Timestamp when this document type was archived, or null if still active.

attachment_ids object
Request

IDs of attachments (e.g. header images) associated with this document type.

attachments array of attachment
Response

Attachments associated with this document type, such as images used in templates.

body_template string
Response

The Liquid template used to render the body content of documents of this type.

document_style document style
Response

The document style applied to documents of this type for visual formatting.

document_style_id integer
Request

ID of the document style applied to documents of this type.

document_template_id integer
Response Request Parameter `filter` Enum

ID of the built-in document template this type is based on.

Enum Values (1 value)

  • 1
    standard_invoice_template.html.slim
dual_currency boolean
Response Request

Whether documents of this type display amounts in dual currencies.

email_data object
Response Request

A JSON object containing additional data passed to the email template when sending documents of this type.

email_subject string
Response Request

The default subject line used when emailing documents of this type.

email_template string
Response Request

The Liquid template used to render the email body when sending documents of this type.

exportable_type_id integer
Response Request Parameter `filter` Enum

ID of the exportable type indicating what kind of document this type generates (e.g. invoice, proposal).

Enum Values (4 values)

  • 1
    Invoice
  • 2
    Deal
  • 3
    Budget
  • 4
    Purchase Order
exporter_options string
Response Request

A hash of additional options passed to the document exporter to control rendering behavior.

filename_schema string
Response Request

A template string defining the naming pattern for exported document files.

footer string
Response Request

Legacy footer text included at the bottom of documents of this type.

footer_template string
Response

The Liquid template used to render the footer section of documents of this type.

header_template string
Response

The Liquid template used to render the header section of documents of this type.

id integer
Parameter `filter`

The unique identifier of this document type.

locale string
Response Request

The locale (language/region) used for formatting numbers, dates, and translations in documents of this type.

name string
Response Request

The display name of this document type.

note string
Response Request

An internal note or description for this document type, visible only to administrators.

organization organization
Response

The organization this document type belongs to.

scss_template string
Response

The SCSS stylesheet template used to style documents of this type when rendered to PDF.

status integer
Parameter `filter` Enum

The current status of this document type (e.g. active or archived).

Enum Values (2 values)

  • 1
  • 2
subsidiary subsidiary
Response

The subsidiary this document type is associated with for billing and legal entity purposes.

subsidiary_id integer
Request Parameter `filter`

ID of the subsidiary this document type is associated with.

tax1_name string
Response Request

The label displayed for the first tax line on documents of this type.

tax1_value number
Response Request

The default rate (as a percentage) for the first tax applied to documents of this type.

tax2_name string
Response Request

The label displayed for the second tax line on documents of this type.

tax2_value number
Response Request

The default rate (as a percentage) for the second tax applied to documents of this type.

template_options string
Response Request

A hash of configuration options specific to the document template used by this type.