Avant que votre ERP ou votre système de gestion de l’ plateforme ( ) n’envoie une facture, une commande ou tout autre document Peppol, il peut interroger Qvalia pour savoir si l’ Peppol ID du destinataire est enregistrée et quels types de documents ce dernier est autorisé à recevoir. Un document envoyé à un participant qui n’est pas enregistré pour ce type de document est rejeté par le réseau ; cette vérification permet donc à votre système de détecter une Peppol ID manquante ou erronée avant tout envoi.
# Account API
GET /account/{accountRegNo}/action/lookup/peppol/{peppolId}
# Partner API
GET /partner/{partnerRegNo}/peppol/lookup/{peppolId}
| API de compte | API partenaire | |
| Utilisé par | Les entreprises qui effectuent des envois depuis leur propre compte Qvalia | Plateformes et prestataires de services qui effectuent des envois pour le compte de leurs clients |
| Filtre facultatif | docTypeRoot, par exemple Invoice ou CreditNote | docTypeRoot, par exemple Invoice, OrderResponse ou MLR |
| URL de base | Bac à sable api-test.qvalia.com, production api.qvalia.com | Bac à sable api-test.qvalia.com, production api.qvalia.com |
Quand vérifier l'identité d'un destinataire ?
- Lorsqu'un client est créé dans votre système ou que ses coordonnées ( Peppol ID ) changent
- Lorsqu'un utilisateur saisit manuellement une adresse Peppol ID
- Avant d'envoyer un type de document que le destinataire n'a encore jamais reçu de votre part, par exemple une réponse à une première commande ou une note de crédit
Faire la demande
- Écrivez l'Peppol ID e sous la forme d'un schéma et d'un identifiant séparés par deux points, par exemple
0007:1234567890pour obtenir un numéro d'enregistrement d'organisation suédois. - Envoyez une requête GET vers le point de terminaison de recherche, en indiquant votre clé API ou un JWT dans le
Authorizationen-tête. - Ajouter
docTypeRootsi vous souhaitez obtenir la réponse pour un type de document donné, identifié par son élément racine UBL.
GET /account/{accountRegNo}/action/lookup/peppol/0007:1234567890
?docTypeRoot=Invoice
Host: api-test.qvalia.com
Authorization: <your API key>
Lire la réponse
| Statut | Signification | Que faire ? |
| 200 | Le participant tel qu'il est enregistré sur Peppol, avec les types de documents qu'il peut recevoir | Envoyez-le si le type de document dont vous avez besoin figure dans la liste |
| 422 | L'Peppol ID e ne se présente pas sous la forme scheme:identifier | Corrigez le format, par exemple 0007:1234567890 |
| 429 | Nombre excessif de demandes pour votre compte | Attendez aussi longtemps que le Retry-After comme indiqué dans l'en-tête, puis réessayez |
La réponse de l'API Partenaire contient également exists, qui indique si l'Peppol ID est enregistrée ou non, rootDocTypeExists, qui indique s'il est capable de prendre en charge ce type de document dans docTypeRoot, et la liste des docTypes.
Si le destinataire n'est pas enregistré pour ce type de document, demandez-lui ses coordonnées exactes ( Peppol ID) ou convenez d'un autre moyen de lui transmettre le document.
Vérifier manuellement un seul destinataire
Pour consulter les informations relatives à une entreprise sans intégration, utilisez la recherche surPeppol ID .
À lire également : Peppol SMP et SML · Qu'est-ce qu'un « Peppol ID » ? · API de facturation · Référence API