Passer au contenu principal
PUT
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.

Paramètres de chemin

template
string
requis

L'ID du modèle de document, un UUID.

Corps

application/json

Un modèle d'un type de document. La mise en page est fixe : un modèle détermine ce qui la remplit, jamais la manière dont elle est dessinée, et jamais la bannière de classification.

type
enum<string>
requis

Le type de document pour lequel le modèle est fait : purchase_order, quote, invoice, packing_slip, certificate_of_conformance ou certificate_of_analysis. Il ne peut plus être modifié une fois le modèle créé.

Options disponibles:
purchase_order,
quote,
invoice,
packing_slip,
certificate_of_conformance,
certificate_of_analysis
name
string
requis

Le nom du modèle, comme Gouvernement, jusqu'à 80 caractères.

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

Les colonnes facultatives à afficher. Bons de commande : supplier_part_number, origin_country et expected_on. Soumissions et factures : discount et tax. Bordereaux d'expédition : lots et serials. Certificats : lots, serials et origin_country. Les colonnes qui ne sont pas facultatives s'impriment toujours.

Une des colonnes facultatives du type; celles de n'importe quel type lorsque le type est inconnu, comme lors de la génération de la référence de l'API.

Options disponibles:
supplier_part_number,
origin_country,
expected_on,
discount,
tax,
lots,
serials
paper
enum<string>
requis

Le format de papier d'impression des documents : letter ou a4.

Options disponibles:
letter,
a4
fields
object[]
requis

Champs personnalisés imprimés à côté des faits propres au document, comme un code CAGE, 12 au plus.

Maximum array length: 12
is_default
boolean

Indique si les documents du type s'impriment avec lui, sauf si leur client ou fournisseur en utilise un autre.

title
string | null

Le titre imprimé en haut, jusqu'à 80 caractères. Vide, il imprime le titre propre au type dans la langue du document.

Maximum string length: 80
notes
string | null

Les notes imprimées après les lignes, jusqu'à 2,000 caractères.

Maximum string length: 2000
terms
string | null

Conditions générales imprimées en dernier, jusqu'à 10,000 caractères.

Maximum string length: 10000

Réponse

DocumentTemplateResource

data
DocumentTemplateResource · object
requis

Un modèle d'un type de document : le titre, les colonnes facultatives, le format de papier, les champs personnalisés, les notes et les conditions avec lesquels ses documents s'impriment. La mise en page elle-même est fixe.