Passer au contenu principal
POST
cURL

Autorisations

Authorization
string
header
requis

Pour vos propres scripts et vos intégrations de serveur à serveur. Créez une clé dans l'application sous Paramètres > Accès > Clés d'API et copiez-la à ce moment-là, car elle n'est affichée qu'une fois. Envoyez-la sous la forme Authorization: Bearer <key>. La clé agit en tant que le membre qui l'a créée, dans l'organisation où elle a été créée. Un appel exige l'autorisation du membre et l'une des portées de la clé, comme inventory:read ou sales:write. Une clé avec * a toutes les portées.

Corps

multipart/form-data

L'image de marque avec laquelle chaque document s'imprime. Envoyez-la en multipart/form-data lorsqu'elle comprend un logo.

accent_color
string
requis

La couleur d'accent du filet d'en-tête et des titres de tableau, sous la forme #rrggbb.

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

La langue dans laquelle un document s'imprime lorsque son client ou son fournisseur n'en a pas : en, es ou fr-CA.

Options disponibles:
en,
es,
fr-CA

La raison sociale à imprimer, jusqu'à 200 caractères. Le nom de l'organisation s'imprime lorsqu'elle est vide.

Maximum string length: 200
address
string | null

Le bloc d'adresse, sous forme de lignes, jusqu'à 1,000 caractères.

Maximum string length: 1000
tax_id
string | null

Un numéro d'identification fiscale, comme un numéro de TVA, de TPS ou d'EIN, jusqu'à 64 caractères.

Maximum string length: 64

Une ligne imprimée au bas de chaque document, d'au plus 500 caractères.

Maximum string length: 500
logo
file | null

Un logo PNG ou JPEG d'au plus 1 Mo, qui remplace le précédent.

Mettez-le à true pour supprimer le logo. Ignoré lorsqu'un logo est envoyé.

Réponse

DocumentBrandingResource

data
DocumentBrandingResource · object
requis

L'image de marque avec laquelle chaque document de l'organisation s'imprime : le nom, l'adresse, le numéro d'identification fiscale, la couleur d'accent, le pied de page, la langue et le logo.