Voordat uw ERP-systeem of platform een factuur, bestelling of ander Peppol-document verstuurt, kan het bij Qvalia navragen of het Peppol ID van de ontvanger is geregistreerd en welke documenttypes de ontvanger kan ontvangen. Een document dat wordt verzonden naar een deelnemer die daarvoor niet is geregistreerd, wordt door het netwerk geweigerd. Dankzij deze controle kan uw systeem dus een ontbrekend of onjuist Peppol ID opsporen voordat er iets wordt verzonden.
# Account API
GET /account/{accountRegNo}/action/lookup/peppol/{peppolId}
# Partner API
GET /partner/{partnerRegNo}/peppol/lookup/{peppolId}| Account-API | Partner-API | |
| Gebruikt door | Bedrijven die verzenden via hun eigen Qvalia-account | Platforms en dienstverleners die namens hun klanten berichten versturen |
| Optioneel filter | docTypeRoot, bijvoorbeeld Invoice of CreditNote | docTypeRoot, bijvoorbeeld Invoice, OrderResponse of MLR |
| Basis-URL's | Sandbox api-test.qvalia.com, productie api.qvalia.com | Sandbox api-test.qvalia.com, productie api.qvalia.com |
Wanneer moet je een ontvanger controleren?
- Wanneer er een klant in uw systeem wordt aangemaakt, of wanneer de Peppol ID van die klant verandert
- Wanneer een gebruiker handmatig een Peppol ID invoert
- Voordat u een document verstuurt dat de ontvanger nog niet eerder van u heeft ontvangen, bijvoorbeeld een reactie op een eerste bestelling of een creditnota
Dien het verzoek in
- Schrijf de ` Peppol ID ` als een combinatie van ‘scheme’ en ‘identifier’, gescheiden door een dubbele punt, bijvoorbeeld
0007:1234567890voor een Zweeds organisatienummer. - Stuur een GET-verzoek naar het lookup-eindpunt, met je API-sleutel of een JWT in de
Authorizationkoptekst. - Toevoegen
docTypeRootals je het antwoord voor één documenttype wilt, aangeduid met het bijbehorende UBL-hoofdelement.
GET /account/{accountRegNo}/action/lookup/peppol/0007:1234567890
?docTypeRoot=Invoice
Host: api-test.qvalia.com
Authorization: <your API key>Lees het antwoord
| Status | Betekenis | Wat te doen |
| 200 | De deelnemer zoals geregistreerd bij Peppol, met de documenttypes die hij kan ontvangen | Verzend het als het documenttype dat u nodig hebt in de lijst staat |
| 422 | De ' Peppol ID ' komt niet voor in het formulier scheme:identifier | Pas de opmaak aan, bijvoorbeeld 0007:1234567890 |
| 429 | Er zijn te veel verzoeken voor je account | Wacht net zo lang als de Retry-After zoals in de koptekst staat, probeer het dan opnieuw |
Het antwoord van de Partner API bevat ook exists, waarmee je kunt zien of de Peppol ID überhaupt is geregistreerd, rootDocTypeExists, waarmee wordt aangegeven of het dit documenttype kan ontvangen in docTypeRoot, en de lijst met docTypes.
Als de ontvanger niet is geregistreerd voor dit documenttype, vraag hem dan om zijn juiste Peppol ID, of spreek een andere manier af om het document te bezorgen.
Controleer één ontvanger handmatig
Om één bedrijf te controleren zonder integratie, gebruik je de zoekfunctie opPeppol ID .
Zie ook: Peppol SMP en SML · Wat is een „ Peppol ID “? · Facturatie-API · API-referentie