Create an invoice template
Creates a new invoice template owned by the caller's organization. The template's TemplateJSON is validated against the current schema and stamped with the current schema version on write.
Create an invoice template › Request Body
descriptiondocument_typesnameCreate an invoice template › Responses
Created invoice template
created_atdeleted_atdescriptiondocument_typesidis_defaultis_systemnameorganization_idstatusupdated_atversionGet an invoice template
Returns a single invoice template by ID. System defaults are resolved from in-memory definitions; custom templates come from the org's repository.
path Parameters
idInvoice template ID
Get an invoice template › Responses
Invoice template
created_atdeleted_atdescriptiondocument_typesidis_defaultis_systemnameorganization_idstatusupdated_atversionUpdate an invoice template
Updates an org-owned invoice template. Requires expected_version for optimistic locking - fetch the template first and submit the version you read so concurrent edits cannot silently clobber each other.
path Parameters
idInvoice template ID
Update an invoice template › Request Body
descriptiondocument_typesexpected_versionnamestatusUpdate an invoice template › Responses
Updated invoice template
created_atdeleted_atdescriptiondocument_typesidis_defaultis_systemnameorganization_idstatusupdated_atversionDuplicate an invoice template
Creates a writable copy of the given template under the caller's organization. System defaults are duplicated by snapshotting the in-memory baseline.
path Parameters
idSource invoice template ID
Duplicate an invoice template › Responses
Duplicated invoice template
created_atdeleted_atdescriptiondocument_typesidis_defaultis_systemnameorganization_idstatusupdated_atversionRender an invoice template preview PDF
Renders a sample PDF using the stored template, or - if a template_json body is supplied - using that unsaved draft. Useful for live preview while editing in the builder. The response body is the PDF bytes; rendered output is short-TTL cached so repeated calls return identical bytes.
path Parameters
idInvoice template ID
Render an invoice template preview PDF › Responses
Rendered PDF bytes
Mark an invoice template as the org default
Marks the given org-owned invoice template as the organization's default template used when no per-customer template is selected. System templates cannot be set as default - duplicate them first.
path Parameters
idInvoice template ID
Mark an invoice template as the org default › Responses
Updated default template
created_atdeleted_atdescriptiondocument_typesidis_defaultis_systemnameorganization_idstatusupdated_atversionGet an invoice-template thumbnail SVG
Returns a lightweight SVG schematic of the template (block layout in theme colors) suitable for cards in a template picker. Strongly cached with an ETag keyed on the template's updated_at - clients should send If-None-Match.
path Parameters
idInvoice template ID
Get an invoice-template thumbnail SVG › Responses
SVG thumbnail