/ docs
ProduktZnalostiVývojáři
Platforma Control
Transform API: konverze formátu dokumentů

Konverze dokumentů mezi formáty e-faktur bez odeslání přes Transform endpoint.

Pomocí Transform API konvertujete dokument z jednoho formátu e-faktury na jiný bez odeslání nebo uložení v PSB. To je praktické pro testování transformací před spuštěním do provozu, nebo pro manuální konverzi dokumentů pro partnery, kteří vyžadují specifický formát.

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

Odešlete zdrojový dokument jako tělo s content-type application/xml. Parametr targetFormat obsahuje URN požadovaného cílového formátu.

Jak to funguje?
  1. Upload: odešlete XML dokument na endpoint s požadovaným cílovým formátem
  2. Detekce: PSB automaticky detekuje zdrojový formát na základě XML obsahu
  3. Transformace: dokument se konvertuje na zadaný cílový formát
  4. Odpověď: konvertovaný dokument se přímo vrátí jako XML

Pokud automatická detekce zdrojového formátu selže, můžete ho explicitně uvést přes parametr sourceFormat:

POST /api/v1/generic/transform?targetFormat={URN}&sourceFormat={URN}
Pří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 parametrech zakódujte do URL. Znak # musí být zakódován jako %23.

Podporované transformace

Ne všechny transformace jsou dostupné. PSB podporuje stejné transformace jako při odesílání a přijímání dokumentů. Nejpoužívanější transformace zahrnují konverze mezi UBL a CII a mezi různými regionálními variantami (NLCIUS, XRechnung, Factur-X).

Jaké transformace jsou přesně dostupné, závisí na aktuální transformační tabulce PSB. Podívejte se na psb.econnect.eu pro nejaktuálnější přehled.

Zpracování chyb
Stavový kódVýznam200 OKTransformace úspěšná, konvertovaný dokument v těle odpovědi400 Bad RequestZdrojový formát nebyl rozpoznán nebo transformace není podporována422 UnprocessableDokument není možné konvertovat (chybějící nebo neplatná data)
Kdy použít?
  • Testování před spuštěním: zkontrolujte, zda se Vaše dokumenty správně transformují před nasazením integrace do provozu
  • Manuální konverze: konvertujte dokumenty pro partnery, kteří vyžadují jiný formát
  • Porovnání: vygenerujte stejný dokument ve více formátech pro ověření mapování

Technické: Transform API dokument neukládá a nespouští webhooky. Dokument se transformuje v paměti a přímo se vrátí.

Podívejte se na kompletní API specifikaci na psb.econnect.eu pro všechny podporované formáty a URN hodnoty.

Vyzkoušejte to v API

Související
PreviousValidate API
NextPřehled VPD