Než váš ERP systém alebo platforma odošle faktúru, objednávku alebo iný dokument vo formáte Peppol, môže sa opýtať systému Qvalia, či je adresa „ Peppol ID “ príjemcu zaregistrovaná a aké typy dokumentov môže príjemca prijímať. Dokument odoslaný účastníkovi, ktorý nie je na daný typ dokumentu zaregistrovaný, sieť odmietne, takže táto kontrola umožňuje vášmu systému zachytiť chýbajúcu alebo nesprávnu adresu „ Peppol ID “ ešte pred odoslaním dokumentu.
# Account API
GET /account/{accountRegNo}/action/lookup/peppol/{peppolId}
# Partner API
GET /partner/{partnerRegNo}/peppol/lookup/{peppolId}| API účtu | Partner API | |
| Používa sa v | Spoločnosti, ktoré odosielajú zásielky zo svojho vlastného účtu Qvalia | Platformy a poskytovatelia služieb, ktorí odosielajú v mene svojich zákazníkov |
| Voliteľný filter | docTypeRoot, napríklad Invoice alebo CreditNote | docTypeRoot, napríklad Invoice, OrderResponse alebo MLR |
| Základné URL adresy | Pieskovisko api-test.qvalia.com, výroba api.qvalia.com | Pieskovisko api-test.qvalia.com, výroba api.qvalia.com |
Kedy skontrolovať príjemcu
- Keď sa vo vašom systéme vytvorí zákazník alebo sa zmení jeho Peppol ID
- Keď používateľ ručne zadá adresu Peppol ID
- Predtým, ako pošlete dokument, ktorý príjemca od vás ešte nedostal, napríklad odpoveď na prvú objednávku alebo dobropis
Podajte žiadosť
- Peppol ID a zapíšte vo forme schémy a identifikátora oddelených dvojbodkou, napríklad
0007:1234567890pre švédske identifikačné číslo organizácie. - Odošlite požiadavku GET na koncový bod vyhľadávania s vaším kľúčom API alebo JWT v poli
Authorizationhlavička. - Pridať
docTypeRootak chcete získať odpoveď pre jeden typ dokumentu, ktorý je označený svojím koreňovým prvkom UBL.
GET /account/{accountRegNo}/action/lookup/peppol/0007:1234567890
?docTypeRoot=Invoice
Host: api-test.qvalia.com
Authorization: <your API key>Prečítajte si odpoveď
| Stav | Význam | Čo robiť |
| 200 | Účastník zaregistrovaný v systéme Peppol spolu s typmi dokumentov, ktoré môže prijímať | Odošlite, ak je typ dokumentu, ktorý potrebujete, uvedený v zozname |
| 422 | Peppol ID a nie je v formulári scheme:identifier | Opravte formát, napríklad 0007:1234567890 |
| 429 | Príliš veľa požiadaviek na váš účet | Počkajte tak dlho, ako Retry-After ak to uvádza hlavička, skús to znova |
Odpoveď rozhrania Partner API obsahuje tiež exists, čo ukazuje, či je adresa Peppol ID vôbec zaregistrovaná, rootDocTypeExists, ktorý udáva, či dokáže prijať daný typ dokumentu v docTypeRoot, a zoznam docTypes.
Ak príjemca nie je zaregistrovaný pre daný typ dokumentu, požiadajte ho o uvedenie správnej adresy Peppol ID alebo sa dohodnite na inom spôsobe doručenia dokumentu.
Ručne skontrolujte jedného príjemcu
Ak chcete vyhľadať jednu spoločnosť bez integrácie, použite vyhľadávanie na stránkePeppol ID .
Súvisiace témy: Peppol SMP a SML · Čo je to „ Peppol ID “ · API pre fakturáciu · Referenčná príručka k API