Que pouvons-nous vous aider à trouver ? Produits Documentation produit Coupa Documentation technique sur l'intégration API Coupa Core Ressources Ressources transactionnelles API de paiement (/coupa_pay/payments )

API de paiement (/coupa_pay/payments )

L'API Coupa Pay Invoice Payments vous permet de comptabiliser et de rapprocher les lignes de paiement à l'aide d'un système comptable ERP.

Aperçu

Les paiements de factures Coupa Pay peuvent être récupérés de Coupa par un autre système comme votre ERP à l’aide d’une demande GET envoyée au point de terminaison de l’API de paiement : https://<your_instance_name>/api/coupa_pay/payments

Une fois qu'un paiement de facture est exporté pour être comptabilisé dans un ERP, il doit être marqué comme "exported": true, utilisant l'appel PUT, afin qu'il ne soit pas récupéré une seconde fois.

Opérations API prises en charge :

OBTENIR
PUT (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 ../api/coupa_pay/paymentsdonnées.

Les données de paiement peuvent être interrogées par tous les champs de la charge utile. Les paramètres de requête typiques sont :

?exporté=faux
?payment-partner[banque-émettrice]=<Nom_banque >
?statut=approuvé
?status[in]=paiement_initié, complété_avec_erreurs
?pay_to_account[type]=CoupaPay::SupplierPaymentAccount (pour extraire uniquement les paiements de factures, pas les paiements de notes de frais)
?updated-at[gt]<date-time> (NOTE : use update-at to make sure all payment status change captured)

Les paramètres de requête peuvent être combinés en une instruction d'appel comme suit :

API GET
- https://<your_instance_name>/api/coupa_pay/payments?status[in]=completed_successfully,completed_with_errors&exported=false&payment-partner[issuing-bank]=XYZBank&pay_to_account[type]=CoupaPay::SupplierPaymentAccount
  - Cela renverra les paiements de facture avec le statut "completed_successfully" & "completed_with_errors" pour le partenaire de paiement émetteur XYZBank qui sont approuvés mais pas encore exportés.

Un paiement exporté doit être marqué comme exporté une fois qu'il a été récupéré avec succès. Vous pouvez le faire avec un appel comme suit :

API PUThttps://<your_instance_name>/api/coupa_pay/payments/<ID>?exported=trueOU
API PUThttps://<your_instance_name>/api/coupa_pay/payments/<ID>avec une charge utile comme :
- <coupa-pay-payment><exported>true</exported></coupa-pay-payment>

Éléments

Nom Description Obligatoire Unique Valeurs autorisées Dans Sortie Type de données

id Identifiant de paiement unique Coupa Oui oui entier

créé à Créé automatiquement par Coupa au format AAAA-MM-JJFHH:MM:SS+HH:MMZ oui datetime

mis à jour à Créé automatiquement par Coupa au format AAAA-MM-JJFHH:MM:SS+HH:MMZ oui datetime

numéro de ligne Numéro de ligne oui entier

id-réf-externe ID de référence défini par le fournisseur de paiement oui entier

statut Statut du paiement (payment_initiated ; payment_in_progress, complete_success ; complete_with_errors) brouillon, approuvé, paiement initié, paiement_en_cours, complété_avec_succès, complété_avec_erreurs oui chaîne

exporté

La ligne a-t-elle déjà été exportée vers un système tiers ? Utilisé par l'intégration pour trouver de nouvelles valeurs.

vrai, faux

oui

booléen

dernière exportation à Horodatage au format : AAAA-MM-JJTHH:MM:SS+HH:MMZ datetime

id-lot-paiement Identifiant du lot de paiement

ID Coupa de la facture
Numéro de facture
Montant total
Devise
Détails du compte de paiement
Détails du compte de paiement entier

paiement du total décimal

paiement total décimal

total de paiement des rapports décimal

paiement-total-reporting

taux de change

texte d'erreur chaîne

détails-paiement

Éléments de données clés

détails-paiement/détails-paiement/crée-a	Date de création du paiement
détails-paiement/détails-paiement/mis-a-jour	Date de mise à jour du paiement
détails-paiement/détails-paiement/id-transaction-source	ID Coupa de la facture
détails-paiement/détails-paiement/refe-transaction-source relation	Numéro de facture	Numéro de facture pour valider les paiements dans ERP
détails-paiement/détails-paiement/total-paiement	Montant total	Montant du paiement
détails-paiement/détails-paiement/devise/code	Devise	Devise du paiement

Exemple de tableau Payment-Details dans JSON :: "payment-details": [ { "id": 848, "created-at": "2020-06-01T09:42:43-07:00", "updated-at": "2020-06-01T09:42:43-07:00", "payment-id": "776", "payable-id": 940, "payable-type": "CoupaPay::Invoice", "source-transaction-id": 940, "source-transaction-type": "InvoiceHeader", "source-transaction-reference": "100223", "transaction-total": "20000.00", "discount-total": "0.00", "adjustment-total": "0.00", "payment-total": "20000.00", "currency": { "id": 1, "code": "USD", "decimals": 2 }, "payable-allocations": [], "created-by": { "id": 115, "login": "Aninvoiceadmin", "employee-number": "", "firstname": "Ahmad", "lastname": "Sadeddin", "fullname": "Ahmad Sadeddin", "email": "support@coupa.com", "salesforce-id": null, "avatar-thumb-url": null }, "updated-by": { "id": 115, "login": "Aninvoiceadmin", "employee-number": "", "firstname": "Ahmad", "lastname": "Sadeddin", "fullname": "Ahmad Sadeddin", "email": "support@coupa.com", "salesforce-id": null, "avatar-thumb-url": null } } ],

rangée

paiement du compte

Exemple de tableau de paiement à partir du compte dans JSON :: "pay-from-account": { "id": 654, "created-at": "2020-08-04T12:23:10-07:00", "updated-at": "2020-08-04T12:23:10-07:00", "coupa-pay-id": 665, "account-name": "Conferma - WEX Virtual Card", "source-name": null, "account-kind": "virtual_card", "payment-option": null, "status": "active", "document-types": [ "invoice" ], "currency": { "id": 1, "code": "USD", "decimals": 2 }, "payment-partner": { "id": 14, "created-at": "2020-08-04T12:14:45-07:00", "updated-at": "2021-01-21T09:25:52-08:00", "name": "Conferma - WEX", "issuing-bank": "WEX", "type": "CoupaPay::VirtualCardPartner", "payment-partner-type": "conferma", "notes": null, "configuration": { "expiry-days": "30", "tolerance-pct": "0.0", "fx-tolerance-pct": "5.0", "invoice-tolerance-pct": "0.0" }, "support-contact": { "id": 52, "login": "support@coupa.com", "employee-number": null, "firstname": "Himica", "lastname": "Kumar", "fullname": "Himica Kumar", "email": "support@coupa.com", "salesforce-id": null, "avatar-thumb-url": null }, "currency": { "id": 1, "code": "USD", "decimals": 2 }, "account-types": [ { "id": 4, "created-at": "2020-04-25T02:45:03-07:00", "updated-at": "2020-08-04T12:17:37-07:00", "name": "Ace Corporate", "active": true, "legal-entity-name": "", "dynamic-flag": false, "currency": { "id": 1, "code": "USD", "decimals": 2 }, "primary-contact": { "id": 182, "created-at": "2020-04-25T02:45:03-07:00", "updated-at": "2020-08-04T12:17:37-07:00", "email": "support@coupa.com", "name-prefix": null, "name-suffix": null, "name-additional": null, "name-given": "qweq", "name-family": "qweqwe", "name-fullname": null, "notes": null, "active": true, "phone-work": null, "phone-mobile": null, "phone-fax": null, "purposes": [], "created-by": { "id": 49, "login": "az-releaser", "employee-number": "", "firstname": "az-releaser", "lastname": "az-releaser", "fullname": "az-releaser azz-releaser", "email": "support@coupa.com", "salesforce-id": null, "avatar-thumb-url": null }, "updated-by": { "id": 79, "login": "himicakumar", "employee-number": "", "firstname": "Himica", "lastname": "Kumar", "fullname": "Himica Kumar", "email": "support@coupa.com", "salesforce-id": null, "avatar-thumb-url": null } }, "primary-address": { "id": 335, "created-at": "2020-04-25T02:45:03-07:00", "updated-at": "2020-08-04T12:17:37-07:00", "name": "", "location-code": null, "street1": "aasda", "street2": "", "city": "asdas", "state": "", "postal-code": "asd", "attention": null, "active": true, "business-group-name": null, "vat-number": null, "local-tax-number": null, "country": { "id": 223, "code": "US", "name": "United States" }, "vat-country": null, "content-groups": [], "purposes": [], "tax-registrations": [], "created-by": { "id": 49, "login": "az-releaser", "employee-number": "", "firstname": "az-releaser", "lastname": "az-releaser", "fullname": "az-releaser az-releaser", "email": "support@coupa.com", "salesforce-id": null, "avatar-thumb-url": null }, "updated-by": { "id": 79, "login": "himicakumar", "employee-number": "", "firstname": "Himica", "lastname": "Kumar", "fullname": "Himica Kumar", "email": "support@coupa.com", "salesforce-id": null, "avatar-thumb-url": null } }, "created-by": { "id": 49, "login": "az-releaser", "employee-number": "", "firstname": "az-releaser", "lastname": "az-releaser", "fullname": "az-releaser az-releaser", "email": "support@coupa.com", "salesforce-id": null, "avatar-thumb-url": null }, "updated-by": { "id": 79, "login": "himicakumar", "employee-number": "", "firstname": "Himica", "lastname": "Kumar", "fullname": "Himica Kumar", "email": "support@coupa.com", "salesforce-id": null, "avatar-thumb-url": null } } ], "created-by": { "id": 52, "login": "Himica.Kumar@coupa.com", "employee-number": null, "firstname": "Himica", "lastname": "Kumar", "fullname": "Himica Kumar", "email": "support@coupa.com", "salesforce-id": null, "avatar-thumb-url": null }, "updated-by": { "id": 88, "login": "himicareleaser", "employee-number": "", "firstname": "Himica", "lastname": "Kumar", "fullname": "Himica Kumar", "email": "support@coupa.com", "salesforce-id": null, "avatar-thumb-url": null } }, "account-types": [], "created-by": { "id": 79, "login": "himicakumar", "employee-number": "", "firstname": "Himica", "lastname": "Kumar", "fullname": "Himica Kumar", "email": "support@coupa.com", "salesforce-id": null, "avatar-thumb-url": null }, "updated-by": { "id": 79, "login": "himicakumar", "employee-number": "", "firstname": "Himica", "lastname": "Kumar", "fullname": "Himica Kumar", "email": "support@coupa.com", "salesforce-id": null, "avatar-thumb-url": null } },

rangée

paiement sur compte

Exemple de tableau pay-to-account dans JSON :: "pay-to-account": { "id": 1446, "created-at": "2020-10-14T14:59:21-07:00", "updated-at": "2020-10-15T13:24:49-07:00", "coupa-pay-id": 1458, "account-name": "Virtual Card lou*******************@cou******", "source-name": "cpaui", "account-kind": "virtual_card", "payment-option": "email", "status": "inactive", "document-types": [ "invoice" ], "virtual-card-days-valid": null, "include-cvv-in-cxml": null, "connect-remit-to-address-id": null, "currency": null, "supplier": { "id": 1538, "name": "Supplier Inc.", "display-name": "", "number": null, "status": "active", "primary-contact": { "id": 1551, "created-at": "2020-10-14T14:45:30-07:00", "updated-at": "2020-10-14T14:45:30-07:00", "email": "", "name-prefix": null, "name-suffix": null, "name-additional": null, "name-given": "", "name-family": "", "name-fullname": null, "notes": null, "active": true, "phone-work": null, "phone-mobile": null, "phone-fax": null, "purposes": [], "created-by": { "id": 171, "login": "LT_Batch", "employee-number": "", "firstname": "Louis", "lastname": "Tayson", "fullname": "Louis Tayson", "email": "support@coupa.com", "salesforce-id": null, "avatar-thumb-url": null }, "updated-by": { "id": 171, "login": "LT_Batch", "employee-number": "", "firstname": "Louis", "lastname": "Tayson", "fullname": "Louis Tayson", "email": "support@coupa.com", "salesforce-id": null, "avatar-thumb-url": null } }, "primary-address": { "id": 3030, "created-at": "2020-10-14T14:45:30-07:00", "updated-at": "2020-10-14T14:45:30-07:00", "name": null, "location-code": null, "street1": null, "street2": null, "city": null, "state": null, "postal-code": null, "attention": null, "active": true, "business-group-name": null, "vat-number": null, "local-tax-number": null, "country": null, "vat-country": null, "content-groups": [], "purposes": [], "tax-registrations": [], "created-by": { "id": 171, "login": "LT_Batch", "employee-number": "", "firstname": "Louis", "lastname": "Tayson", "fullname": "Louis Tayson", "email": "support@coupa.com", "salesforce-id": null, "avatar-thumb-url": null }, "updated-by": { "id": 171, "login": "LT_Batch", "employee-number": "", "firstname": "Louis", "lastname": "Tayson", "fullname": "Louis Tayson", "email": "support@coupa.com", "salesforce-id": null, "avatar-thumb-url": null } } }, "remit-to-address": { "id": 3031, "created-at": "2020-10-14T14:47:17-07:00", "updated-at": "2020-10-14T15:03:41-07:00", "remit-to-code": "cpay-brta-2818", "name": null, "street1": "Test", "street2": null, "city": "Test City", "state": "Colorado", "postal-code": "80303", "active": false, "vat-number": null, "local-tax-number": null, "external-src-ref": "2818", "external-src-name": "Coupa Pay", "country": { "id": 223, "code": "US", "name": "United States" }, "vat-country": null, "tax-registrations": [], "created-by": { "id": 171, "login": "LT_Batch", "employee-number": "", "firstname": "Louis", "lastname": "Tayson", "fullname": "Louis Tayson", "email": "support@coupa.com", "salesforce-id": null, "avatar-thumb-url": null }, "updated-by": { "id": 171, "login": "LT_Batch", "employee-number": "", "firstname": "Louis", "lastname": "Tayson", "fullname": "Louis Tayson", "email": "support@coupa.com", "salesforce-id": null, "avatar-thumb-url": null } }, "created-by": { "id": 171, "login": "LT_Batch", "employee-number": "", "firstname": "Louis", "lastname": "Tayson", "fullname": "Louis Tayson", "email": "support@coupa.com", "salesforce-id": null, "avatar-thumb-url": null }, "updated-by": { "id": 171, "login": "LT_Batch", "employee-number": "", "firstname": "Louis", "lastname": "Tayson", "fullname": "Louis Tayson", "email": "support@coupa.com", "salesforce-id": null, "avatar-thumb-url": null } },

rangée

devise du paiement

pay-to-currency

devise du rapport

bénéficiaire

Exemple de tableau de bénéficiaires dans JSON :: "payee": { "id": 1638, "name": "Supplier Name Inc.", "display-name": "Supplier Name", "number": null, "status": "active", "primary-contact": { "id": 1551, "created-at": "2020-10-14T14:45:30-07:00", "updated-at": "2020-10-14T14:45:30-07:00", "email": "", "name-prefix": null, "name-suffix": null, "name-additional": null, "name-given": "", "name-family": "", "name-fullname": null, "notes": null, "active": true, "phone-work": null, "phone-mobile": null, "phone-fax": null, "purposes": [], "created-by": { "id": 171, "login": "LT+batch", "employee-number": "", "firstname": "Lesley", "lastname": "Taylor", "fullname": "Lesley Taylor", "email": "support@coupa.com", "salesforce-id": null, "avatar-thumb-url": null }, "updated-by": { "id": 171, "login": "LT+batch", "employee-number": "", "firstname": "Lesley", "lastname": "Taylor", "fullname": "Lesley Taylor", "email": "support@coupa.com", "salesforce-id": null, "avatar-thumb-url": null } }, "primary-address": { "id": 3030, "created-at": "2020-10-14T14:45:30-07:00", "updated-at": "2020-10-14T14:45:30-07:00", "name": null, "location-code": null, "street1": null, "street2": null, "city": null, "state": null, "postal-code": null, "attention": null, "active": true, "business-group-name": null, "vat-number": null, "local-tax-number": null, "country": null, "vat-country": null, "content-groups": [], "purposes": [], "tax-registrations": [], "created-by": { "id": 171, "login": "LT+batch", "employee-number": "", "firstname": "Lesley", "lastname": "taylor", "fullname": "Lesley taylor", "email": "support@coupa.com", "salesforce-id": null, "avatar-thumb-url": null }, "updated-by": { "id": 171, "login": "LT+batch", "employee-number": "", "firstname": "Lesley", "lastname": "taylor", "fullname": "Lesley taylor", "email": "support@coupa.com", "salesforce-id": null, "avatar-thumb-url": null } } },

tableau de fournisseurs

lot de paiement

Exemple de tableau de lots de paiements dans JSON :: "payment-batch": { "id": 232, "created-at": "2020-10-14T15:42:15-07:00", "updated-at": "2020-10-14T15:42:48-07:00", "status": "approved", "description": null, "created-by": { "id": 171, "login": "LT+batch", "employee-number": "", "firstname": "Lesley", "lastname": "Taylor", "fullname": "Lesley Taylor", "email": "support@coupa.com", "salesforce-id": null, "avatar-thumb-url": null }, "updated-by": { "id": 170, "login": "LT+releaser", "employee-number": "", "firstname": "Lesley", "lastname": "Taylor", "fullname": "Lesley Taylor", "email": "support@coupa.com", "salesforce-id": null, "avatar-thumb-url": null } },

tableau de traitement par lots

chèque numérique

créé par Créateur oui Utilisateur

mis à jour par Utilisateur ayant réalisé la mise à jour oui Utilisateur

Une partie ou la totalité de cette page peut avoir été traduite par machine. Toutes nos excuses pour les inexactitudes.

Articles associés

API Coupa Core

Notre API RESTful fournit un accès fiable pour lire, modifier ou intégrer vos données à la plateforme Coupa.

Démarrez avec l'API

Informations générales sur l'utilisation de l'API Coupa et quand vous devez envisager d'utiliser CSV.

Transition vers OAuth 2.0 et OIDC

Coupa désapprouve les API Keys héritées et nécessite l'utilisation d'OAuth 2.0 / OIDC. À partir de R34, aucune nouvelle clé API ne sera émise et les clés API ne seront plus prises en charge avec R35.

Ressources

Nous avons organisé nos points de terminaison API par type d'objet : données de référence, données transactionnelles et ressources partagées.