La Spécification de l’interface Payreq est le document technique qui explique comment un système externe se connecte à Payreq Delivery pour envoyer des documents et gérer les Contacts automatiquement plutôt que par la console. Elle couvre deux méthodes d’intégration :
- Échange de fichiers via SFTP : fichiers par lots de Contacts, factures, factures externes ou documents de paie, déposés vers un emplacement Payreq SFTP selon un calendrier que vous contrôlez. Voir Téléverser du Courrier via SFTP.
- Une API JSON-REST : pour gérer les Contacts, soumettre et suivre les tâches de traitement et interroger les résultats de livraison par programme. Voir Payreq API.
À qui s’adresse ce guide
Ce document de référence technique s’adresse à l’équipe de développement d’un Mailhouse, d’un Print Service Provider ou d’un expéditeur qui met en place un processus automatisé. Si vous envoyez vous-même des documents dans la console, consultez plutôt Téléverser du Courrier, qui explique la méthode plus simple avec un PDF fusionné.
Types de fichiers couverts
| Type de fichier | Utilisation | Version de l’interface |
|---|---|---|
| Contacts | Ajouter ou mettre à jour les personnes ou comptes auxquels Payreq peut livrer des documents. | 4.0.0 |
| Bill | Documents de facturation ou avis, y compris les postes de facture. | 5.1.0 (l’ancienne version 4.5.0 demeure prise en charge) |
| External | Documents de type facture livrés hors des canaux habituels de Payreq. | 4.0.0 |
| Payroll | Documents de paie, par exemple des relevés de paie. | 4.2.0 |
Chaque type de fichier possède son propre format d’enregistrement et ses propres règles de validation. Si un fichier ne correspond pas au format attendu, la tâche de téléversement affiche un état d’erreur : voir Comprendre les statuts et les erreurs des tâches pour connaître les causes courantes et comment les corriger et les soumettre à nouveau.
Canaux de livraison
Quelle que soit la méthode d’intégration que vous utilisez, Payreq délivre les documents via le canal numérique sur lequel chaque destinataire est inscrit, actuellement :
- BPAY View (Australie)
- Facturation électronique Peppol (Australie/Nouvelle-Zélande)
- Courriel
- Payreq, Payreq Group, Payreq Xero, Payreq MYOB, Payreq Reckon
Gestion des versions
L’interface évolue au fil du temps, tant au niveau des formats de fichiers que de l’API. Payreq conserve un historique des versions et plusieurs versions peuvent être prises en charge à la fois. Par exemple, la version actuelle du fichier Bill est 5.1.0, mais l’ancien format 4.5.0 (spécification d’interface 1.12.18) est toujours accepté pour les intégrations qui n’ont pas encore migré. Lorsque vous créez ou mettez à jour une intégration, confirmez toujours la version que votre intégration doit utiliser.
Obtenir les spécifications complètes
Cet aperçu ne reproduit pas la spécification complète champ par champ. Puisqu’il s’agit d’un document technique détaillé (noms de champs exacts, types de données, longueurs et règles de validation pour chaque type d’enregistrement, ainsi que la référence complète du point de terminaison REST), Payreq fournit la spécification complète actuelle directement aux mailhouses et aux Contacts techniques dans le cadre de l’intégration ou lors de la planification d’un changement d’intégration.
Communiquez avec votre gestionnaire de compte ou le soutien technique Payreq pour obtenir la référence adaptée à votre intégration et des réponses à vos questions de mise en œuvre.
Articles connexes
Cet article a-t-il été utile ?
C'est super !
Merci pour votre commentaire
Désolé ! Nous n'avons pas pu vous être utile
Merci pour votre commentaire
Commentaires envoyés
Nous apprécions vos efforts et nous allons corriger l'article