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

API de paiement (/coupa_pay/payments )

L'API de paiement des factures Coupa Pay 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 à partir 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 des paiements : https :<your_instance_name>///api/coupa_pay/payments

Une fois qu'un paiement de facture est exporté pour la comptabilité vers un ERP, ce paiement doit être marqué comme « exporté » : vrai, en utilisant l'appel PUT, de sorte qu'il n'est 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 extraire/mettre à jour les données doit être autorisée à indexer, afficher et mettre à jour les données../api/coupa_pay/payments.

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[issuing-bank]= Nom_banque<>
?status=approved
?status[in]=payment_initiated,completed_with_errors
?pay_to_account[type]= CoupaPay : : SupplierPaymentAccount (pour extraire uniquement les paiements de facture, pas les paiements de dépenses)
?updated-at[gt]<date-heure> (REMARQUE : utilisez update-at pour vous assurer que tous les changements de statut de paiement sont capturés)

Les paramètres de requête peuvent être combinés dans 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 » et « completed_with_errors » pour le partenaire de paiement de l'é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 celui-ci :

API PUT https ://<your_instance_name>/api/coupa_pay/payments/<ID> ?exported=true OU
API PUT https ://<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 admissibles Dans Sortie Type de données

id Identifiant de paiement Coupa unique Oui oui nombre entier

created-at 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

line-num Numéro de ligne oui nombre entier

external-ref-id Identifiant de référence défini par le fournisseur de paiement oui nombre entier

état Statut du paiement (payment_initiated ; payment_in_progress, completed_successfully ;completed_with_errors) brouillon, approuvé, paiement initié, payment_in_progress, completed_successfully, completed_with_errors oui chaîne

exportée

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

boolean

last-exported-at Horodatage au format : AAAA-MM-JJTHH :MM :SS+HH :MMZ datetime

payment-batch-id Identifiant de lot

de paiement Numéro de
facture ID coupa
Montant total
Devise
Paiement à partir des détails du compte
Paiement aux détails du compte nombre entier

pay-from-total décimale

pay-to-total décimale

reporting-pay-from-total décimale

reporting-pay-to-total

taux de change

error-text chaîne

paiement-détails

Éléments de données clés

payment-details/payment-detail/created-at	Date de création du paiement
payment-details/payment-detail/updated-at	Date de mise à jour du paiement
payment-details/payment-detail/source-transaction-id	ID de facture Coupa
payment-details/payment-detail/source-transaction-refe rence	Numéro de facture	Numéro de facture pour enregistrer les paiements dans l'ERP
payment-details/payment-detail/payment-total	Montant total	Montant du paiement
payment-details/payment-detail/devise/code	Devise	Devise du paiement

Un exemple de tableau de détails de paiement 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", "remise-total" : "0.00", "ajustement-total" : "0.00", "paiement-total" : "20000.00", "devise" : { "id" : 1, "code" : "USD", "decimals" : 2 }, "payable-allocations" : [], "created-by" : { "id" : 115, "connexion" : "Aninvoiceadmin", "employee-number" : "", "prénom" : "Ahmad", "nom" : "Sadeddin", "nom complet" : "Ahmad Sadeddin", "email" : "support@coupa.com", "salesforce-id" : null, "avatar-thumb-url" : null }, "updated-by" : { "id" : 115, "login" : "Aninvoiceadmin", "employee-number" : "", "prénom" : "Ahmad", "nom" : "Sadeddin", "nom complet" : "Ahmad Sadeddin", "email" : "support@coupa.com", "salesforce-id" : null, "avatar-thumb-url" : null } } ],

tableau

paiement à partir du compte

Un 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, "nom-compte" : "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", "nom" : "Conferma - Wex", "banque émettrice" : "Wex", "type" : "CoupaPay : :VirtualCardPartner", "payment-partner-type" : "conferma", "notes" : null, "configuration" : { "expiration-jours" : "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", "nom" : "Kumar", "nom complet" : "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", "nom" : "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-04T 12: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, "atar-thavumb-url ": null }," mis à jour par ": { " id ": 79, " login ":" himicakum ", " employee-number ":", "firstname" : " "Himica", "nom" : "Kumar", "nom complet" : "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" : "États-Unis", "nom" : "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", "nom" : "Kumar", "nom complet" : "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", "nom" : "Kumar", "nom complet" : "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", "nom" : "Kumar", "nom complet" : "Himica Kumar", "email" : "support@coupa.com", "salesforce-id" : null, "avatar-thumb-url" : null }, "updated-by" : { "id" : 88, "login" : "heicareleaser", "employee-number" : "", "firstname" : "Himica", "nom" : "Kumar", "nom complet" : "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", "nom" : "Kumar", "nom complet" : "Himica Kumar", "email" : "support@coupa.com", "salesforce-id" : null, "avatar-thumb-url" : null }, "updated-by" : { "id" : 79, "login" : "himicakumar", "employee-number" : "", "firstname" : "Himica", "nom" : "Kumar", "nom complet" : "Himica Kumar", "email" : "support@coupa.com", "salesforce-id" : null, "avatar-thumb-url" : null } },

tableau

paiement au compte

Un exemple de tableau de paiement au compte dans JSON :: "pay-to-account" : { "id" : 1446, "created-at" : "14/10/2020T14:59:21-07:00", "updated-at" : "2020-10-15T13:24:49-07:00", "coupa-pay-id" : 1458, "nom-compte" : "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" : "actif", "primary-contact" : { "id" : 1551, "created-at" : "14/10/2020T14: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" : "", "prénom" : "Louis", "nom" : "Tayson", "nom complet" : "Louis Tayson", "email" : "support@coupa.com", "salesforce-id" : null, "avatar-thumb-url" : null }, "updated-by" : { "id" : 171, "login" : "LT_Batch", "employee-number" : "", "prénom" : "Louis", "nom" : "Tayson", "nom complet" : "Louis Tayson", "email" : "support@coupa.com", "salesforce-id" : null, "avatar-thumb-url" : null } }, "primary-address" : { "id" : 3030, "created-at" : "14/10/2020T14:45:30-07:00", "updated-at" : "2020-10-14T 14: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" : "", "prénom" : "Louis", "nom" : "Tayson", "nom complet" : "Louis Tayson", "email" : "support@coupa.com", "salesforce-id" : null, "avatar-thumb-url" : null }, "updated-by" : { "id" : 171, "login" : "LT_Batch", "employee-number" : "", "prénom" : "Louis", "nom" : "Tayson", "nom complet" : "Louis Tayson", "email" : "support@coupa.com", "salesforce-id" : null, "avatar-thumb-url" : null } } }, "remit-to-address" : { "id" : 3031, "created-at" : "14/10/2020T14:47:17-07:00", "updated-at" : "2020-10-14T15:03:41-07:00", "remit-to-code" : "cpay-brta-2818", "nom" : null, "street1" : "Test", "street2" : null, "ville" : "Ville test", "état" : "Colorado", "code postal" : "80303", "active" : false, "numéro de TVA" : null, "numéro d'impôt local" : null, "external-src-ref" : "2818", "nom-src-externe" : "Coupa Pay", "pays" : { "id" : 223, "code" : "États-Unis", "nom" : "États-Unis" }, "pays TVA" : null, "immatriculations fiscales" : [], "créé par" : { "id" : 171, "connexion" : "LT_Batch", "employee-number" : "", "prénom" : "Louis", "nom" : "Tayson", "nom complet" : "Louis Tayson", "email" : "support@coupa.com", "salesforce-id" : null, "avatar-thumb-url" : null }, "updated-by" : { "id" : 171, "login" : "LT_Batch", "employee-number" : "", "prénom" : "Louis", "nom" : "Tayson", "nom complet" : "Louis Tayson", "email" : "support@coupa.com", "salesforce-id" : null, "avatar-thumb-url" : null } }, "created-by" : { "id" : 171, "login" : "LT_Batch", "employee-number" : "", "prénom" : "Louis", "nom" : "Tayson", "nom complet" : "Louis Tayson", "email" : "support@coupa.com", "salesforce-id" : null, "avatar-thumb-url" : null }, "updated-by" : { "id" : 171, "login" : "LT_Batch", "employee-number" : "", "prénom" : "Louis", "nom" : "Tayson", "nom complet" : "Louis Tayson", "email" : "support@coupa.com", "salesforce-id" : null, "avatar-thumb-url" : null } },

tableau

pay-from-currency

pay-to-currency

reporting-currency

bénéficiaire

Un exemple de tableau de bénéficiaires dans JSON :: "payee" : { "id" : 1638, "nom" : "Nom du fournisseur Inc.", "nom d'affichage" : "Nom du fournisseur", "numéro" : null, "statut" : "actif", "contact principal" : { "id" : 1551, "created-at" : "14/10/2020T14: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" : "", "prénom" : "Lesley", "nom" : "Taylor", "nom complet" : "Lesley Taylor", "email" : "support@coupa.com", "salesforce-id" : null, "avatar-thumb-url" : null }, "updated-by" : { "id" : 171, "login" : "LT+batch", "employee-number" : "", "prénom" : "Lesley", "nom" : "Taylor", "nom complet" : "Lesley Taylor", "email" : "support@coupa.com", "salesforce-id" : null, "avatar-thumb-url" : null } }, "primary-address" : { "id" : 3030, "created-at" : "14/10/2020T14:45:30-07:00", "updated-at" : "2020-10-14T 14: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" : "", "prénom" : "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" : "", "prénom" : "Lesley", "lastname" : "Taylor", "fullname" : "Lesley taylor", "email" : "support@coupa.com", "salesforce-id" : null, "avatar-thumb-url" : null } } },

tableau de fournisseurs

lot-de-paiement

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

tableau de lots de paiement

digital-check

créé par Utilisateur qui a créé oui Utilisateur

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

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.