Dativery Peppoš

Podporované typy dokumentů

Pole documentType v API používá následující krátké identifikátory. Odpovídající specifikace PEPPOL BIS definuje formát XML a pravidla ověřování pro každý typ.

Typ	Název	PEPPOL BIS	Ve výchozím seznamu	Poznámky
`invoice`	Faktura	BIS 3	✓	Standardní UBL faktura. Vrácena ve výchozím nastavení.
`creditnote`	Dobropis	BIS 3	✓	Standardní UBL dobropis. Vrácen ve výchozím nastavení.
`order`	Objednávka	BIS 28	—	Nákupní objednávka od kupujícího dodavateli.
`order-response`	Odpověď na objednávku (OR)	BIS 28	—	Odpověď dodavatele na objednávku. Aktualizuje stav objednávky (přijata / odmítnuta). Pro výpis použijte documentTypes=order_response nebo documentTypes=*.
`order-change`	Změna objednávky	BIS 28	—	Změna dříve podané objednávky.
`order-cancellation`	Zrušení objednávky	BIS 28	—	Zrušení dříve podané objednávky.
`despatch-advice`	Avízo expedice	BIS 16	—	Oznámení o odeslání od dodavatele kupujícímu.
`receipt-advice`	Potvrzení příjmu	BIS 17	—	Potvrzení kupujícího, že zboží nebo služby byly přijaty.
`catalogue`	Katalog	BIS 1	—	Katalog produktů / cen od dodavatele.
`mlr`	Odpověď na úrovni zprávy (MLR)	BIS 36	—	Technické potvrzení nebo odmítnutí přijaté zprávy. Není to obchodní dokument — aktualizuje stav původního dokumentu.
`other`	Ostatní	—	—	Jakýkoliv typ zprávy PEPPOL, který neodpovídá výše uvedeným kategoriím.

Odpovědní zprávy: MLR, IMR a Odpověď na objednávku

MLR (Message Level Response), IMR (Invoice Message Response) a Odpověď na objednávku (OR) nejsou samostatné obchodní dokumenty — jsou to odpovědi na jiný dokument. API aplikuje jejich výsledek přímo na stav původního dokumentu místo jejich zobrazení ve výchozím seznamu dokumentů.

MLR — potvrzení nebo odmítnutí na úrovni přenosu. Aktualizuje technický stav odeslaného dokumentu.
IMR — obchodní přijetí nebo odmítnutí faktury nebo dobropisu od kupujícího.
Odpověď na objednávku — přijetí nebo odmítnutí nákupní objednávky dodavatelem.

Pokud potřebujete zkontrolovat samotný nezpracovaný odpovědní dokument, můžete jej načíst přímo pomocí ID dokumentu obsaženého v payload webhooku:

GET /api/documents/{documentId}
Authorization: Bearer <token>

DocumentId pro odpovědní zprávu je obsaženo v payload webhooku pro události mlr, invoice.response a order.response jako pole documentId.

Řízení toho, co přijímáte prostřednictvím webhooků

Při registraci webhooku si vyberete, k jakým událostem se chcete přihlásit. Můžete se přihlásit k událostem stavu dokumentu na vysoké úrovni, k nezpracovaným odpovědním zprávám nebo k oběma:

Událost	Kdy je spuštěno	Payload obsahuje
`mlr`	Přijata MLR pro dokument, který jste odeslali	documentId zprávy MLR; stav původního dokumentu je již aktualizován
`invoice.response`	Přijata IMR (BIS 63) pro fakturu nebo dobropis, který jste odeslali	documentId zprávy IMR plus responseCode (AP/RE/UQ/PD) a referencedDocumentId původní faktury
`order.response`	Přijata Odpověď na objednávku (BIS 28) pro objednávku, kterou jste odeslali	documentId zprávy Odpovědi na objednávku plus responseCode a referencedDocumentId původní objednávky

Pro většinu integrací postačí přihlásit se pouze k mlr, invoice.response a order.response. DocumentId v každém payload lze předat přímo do GET /api/documents/{documentId}, pokud potřebujete plný XML nebo analyzovaná pole odpovědní zprávy.

Filtrování podle typu dokumentu

Oba /api/documents a /api/documents/inbox přijímají parametr dotazu documentTypes (hodnoty oddělené čárkami nebo * pro všechny typy).

Výchozí — pouze faktury a dobropisy

GET /api/documents
GET /api/documents/inbox

Všechny typy dokumentů včetně odpovědních zpráv

GET /api/documents?documentTypes=*
GET /api/documents/inbox?documentTypes=*

Pouze objednávky a odpovědi na objednávky

GET /api/documents?documentTypes=order,order-response

Pouze zprávy MLR

GET /api/documents?documentTypes=mlr

Dokumentace API

Podporované typy dokumentů

Odpovědní zprávy: MLR, IMR a Odpověď na objednávku

Řízení toho, co přijímáte prostřednictvím webhooků

Filtrování podle typu dokumentu