Premiers pas
Remplir les champs
Lisez d’abord le modèle : les champs et les groupes de l’endpoint de modèle constituent tout le contrat de values. Envoyez ensuite values sous forme d’objet indexé par la clé du champ.
- Les clés sont les clés des champs exactement telles que renvoyées, jamais la formulation de leurs libellés ni le texte déjà saisi (un libellé reste accepté, pour les clients écrits avant l’existence des clés). Un champ utilisé à plusieurs endroits du document est rempli partout à la fois.
- Les clés que vous omettez conservent les valeurs par défaut du modèle. Une chaîne vide efface un champ.
- Un champ select accepte exactement l’une de ses options, ou une chaîne vide.
- Un champ numérique accepte une chaîne numérique telle que 1234.56, dans l’une ou l’autre convention décimale ; le serveur la réécrit dans le format déclaré par le modèle, de sorte que 1234.56 devient 1,234.56 là où le format l’indique.
- Un champ de date n’est pas réécrit : envoyez la date déjà écrite comme le montre son format. Le format est la date de référence du 27 août 2026 écrite de la façon attendue : un format 08/27/2026 attend donc 10/15/2026.
- Les champs marqués auto sont remplis par PaperClerk à la génération (la date du jour ou le prochain numéro automatique), et tout ce que vous envoyez pour eux est ignoré.
- Un groupe répétable prend un tableau d’objets d’instance indexés par les clés de champ du groupe ; la ligne du modèle est clonée une fois par entrée. Un groupe omis conserve l’unique ligne rédigée ; un tableau vide supprime la section. Les valeurs des champs sont validées exactement comme les champs de premier niveau.
- Quand un champ porte une description, c’est un texte d’aide de l’auteur du modèle sur la valeur attendue, par exemple le format ou le contenu souhaité. Il n’est pas imprimé dans le document.
Un objet values pour un modèle de facture
JSON
{
"client_name": "Maple & Fern Ltd.",
"payment_terms": "Net 15",
"due_date": "10/15/2026",
"line_items": [
{ "item": "Brand identity system", "quantity": "1", "amount": "4800" },
{ "item": "Brand guidelines document", "quantity": "1", "amount": "1200" }
]
}