Cashboard API

« Back to Overview

Document Templates

Document templates allow you to customize the output of invoices, payments, and estimates.
More information on our template language is available here.

Operations on this resource are restricted to admins only.

List
GET /document_templates

New
GET /document_templates/new

Returns a data template that you can fill in to use the CREATE action.

Create
POST /document_templates

Creates a new payment. Use the template provided by the NEW action.

Actions

Show
GET [document_template link 'self']

Returns a single template.

Update
PUT [document_template link 'self']

Updates a template.

Delete
DELETE [document_template link 'self']

Deletes a template.
If you delete one of the standard templates it will reset to it's original content.

Data Reference

<?xml version="1.0" encoding="UTF-8"?>
<document_template>
  <content></content>
  <created_at></created_at>
  <has_been_modified read_only="true">false</has_been_modified>
  <is_default read_only="true">false</is_default>
  <name></name>
  <title></title>
</document_template>

Property Reference

content This contains the template content.
All HTML entities will be escaped when provided to you via the API.
name Should be a unique identifier for this template.
Should not contain spaces.
title For email templates, this is the "subject" line.