SOAP API: odesílání faktur přes SendDocument

Odesílání faktur a dokumentů přes endpoint SendDocument SOAP: parametry, směrování a sledování stavu.

Prostřednictvím endpointu SendDocument legacy SOAP API odesíláte faktury a další dokumenty přes platformu eConnect. Platforma automaticky určí nejlepší trasu: přes samotný platform eConnect, přes Peppol, nebo jako fallback e-mailem.

Důležité: Toto je legacy SOAP API. Pro nové integrace doporučujeme REST API.

Jak SendDocument funguje

Při volání SendDocument odešlete zdrojový dokument spolu s údaji o odesílateli a příjemci. Platforma poté vyhledá příjemce ve třech krocích:

  1. Platforma eConnect: je příjemce také uživatelem platformy? V takovém případě se dokument doručí přímo do inboxu.
  2. Peppol: je příjemce nalezitelný v síti Peppol? V takovém případě se dokument směruje přes Peppol.
  3. E-mail (fallback): pokud není možný ani jeden z předchozích způsobů a byla zadána e-mailová adresa, dokument se odešle e-mailem.
Povinné parametry
ParametrPopisVia/ReferenceIdIdentifikace odesílatele (Vaše vlastní EConnectPartyId, XCNL číslo)To/ReferenceIdIdentifikace příjemce (EConnectPartyId nebo Peppol identifikátor jako 0106:KVK-číslo)To/EmailAddressE-mailová adresa příjemce (použije se jako fallback, když není možné směrování přes platformu ani Peppol)SubjectPředmět dokumentuPayloadSamotný dokument jako UBL-XML. Pozor: odešlete XML bez XML prologu (<?xml ...?>)TemplateIdID šablony označující typ dokumentu
Příklad volání
<SendDocument>
  <Document>
    <Via>
      <ReferenceId>XCNL-123456</ReferenceId>
    </Via>
    <To>
      <ReferenceId>0106:12345678</ReferenceId>
      <EmailAddress>facturatie@voorbeeld.nl</EmailAddress>
    </To>
    <Subject>Factuur 2026-001</Subject>
    <Payload><!-- UBL-XML zonder prolog --></Payload>
    <TemplateId>GLDT9223370666504283001RA000000006DTP2000001</TemplateId>
  </Document>
</SendDocument>

TemplateId GLDT9223370666504283001RA000000006DTP2000001 je MasterTemplateId pro standardní fakturu. Vždy používejte MasterTemplateId (ne kód verze), protože zůstává stabilní mezi verzemi šablon.

Response a ExternalId

Po úspěšném volání API vrátí ExternalId. Jde o unikátní ID odeslaného dokumentu na platformě eConnect. Pokud odpověď neobsahuje ExternalId, dokument nebyl odeslán. V takovém případě zkontrolujte chybové hlášení v odpovědi.

ExternalId si vždy uložte: budete ho potřebovat pro pozdější zjišťování stavu dokumentu.

DeliveryMethod

API v odpovědi vrací i DeliveryMethod, abyste věděli, přes jaký kanál byl dokument doručen:

HodnotaVýznamToInboxDoručeno do inboxu příjemce na platformě eConnectToPeppolOdesláno přes síť PeppolToEmailOdesláno e-mailemOutboxOnlyUloženo pouze ve Vašem outboxu (nedoručeno)NoneDoručení nebylo možné
Sledování stavu

Po odeslání můžete sledovat stav Vašeho dokumentu přes dva endpointy:

EndpointFunkceGetOutboxDocumentsZískání seznamu odeslaných dokumentů. Filtrujte podle ModifiedOn pro zobrazení jen nedávno změněných dokumentů.GetOutboxDocumentVyžádání konkrétního dokumentu na základě ExternalId.GetOutboxDocumentStatusVyžádání pouze stavu bez kompletního dokumentu.
Tipy

UBL-XML bez prologu: Payload musí obsahovat UBL-XML bez deklarace <?xml version="1.0" encoding="UTF-8"?>. Pokud prolog odešlete, dokument nemusí být správně zpracován.

Používejte MasterTemplateId: vždy filtrujte podle Template/MasterId místo specifického template ID. MasterTemplateId se nemění při aktualizacích verzí šablony.

Zpracování chyb: zkontrolujte odpověď na chybové kódy. Série chybových kódů 400 (validace) a 200 (funkční) se nejčastěji vyskytují při chybách odesílání. Podívejte se na stránku o autentizaci pro kompletní přehled sérií chybových kódů.


REST API nabízí při odesílání další možnosti jako webhooky pro stavové notifikace a automatické opakování při chybách. Podívejte se na psb.econnect.eu pro moderní přístup.

Migrace na REST API

Související