Docs

Referenčná dokumentácia API

Všetky operácie, ktoré môže partner volať, vygenerované zo súboru OpenAPI.

  • V sandboxeimplementované operácie
  • Plánovanéplánované operácie

Jednoducho povedané

Všetky volania, ktoré môže partner uskutočniť, vygenerované zo súboru OpenAPI k API. Základná adresa sandboxu je https://api-sandbox-eu.eurinvoice.com.

Každá stránka nižšie je vygenerovaná zo súboru OpenAPI, verzia 0.19.3, voči ktorému sa služba testuje. Kde je zobrazená zaznamenaná odpoveď, pochádza zo služby a na jej stránke je datovaná. Stránky v časti 3 vysvetľujú volania jednoduchými slovami.

Operácie, ktoré služba má

VolanieČo robíStav
GET /invoicesZobrazenie a vyhľadávanie faktúrV sandboxe
POST /invoicesPodanie faktúry alebo dobropisu ako kanonického JSONV sandboxe
POST /invoices/xmlPodanie hotového dokumentu UBL alebo CII (priame odovzdanie)V sandboxe
GET /invoices/seriesPrijaté a odmietnuté faktúry za deň a kanálV sandboxe
GET /invoices/{id}Zistenie aktuálneho stavu faktúryV sandboxe
POST /invoices/{id}/cancelZastavenie faktúry, ktorá ešte nebola podanáV sandboxe
GET /invoices/{id}/eventsZoznam stavových udalostí jednej faktúryV sandboxe
GET /invoices/{id}/documents/{kind}Stiahnutie vygenerovaného dokumentu alebo potvrdenia kanálaV sandboxe
POST /validateZostavenie a kontrola dokumentu bez odoslaniaV sandboxe
GET /webhookZistenie nastavení webhooku (vlastných nastavení operátora, alebo s administrátorským kľúčom klienta nastavení tohto klienta)V sandboxe
PUT /webhookNastavenie URL webhooku alebo výmena jeho tajného kľúčaV sandboxe
POST /webhook/testOdoslanie podpísanej skúšobnej udalosti na URL webhookuV sandboxe
GET /catalogue/{code}Vyhľadanie kódu chyby alebo dôvoduV sandboxe
GET /healthStav službyV sandboxe
GET /careZoznam na riešenie: odmietnuté faktúry a faktúry v dead-letter s kódom z katalógu a s tým, kto má konaťV sandboxe
POST /care/{id}/handledOznačenie riadkov faktúry na riešenie ako vybavenýchV sandboxe
GET /care/{id}/evidenceUložené súbory faktúry zo zoznamu na riešenie s ich SHA-256V sandboxe
GET /credentialsUložené prístupové údaje bez ich hodnôtV sandboxe
POST /credentialsUloženie prístupových údajov, šifrovane; hodnota sa nikdy nevraciaV sandboxe
GET /credentials/{id}Jedny prístupové údaje bez ich hodnotyV sandboxe
POST /credentials/{id}Nahradenie hodnoty (a platnosti) platných prístupových údajovV sandboxe
POST /credentials/{id}/revokeZrušenie prístupových údajov; záznam ostáva pre auditnú stopuV sandboxe
GET /keysZoznam kľúčov API (operátor vidí všetky; administrátorský kľúč klienta vidí vlastné)V sandboxe
POST /keysVytvorenie kľúča API pre klienta; kľúč sa zobrazí razV sandboxe
POST /keys/{id}/revokeZrušenie kľúča API; prestane fungovať okamžiteV sandboxe

Plánované operácie

Súbor OpenAPI ich uvádza. Služba ich zatiaľ nemá, takže nemajú stránku ani vzorovú požiadavku.

VolanieČo bude robiťStav
POST /invoices/{id}/statusesOdoslanie stavu od predávajúceho (len Francúzsko)Plánované

Na tejto stránke