Docs

Zastavenie faktúry, ktorá ešte nebola podaná

  • V sandboxe

Jednoducho povedané

Zastaví faktúru, ktorá sa ešte nedostala do kanála.
POST
/invoices/{id}/cancel

Funguje len dovtedy, kým je faktúra received, validated alebo queued. Od 0.18.3, keď sa odoslanie skúsilo a jeho odpoveď sa stratila (časový limit alebo 5xx), faktúra je submitting a zrušenie odpovie 409 send-in-progress, pretože ju kanál môže mať; worker ju uzavrie ako submitted alebo dead_letter. Keď ju kanál má, zrušenie je obchodný doklad (dobropis alebo KOR v Poľsku), nie volanie API. Od 0.18.5 zrušenie faktúry, ktorá je už zrušená, odpovie 200 s ňou, takže opakovanie po stratenej odpovedi je bezpečné. Od 0.18.6 môže kľúč operátora zrušiť faktúru v dead_letter, ak sa pre ňu nikdy neuskutočnilo volanie kanála: nemôže byť na kanáli, takže ten istý dokument možno potom poslať znova. Ak sa volanie uskutočnilo, odpoveď je 409 dead-letter-reached-rail, pretože tam môže byť odoslanie, ktorého odpoveď sa stratila: najprv overte u kanála. Kľúč klienta dostane 409 dead-letter; rozhoduje operátor.

Autorizácia

apiKey
headerAuthorizationBearer <token>

Kľúč posielajte ako token typu Bearer: Authorization: Bearer <your-api-key>. Stav služby je jediné volanie, ktoré nevyžaduje kľúč.

Parametre cesty

id*string

ID faktúry, ktoré vrátilo volanie na podanie.

Zhoda^inv_[A-Za-z0-9]{16,40}$

Parametre hlavičky

Idempotency-Key*string

Jedinečný kľúč pre každú logickú požiadavku (postačí UUID). Uchováva sa tak dlho, ako sa uchovávajú údaje klienta. S kľúčom operátora nesmie začínať na client: (400), v takom tvare sa ukladajú kľúče klientov.

Dĺžka8 <= length <= 100

Telo odpovede

Zrušená pred podaním, dead letter, ktorý sa nikdy nedostal ku kanálu (kľúč operátora), alebo už zrušená.

application/json
  1. response
id*string
invoice_ref*string
invoice_number?string
route*Route

Kanál krajiny. Rovnaké hodnoty ako country_route v stavových udalostiach.

Hodnota z"PEPPOL""PL-KSEF""RO-EFACTURA""FR-PA""DE-XRECHNUNG"
environment*string
Hodnota z"sandbox""production"
state*InvoiceState

Vlastný stav služby pre faktúru. Stavové udalosti hlásia životný cyklus viditeľný pre partnera; queued a submitting sú vnútorné kroky medzi validated a submitted. validation_failed znamená, že oficiálne pravidlá dokument odmietli; od 0.18.4 sa kontrola, ktorá sa nespustila (KOSIT-RUN, EI-PDF-CHECK), opakuje a potom skončí ako dead_letter s týmto kódom. dead_letter drží svoj dokument, takže ten istý súbor odpovie s duplicate_of; od 0.18.6 môže operátor zrušiť faktúru, pre ktorú sa neuskutočnilo žiadne volanie kanála, a potom môže súbor ísť znova.

Hodnota z"received""source_error""validated""validation_failed""queued""submitting""submitted""ready""accepted""rejected""delivered""cancelled""dead_letter"
legal_id?|

Číslo KSeF, index nahratia do ANAF, ID dokumentu v prístupovom bode, ID faktúry vo francúzskej platforme.

buyer_status?string|null
document_sha256?|
Zhoda^[a-f0-9]{64}$
attempts?array<>

Skoršie podania tej istej invoice_ref (napríklad po odmietnutí a oprave).

errors?array<>
documents?array<>
created_at*string
Formátdate-time
updated_at*string
Formátdate-time
deadline_at?string

Orientačný termín tejto faktúry, ako posledný okamih jej posledného povoleného dňa v UTC (dátumovú časť čítajte ako ten deň): dátum vystavenia plus päť pracovných dní pre Rumunsko (e-Factura), nasledujúci pracovný deň pre Poľsko (KSeF offline24). Dni sa počítajú od pondelka do piatka a sviatky sa neuplatňujú, takže skutočný termín môže byť neskôr, nikdy nie skôr; nie je to právna rada. Uvádza sa v každom stave faktúry; nehovorí, či bola faktúra včas alebo neskoro. Len pre tieto dva kanály a len keď faktúra nesie dátum vystavenia: POST /invoices s invoice.issue_date alebo od 0.19.2 súbor UBL (cbc:IssueDate) alebo súbor FA(3) (Fa/P_1) poslaný ako XML alebo vložený do priečinka. PDF žiadny nenesie a jeho absencia neznamená, že sa neuplatňuje žiadny termín. Od 0.19.1.

Formátdate-time
curl -X POST "https://example.com/invoices/inv_bd8bc8b276f38643f1c0f24f/cancel" \  -H "Authorization: Bearer <your-api-key>" \  -H "Idempotency-Key: order-2026-0001"
{  "invoice_ref": "FRESH-mux3dlqm-0",  "environment": "sandbox",  "document_sha256": "b341c81da6fe297787829a8c26fd4b25106b5b34e67482d38c1039651bbfed65",  "route": "DE-XRECHNUNG",  "updated_at": "2026-10-06T19:49:10.992Z",  "client": "acme-srl",  "created_at": "2026-10-06T19:49:10.816Z",  "id": "inv_ae4d9834bf251353532fe5ee",  "state": "cancelled",  "invoice_number": "FRESH-mux3dlqm-0"}