1. Accueil
  2. Base de connaissances
  3. Peppol
  4. Comment rechercher un destinataire Peppol via l'API
  1. Accueil
  2. Base de connaissances
  3. Gestion des données
  4. Comment rechercher un destinataire Peppol via l'API

Comment rechercher un destinataire Peppol via l'API

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.

# API Compte GET /account/{accountRegNo}/action/lookup/peppol/{peppolId} # API Partenaire GET /partner/{partnerRegNo}/peppol/lookup/{peppolId}
# Account API
GET /account/{accountRegNo}/action/lookup/peppol/{peppolId}

# Partner API
GET /partner/{partnerRegNo}/peppol/lookup/{peppolId}
API de compteAPI partenaire
Utilisé parLes entreprises qui effectuent des envois depuis leur propre compte QvaliaPlateformes et prestataires de services qui effectuent des envois pour le compte de leurs clients
Filtre facultatifdocTypeRoot, par exemple Invoice ou CreditNotedocTypeRoot, par exemple Invoice, OrderResponse ou MLR
URL de baseBac à sable api-test.qvalia.com, production api.qvalia.comBac à 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

  1. É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:1234567890 pour obtenir un numéro d'enregistrement d'organisation suédois.
  2. Envoyez une requête GET vers le point de terminaison de recherche, en indiquant votre clé API ou un JWT dans le Authorization en-tête.
  3. Ajouter docTypeRoot si 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>
GET /account/{accountRegNo}/action/lookup/peppol/0007:1234567890
    ?docTypeRoot=Invoice
Host: api-test.qvalia.com
Authorization: <your API key>

Lire la réponse

StatutSignificationQue faire ?
200Le participant tel qu'il est enregistré sur Peppol, avec les types de documents qu'il peut recevoirEnvoyez-le si le type de document dont vous avez besoin figure dans la liste
422L'Peppol ID e ne se présente pas sous la forme scheme:identifierCorrigez le format, par exemple 0007:1234567890
429Nombre excessif de demandes pour votre compteAttendez 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 .

API de recherche de destinataires

Vous n'êtes pas encore connecté à l'API de Qvalia ?

Contactez-nous pour obtenir un accès à l'API ; votre système pourra ainsi vérifier les destinataires avant chaque envoi.

Cet article a-t-il été utile ?

Articles connexes