Skip to main content
POST
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.

Body

multipart/form-data

The branding every document prints with. Sent as multipart/form-data when it carries a logo.

accent_color
string
required

The accent color as #rrggbb.

Pattern: ^#[0-9A-Fa-f]{6}$
locale
enum<string>
required

The language a document prints in when its customer or supplier has none: en, es or fr-CA.

Available options:
en,
es,
fr-CA

The legal name to print, up to 200 characters. The organization's name prints when it is empty.

Maximum string length: 200
address
string | null

The address block, as lines, up to 1,000 characters.

Maximum string length: 1000
tax_id
string | null

A tax id, such as a VAT, GST or EIN number, up to 64 characters.

Maximum string length: 64

A line printed at the foot of every document, up to 500 characters.

Maximum string length: 500
logo
file | null

A PNG or JPEG logo of at most 1 MB, which replaces the one before.

True removes the logo. Ignored when a logo is sent.

Response

DocumentBrandingResource

data
DocumentBrandingResource · object
required