Skip to main content
PUT
cURL

Authorizations

Authorization
string
header
required

For your own scripts and server-to-server integrations. Create a key in the app under Settings > Access > API keys and copy it then, because it is shown once. Send it as Authorization: Bearer <key>. The key acts as the member who made it, in the organization it was made in. A call needs the member's permission and one of the key's scopes, such as inventory:read or sales:write. A key with * has every scope.

Path Parameters

template
string
required

Body

application/json

A template of a document type. The layout is fixed: a template chooses what fills it, never how it is drawn, and never the classification banner.

type
enum<string>
required

purchase_order, quote, invoice, packing_slip, certificate_of_conformance or certificate_of_analysis. Fixed once the template exists.

Available options:
purchase_order,
quote,
invoice,
packing_slip,
certificate_of_conformance,
certificate_of_analysis
name
string
required

What the template is called, such as Government, up to 80 characters.

Maximum string length: 80
columns
enum<string>[]
required

The optional columns to show. Purchase orders: supplier_part_number, origin_country, expected_on. Quotes and invoices: discount, tax. Packing slips: lots, serials. Certificates: lots, serials, origin_country.

One of the type's optional columns; any type's when the type is unknown, as when the API reference is generated.

Available options:
supplier_part_number,
origin_country,
expected_on,
discount,
tax,
lots,
serials
paper
enum<string>
required

letter or a4.

Available options:
letter,
a4
fields
object[]
required

Custom fields printed beside the document's own facts, such as a CAGE code, at most 12.

Maximum array length: 12
is_default
boolean

Whether the type's documents print with it unless their customer or supplier uses another.

title
string | null

The title printed at the top, up to 80 characters. Empty prints the type's own title in the document's language.

Maximum string length: 80
notes
string | null

Notes printed after the lines, up to 2,000 characters.

Maximum string length: 2000
terms
string | null

Terms and conditions printed last, up to 10,000 characters.

Maximum string length: 10000

Response

DocumentTemplateResource

data
DocumentTemplateResource · object
required