Erste Schritte

Fehler

Jeder Fehler hat, unabhängig vom Status, eine Form. code ist stabil und kann sicher zur Verzweigung genutzt werden; message sagt, was schiefging und, wo es hilft, was stattdessen zu senden ist; detail benennt den Parameter, Header oder Wert, um den es geht, sofern es einen gibt.

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	Status	Bedeutung
`unauthorized`	401	Kein Bearer-Token, oder kein gültiges.
`validation`	400	Ein Query-Parameter, ein Pfad-Parameter oder der Body ist fehlerhaft. detail benennt ihn.
`not_found`	404	Keine solche Vorlage bzw. kein solches Dokument, oder das Konto kann es nicht sehen. Die beiden Fälle sind absichtlich nicht unterscheidbar.
`template_not_saved`	409	Die Vorlage hat noch keine gespeicherte Version; nur gespeicherte Vorlagen können erzeugen.
`subscription_required`	402	Der Arbeitsbereich hat keinen aktiven Plan. Ein Inhaber oder Administrator kann auf der Abrechnungsseite einen wählen; nichts geht verloren.
`unknown_placeholder`	422	Ein Schlüssel von values ist kein Platzhalter-Schlüssel dieser Vorlage. Die Meldung listet die gültigen Schlüssel auf.
`unknown_group_field`	422	Ein Schlüssel in einem Instanzobjekt ist kein Feldschlüssel dieser Gruppe. Die Meldung listet die Felder auf.
`invalid_option`	422	Ein Auswahl-Platzhalter hat einen Wert erhalten, der keine seiner Optionen ist.
`invalid_number`	422	Ein Zahlen-Platzhalter hat etwas erhalten, das keine Zahl ist.
`invalid_values`	422	Ein Platzhalter hat ein Array erhalten, oder eine Gruppe eine Zeichenkette.
`idempotency_in_flight`	409	Dieselbe Anfrage wird noch verarbeitet. Versuchen Sie es gleich noch einmal.
`payload_too_large`	413	Der Anfrage-Body ist größer als 1 MB.
`method_not_allowed`	405	Die Methode wird auf diesem Pfad nicht unterstützt. Der Allow-Header listet die zulässigen.
`pdf_render_failed`	500	Das PDF des Dokuments konnte nicht erzeugt werden. Erneutes Anfordern versucht es noch einmal.
`internal`	500	Auf unserer Seite ist etwas schiefgegangen. Versuchen Sie es erneut; falls es anhält, schreiben Sie uns.