Transform API: konverzia formátu dokumentov

Konverzia dokumentov medzi formátmi e-faktúr bez odoslania cez Transform endpoint.

Pomocou Transform API konvertujete dokument z jedného formátu e-faktúry na iný bez odoslania alebo uloženia v PSB. To je praktické na testovanie transformácií pred spustením do prevádzky, alebo na manuálnu konverziu dokumentov pre partnerov, ktorí vyžadujú špecifický formát.

Endpoint
POST /api/v1/generic/transform?targetFormat={URN}

Odošlite zdrojový dokument ako telo s content-type application/xml. Parameter targetFormat obsahuje URN požadovaného cieľového formátu.

Ako to funguje?
  1. Upload: odošlite XML dokument na endpoint s požadovaným cieľovým formátom
  2. Detekcia: PSB automaticky detekuje zdrojový formát na základe XML obsahu
  3. Transformácia: dokument sa konvertuje na zadaný cieľový formát
  4. Odpoveď: konvertovaný dokument sa priamo vráti ako XML

Ak automatická detekcia zdrojového formátu zlyhá, môžete ho explicitne uviesť cez parameter sourceFormat:

POST /api/v1/generic/transform?targetFormat={URN}&sourceFormat={URN}
Príklady

Z NLCIUS na Peppol BIS Billing V3:

POST /api/v1/generic/transform?targetFormat=urn:cen.eu:en16931:2017%23compliant%23urn:fdc:peppol.eu:2017:poacc:billing:3.0

Z UBL na CII (Cross Industry Invoice):

POST /api/v1/generic/transform?targetFormat=urn:un:unece:uncefact:data:standard:CrossIndustryInvoice:100

Pozor: URN hodnoty v query parametroch zakódujte do URL. Znak # musí byť zakódovaný ako %23.

Podporované transformácie

Nie všetky transformácie sú dostupné. PSB podporuje rovnaké transformácie ako pri odosielaní a prijímaní dokumentov. Najpoužívanejšie transformácie zahŕňajú konverzie medzi UBL a CII a medzi rôznymi regionálnymi variantmi (NLCIUS, XRechnung, Factur-X).

Aké transformácie sú presne dostupné, závisí od aktuálnej transformačnej tabuľky PSB. Pozrite si psb.econnect.eu pre najaktuálnejší prehľad.

Spracovanie chýb
Stavový kódVýznam200 OKTransformácia úspešná, konvertovaný dokument v tele odpovede400 Bad RequestZdrojový formát nebol rozpoznaný alebo transformácia nie je podporovaná422 UnprocessableDokument nie je možné konvertovať (chýbajúce alebo neplatné dáta)
Kedy použiť?
  • Testovanie pred spustením: skontrolujte, či sa Vaše dokumenty správne transformujú pred nasadením integrácie do prevádzky
  • Manuálna konverzia: konvertujte dokumenty pre partnerov, ktorí vyžadujú iný formát
  • Porovnanie: vygenerujte rovnaký dokument vo viacerých formátoch na overenie mapovania

Technické: Transform API dokument neukladá a nespúšťa webhooky. Dokument sa transformuje v pamäti a priamo sa vráti.


Pozrite si kompletnú API špecifikáciu na psb.econnect.eu pre všetky podporované formáty a URN hodnoty.

Vyskúšajte to v API

Súvisiace