Premiers pas

Erreurs

Toute erreur, quel que soit le statut, a une seule forme. code est stable et sûr pour brancher ; message dit ce qui s’est mal passé et, quand c’est utile, quoi envoyer à la place ; detail nomme le paramètre, l’en-tête ou la valeur concernés, quand il y en a un.

JSON

{
  "error": {
    "code": "unknown_placeholder",
    "message": "No placeholder is keyed \"client\". Keys of `values` must be placeholder KEYS (the template’s placeholders[].key, e.g. \"client_name\"), not the values currently filled in and not names read out of the text. Retry with keys taken from exactly this list: \"client_name\", \"payment_terms\", \"due_date\", \"invoice_number\", \"issue_date\", \"line_items\"."
  }
}

Code	Statut	Signification
`unauthorized`	401	Pas de jeton bearer, ou jeton invalide.
`validation`	400	Un paramètre de requête, un paramètre de chemin ou le corps est mal formé. detail le nomme.
`not_found`	404	Aucun modèle ou document de ce type, ou le compte ne peut pas le voir. Les deux cas sont volontairement indiscernables.
`template_not_saved`	409	Le modèle n’a pas encore de version enregistrée ; seuls les modèles enregistrés peuvent générer.
`subscription_required`	402	L’espace de travail n’a pas d’abonnement actif. Un propriétaire ou un administrateur peut en choisir un sur la page de facturation ; rien n’est perdu.
`unknown_placeholder`	422	Une clé de values n’est pas une clé de champ de ce modèle. Le message liste les clés valides.
`unknown_group_field`	422	Une clé dans un objet d’instance n’est pas une clé de champ de ce groupe. Le message liste les champs.
`invalid_option`	422	Un champ de type select a reçu une valeur qui n’est pas l’une de ses options.
`invalid_number`	422	Un champ numérique a reçu autre chose qu’un nombre.
`invalid_values`	422	Un champ a reçu un tableau, ou un groupe a reçu une chaîne.
`idempotency_in_flight`	409	La même requête est encore en cours de traitement. Réessayez dans un instant.
`payload_too_large`	413	Le corps de la requête dépasse 1 Mo.
`method_not_allowed`	405	La méthode n’est pas prise en charge sur ce chemin. L’en-tête Allow liste celles qui le sont.
`pdf_render_failed`	500	Le PDF du document n’a pas pu être produit. Le redemander relance la tentative.
`internal`	500	Quelque chose a échoué de notre côté. Réessayez ; si cela persiste, écrivez-nous.