Innan ert affärssystem eller er plattform skickar en faktura, en order eller ett annat Peppol-dokument kan den fråga Qvalia om mottagarens Peppol-ID är registrerat och vilka dokumenttyper mottagaren kan ta emot. Nätverket avvisar dokument till en deltagare som inte är registrerad för dem, så kontrollen gör att ert system upptäcker ett saknat eller felaktigt Peppol-ID innan något skickas.
# Account API
GET /account/{accountRegNo}/action/lookup/peppol/{peppolId}
# Partner API
GET /partner/{partnerRegNo}/peppol/lookup/{peppolId}| Account API | Partner API | |
| Används av | Företag som skickar från sitt eget Qvalia-konto | Plattformar och tjänsteleverantörer som skickar för sina kunders räkning |
| Valfritt filter | docTypeRoot, till exempel Invoice eller CreditNote | docTypeRoot, till exempel Invoice, OrderResponse eller MLR |
| Bas-URL:er | Testmiljö api-test.qvalia.com, produktion api.qvalia.com | Testmiljö api-test.qvalia.com, produktion api.qvalia.com |
När ni bör kontrollera en mottagare
- När en kund läggs upp i ert system eller dess Peppol-ID ändras
- När en användare skriver in ett Peppol-ID för hand
- Innan ni skickar en dokumenttyp som mottagaren inte har fått från er tidigare, till exempel ett första ordersvar eller en kreditnota
Gör anropet
- Ange Peppol-ID som schema och identifierare med kolon emellan, till exempel
0007:1234567890för ett svenskt organisationsnummer. - Skicka ett GET-anrop till uppslags-endpointen, med er API-nyckel eller en JWT i headern
Authorization. - Lägg till
docTypeRootom ni vill ha svaret för en viss dokumenttyp, angiven med UBL-dokumentets rotelement.
GET /account/{accountRegNo}/action/lookup/peppol/0007:1234567890
?docTypeRoot=Invoice
Host: api-test.qvalia.com
Authorization: <er API-nyckel>Så läser ni svaret
| Status | Betydelse | Gör så här |
| 200 | Deltagaren som den är registrerad i Peppol, med de dokumenttyper den kan ta emot | Skicka om dokumenttypen ni behöver finns med |
| 422 | Peppol-ID:t har inte formen schema:identifierare | Rätta formatet, till exempel 0007:1234567890 |
| 429 | För många anrop från ert konto | Vänta så länge som headern Retry-After anger och försök igen |
Svaret från Partner API innehåller dessutom exists, som visar om Peppol-ID:t är registrerat över huvud taget, rootDocTypeExists, som visar om mottagaren kan ta emot dokumenttypen i docTypeRoot, och listan docTypes.
Är mottagaren inte registrerad för dokumenttypen, be den om rätt Peppol-ID eller kom överens om ett annat sätt att leverera dokumentet.
Kontrollera en enskild mottagare för hand
Vill ni kontrollera ett enskilt företag utan integration använder ni Sök Peppol-ID.
Läs också: Peppol SMP och SML · Vad är ett Peppol-ID? · Faktura-API · API-referensen