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ódStavVýznam
Unauthorized401Chybí API klíč nebo token, nebo neplatí (zrušený, prošlý).
ApiKeyScope403Klíč nebo token nemá potřebné oprávnění; které chybí, je v detail.
Forbidden403Uživatel klíče na operaci nemá oprávnění.
PlanRequired402API je jen v placených tarifech.
NotFound404Záznam neexistuje nebo patří jiné firmě.
ValidationFailed400Požadavek nemá správný tvar; v errors jsou pole a důvody.
TooManyRequests429Překročený limit požadavků; počkejte podle Retry-After.
IdempotencyKeyReused422Stejný Idempotency-Key byl použit pro jiný požadavek.
Conflict409Požadavek se stejným Idempotency-Key ještě běží, nebo koliduje s daty.
PartnerRequired422Chybí odběratel (customer) nebo dodavatel (supplier), případně contactId.
DocumentLimitReached422Vyčerpaný limit dokladů tarifu.
DocumentNumberAlreadyUsed422Číslo dokladu už má jiný doklad.
NumberSeriesNotFound422Číselná řada neexistuje.
CorrectionReasonRequired422Dobropis potřebuje důvod opravy.
CorrectedInvoiceNotFound422Opravovaná faktura neexistuje.
ProformaNotFound422Záloha neexistuje.
ProformaAlreadySettled422Záloha už je vyúčtovaná jinou fakturou.
QuoteNotFound422Nabídka neexistuje.
AdvanceNotVatPayer422Daňový doklad k platbě vystavuje jen plátce DPH.
AdvanceNothingToCover422Na záloze není zaplacená částka bez daňového dokladu.
WebhookUrlInvalid422Adresa webhooku není veřejná adresa https.
WebhookEventsInvalid422Neznámá událost webhooku.
WebhookTooMany422Firma už má 10 webhooků.
Unexpected500Chyba na naší straně. Zkuste to znovu; když přetrvává, napište podpoře.