API des relevés de coupon de paiement (/coupa_pay/statements)
Les relevés des partenaires de paiement peuvent être obtenus avec une API GET call et un PUT call peut marquer ce relevé comme exporté.
Aperçu
Les relevés de partenaires de paiement par carte d'entreprise dont le statut de paiement est approuvé peuvent être récupérés de Coupa vers l'ERP à l'aide d'une demande GET envoyée au point de terminaison API des relevés : https ://{your_instance_name}/api/coupa_pay/statements
Une fois qu'un relevé est exporté pour un paiement comptable ou ERP, ce relevé doit être marqué comme exporté à l'aide de l'appel PUT, de sorte qu'il ne soit pas récupéré une deuxième fois.
Opérations API prises en charge :
- OBTENIR
- METTRE(uniquement pour marquer exporté)
La clé API utilisée pour récupérer/mettre à jour les données doit être autorisée à indexer, afficher et mettre à jour les données API/Coupa_Pay/Relevés.
Les données de relevé peuvent être interrogées par tous les champs de la charge utile. Les paramètres de requête typiques sont :
- ?exported=false
- ?payment-partner[issuing-bank]= Nom_banque<>
- ?status=approved_for_payment (le statut ne figure pas dans la réponse de la charge utile)
Ces paramètres de requête peuvent être combinés en une instruction comme suit :
-
API GET
https ://{your_instance_name}/api/coupa_pay/statements ?status=approved_for_payment&exported=false&payment-partner[issuing-bank]=XYZBank- Cela renverra les relevés pour le partenaire de paiement de l'émetteur XYZBank qui sont approuvés mais pas exportés.
- Pour les paiements ERP, vous ne devez extraire que les relevés approuvés de Coupa vers l'ERP.
Une déclaration exportée doit être marquée comme exportée une fois qu'elle a été récupérée avec succès. Vous pouvez le faire avec un appel comme celui-ci :
-
API PUT
https ://{your_instance_name}/api/coupa_pay/statements/<ID>?export=trueOU -
API PUT
https ://{your_instance_name}/api/coupa_pay/statements/<ID>avec une charge utile comme :-
<statement><exported>true</exported></statement>
-
Éléments
| iD | Identifiant unique (lecture seule) | Oui | oui | nombre entier | |||
| created-at | Créé automatiquement par Coupa au format AAAA-MM-JJTHH :MM :SS+HH :MMZ (lecture seule) | oui |
chaîne($datetime) |
||||
| mis-à-jour à | Créé automatiquement par Coupa au format AAAA-MM-JJTHH :MM :SS+HH :MMZ (lecture seule) | oui | chaîne($datetime) | ||||
| external-ref-id | Identifiant de référence externe | Oui | oui | string(255) | |||
| coupa-pay-id | oui | nombre entier | |||||
| nom | Nom | string(255) | |||||
| montant | montant en dollars pour cette allocation | oui | décimale(30,2) | ||||
| relevé-date | Horodatage du reçu au format : AAAA-MM-JJTHH :MM :SS+HH :MMZ | Oui | oui | chaîne($datetime) | |||
| nombre-de-lignes | (lecture seule) | Oui | nombre entier | ||||
| total | Somme de toutes les lignes de relevé (en lecture seule) | Oui | décimale(16,10) | ||||
| last-exported-at | horodatage | chaîne($datetime) | |||||
| exported | Vrai / Faux était la déclaration envoyée à un système d'enregistrement externe. (lecture seule) | Oui | boolean | ||||
| partenaire-de-paiement | Coupa Pay - Partenaire de carte virtuelle | ||||||
| devise | Devise | oui | oui | ||||
| créé par | Utilisateur qui a créé | oui | |||||
| mis à jour par | Utilisateur ayant réalisé la mise à jour | oui |