Příručka
Chyby
Formát RFC 9457 a přehled typů chyb.
Chyby mají formát RFC 9457 (application/problem+json). Podle pole type se rozhodujte v kódu; title a detail jsou anglicky a určené lidem. request_id je stejné jako hlavička X-Request-Id.
Když tělo požadavku neprojde kontrolou, pole errors vypíše všechna chybná pole najednou. pointer určuje pole podle JSON Pointeru (RFC 6901), například /items/0/unit_price je cena první položky.
HTTP 422 · application/problem+json
{
"type": "https://api.fakturanet.cz/#problem-validation-failed",
"title": "Validation failed",
"status": 422,
"detail": "2 fields are invalid. See errors.",
"request_id": "9f2c41d0a7b3e815",
"errors": [
{
"pointer": "/due_date",
"detail": "Must be a date in YYYY-MM-DD format."
},
{
"pointer": "/items/0/price",
"detail": "Unknown field."
}
]
}
| Typ | Status | Kdy nastává |
|---|---|---|
unauthorized | 401 | Chybí API klíč, nebo je neplatný, vypršel či byl zneplatněn. Odpověď obsahuje hlavičku WWW-Authenticate. |
insufficient-scope | 403 | Klíč nemá oprávnění potřebné pro operaci. Vytvořte klíč s daným oprávněním. |
forbidden | 403 | Role uživatele, který klíč vytvořil, akci nedovoluje (například role Pouze čtení zapisovat), nebo tento uživatel už ve firmě není. |
plan-required | 403 | Tarif firmy nezahrnuje potřebnou funkci, například API nebo úpravu vystavených dokladů. |
not-found | 404 | Záznam neexistuje, byl smazán, nebo patří jiné firmě. Stejně tak neznámá cesta. |
method-not-allowed | 405 | Metoda není pro cestu podporovaná. Povolené metody jsou v hlavičce Allow. |
bad-request | 400 | Požadavek nelze zpracovat. |
malformed-json | 400 | Tělo není platný JSON objekt. |
invalid-parameter | 400 | Neplatný parametr v adrese, například limit nad 100, datum v jiném formátu než RRRR-MM-DD, neznámý doc_type nebo min s čárkou. Název parametru je v poli detail. |
idempotency-key-required | 400 | POST požadavek nemá platnou hlavičku Idempotency-Key: 16–128 znaků z písmen, číslic a . _ : -. |
conflict | 409 | Kolize s existujícím záznamem, například duplicitní číslo dokladu. |
already-issued | 409 | Vystavit lze jen koncept. |
export-not-ready | 409 | Export se ještě zpracovává. Opakujte GET /exports/{id}, dokud nemá stav ready. |
export-expired | 410 | Soubor exportu je starší než 7 dní. Vytvořte nový export. |
precondition-failed | 412 | Záznam se změnil od chvíle, kdy jste ho přečetli s daným ETag. Načtěte ho znovu a změnu zopakujte s novým ETag. |
payload-too-large | 413 | Tělo požadavku je větší než 1 MB. |
unsupported-media-type | 415 | Tělo musí mít Content-Type: application/json. |
validation-failed | 422 | Data neprošla kontrolou. Pole errors vypíše všechna chybná pole s odkazem (JSON Pointer); kontroly obchodních pravidel (například datum úhrady v budoucnosti nebo více než 3 rozpracované exporty) vrací důvod v poli detail. |
idempotency-key-reused | 422 | Stejný Idempotency-Key už byl použit s jinými daty. |
rate-limited | 429 | Překročen limit 120 požadavků za 60 sekund na klíč, nebo 30 požadavků s neplatným klíčem za 60 sekund z jedné IP adresy. Počkejte podle hlavičky Retry-After. |
server-error | 500 | Neočekávaná chyba. Při kontaktu s podporou uveďte request_id. |