Chyby
Chyby mají formát application/problem+json (RFC 9457) se strojově čitelným kódem v poli code.
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/problem+json
{
"type": "https://api.abfaktura.cz/docs/chyby#DocumentLimitReached",
"title": "The request was refused",
"status": 422,
"code": "DocumentLimitReached"
}
Řiďte se kódem a HTTP stavem, ne textem v title a detail; ty se mohou měnit. Chyby ověření
(400) mají v errors pole a jejich chyby:
{
"type": "https://tools.ietf.org/html/rfc9110#section-15.5.1",
"title": "One or more validation errors occurred.",
"status": 400,
"errors": { "Lines": ["The field Lines must be a string or array type with a minimum length of '1'."] }
}
Kódy
| Kód | Stav | Význam |
|---|---|---|
Unauthorized | 401 | Chybí API klíč nebo token, nebo neplatí (zrušený, prošlý). |
ApiKeyScope | 403 | Klíč nebo token nemá potřebné oprávnění; které chybí, je v detail. |
Forbidden | 403 | Uživatel klíče na operaci nemá oprávnění. |
PlanRequired | 402 | API je jen v placených tarifech. |
NotFound | 404 | Záznam neexistuje nebo patří jiné firmě. |
ValidationFailed | 400 | Požadavek nemá správný tvar; v errors jsou pole a důvody. |
TooManyRequests | 429 | Překročený limit požadavků; počkejte podle Retry-After. |
IdempotencyKeyReused | 422 | Stejný Idempotency-Key byl použit pro jiný požadavek. |
Conflict | 409 | Požadavek se stejným Idempotency-Key ještě běží, nebo koliduje s daty. |
PartnerRequired | 422 | Chybí odběratel (customer) nebo dodavatel (supplier), případně contactId. |
DocumentLimitReached | 422 | Vyčerpaný limit dokladů tarifu. |
DocumentNumberAlreadyUsed | 422 | Číslo dokladu už má jiný doklad. |
NumberSeriesNotFound | 422 | Číselná řada neexistuje. |
CorrectionReasonRequired | 422 | Dobropis potřebuje důvod opravy. |
CorrectedInvoiceNotFound | 422 | Opravovaná faktura neexistuje. |
ProformaNotFound | 422 | Záloha neexistuje. |
ProformaAlreadySettled | 422 | Záloha už je vyúčtovaná jinou fakturou. |
QuoteNotFound | 422 | Nabídka neexistuje. |
AdvanceNotVatPayer | 422 | Daňový doklad k platbě vystavuje jen plátce DPH. |
AdvanceNothingToCover | 422 | Na záloze není zaplacená částka bez daňového dokladu. |
WebhookUrlInvalid | 422 | Adresa webhooku není veřejná adresa https. |
WebhookEventsInvalid | 422 | Neznámá událost webhooku. |
WebhookTooMany | 422 | Firma už má 10 webhooků. |
Unexpected | 500 | Chyba na naší straně. Zkuste to znovu; když přetrvává, napište podpoře. |