• Zuletzt bearbeitet am: 28 January 2021

Zahlungs-API (/coupa_pay/payments )

Mit der Coupa Pay Invoice Payments API können Sie Zahlungszeilen mit einem ERP-Buchhaltungssystem abrechnen und abgleichen.

Übersicht

Coupa Pay Invoice Payments kann von einem anderen System wie Ihrem ERP von Coupa abgerufen werden, indem eine GET-Anforderung an den Payments API-Endpunkt gesendet wird: https://<your_instance_name>/api/coupa_pay/payments 

Sobald eine Rechnungszahlung für die Buchhaltung in ein ERP exportiert wurde, sollte diese Zahlung mit dem Put-Aufruf als "exportiert": true markiert werden, damit sie nicht ein zweites Mal abgerufen wird.  

Unterstützte API-Operationen:

  • ABFRAGEN 
  • PUT (nur um exportiert zu markieren)

Der API-Schlüssel, der zum Abrufen/Aktualisieren von Daten verwendet wird, muss über die Berechtigung zum Indizieren, Anzeigen und Aktualisieren von../api/coupa_pay/payments-Daten verfügen.

Zahlungsdaten können von allen Feldern innerhalb der Nutzlast abgefragt werden. Typische Abfrageparameter sind:

  • ?exported=false
  • ?payment-partner[issuing-bank]=<Bank_Name>
  • ?status=genehmigt
  • ?status[in]=Zahlung_initiiert,abgeschlossen_mit_Fehlern
  • ?pay_to_account[type]= CoupaPay:: SupplierPaymentAccount (um nur Rechnungszahlungen, nicht Spesenzahlungen abzurufen)
  • ?updated-at[gt]<date-time>  (HINWEIS: Verwenden Sie update-at, um sicherzustellen, dass alle Änderungen des Zahlungsstatus erfasst werden)

 

Abfrageparameter können wie folgt zu einer Call-Anweisung kombiniert werden:

  • 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

      • Dadurch werden Rechnungszahlungen mit dem Status "completed_successfully" & "completed_with_errors" für XYZBank Issuer Payment Partner zurückgegeben, die genehmigt, aber noch nicht exportiert wurden.

Eine exportierte Zahlung sollte als exportiert markiert werden, sobald sie erfolgreich abgerufen wurde. Sie können dies mit einem Anruf wie dem folgenden tun:

  • API PUT https://<your_instance_name>/api/coupa_pay/payments/<ID>?exported=true oder

  • API https://<your_instance_name>/api/coupa_pay/payments/<ID> mit einer Nutzlast wie:

    • <coupa-pay-payment><exported>wahr</exported></coupa-pay-payment>

Elemente

Name Beschreibung Erforderlich Eindeutig Zulässige Werte In Out Datentyp
iD Eindeutige Coupa-Zahlungs-ID Ja     ja ganze Zahl
created-at Automatisch von Coupa erstellt im Format JJJJ-MM-TTTHH:MM:SS+HH:MMZ   ja datum/Uhrzeit
updated-at Automatisch von Coupa erstellt im Format JJJJ-MM-TTTHH:MM:SS+HH:MMZ   ja datum/Uhrzeit
line-num Zeilennummer
 
    ja ganze Zahl
external-ref-id Referenz-ID vom Zahlungsanbieter festgelegt     ja ganze Zahl
status Zahlungsstatus (payment_initiated; payment_in_progress, completed_successfully;completed_with_errors) entwurf, genehmigt, Zahlung eingeleitet, Zahlung_in_progress, abgeschlossen_erfolgreich, abgeschlossen_mit_Fehlern   ja zeichenfolge
exported

Wurde die Linie zuvor in ein System eines Drittanbieters exportiert? Wird von der Integration verwendet, um neue Werte zu finden.

richtig, falsch   ja boolean
last-exported-at Zeitstempel im Format: JJJJ-MM-TTTHH:MM:SS+HH:MMZ     datum/Uhrzeit
payment-batch-id Zahlungsstapel-Identifikator Rechnungs-Coupa-ID


Rechnungsnummer
Gesamtbetrag
Währung
Bezahlen von Kontodaten
Bezahlen an Kontodaten
      ganze Zahl
pay-from-total         dezimalzahl
pay-to-Total         dezimalzahl
reporting-pay-from-total         dezimalzahl
reporting-pay-to-total          
wechselkurs          
error-text         zeichenfolge
zahlungsdetails Schlüsseldatenelemente

payment-details/payment-detail/created-at

Erstellungsdatum der Zahlung

 

payment-details/payment-detail/updated-at

Zahlungsaktualisierungsdatum

 

payment-details/payment-detail/source-transaction-id

Rechnungs-Coupa-ID

 

payment-details/payment-detail/source-transaction-refe

renz

Rechnungsnummer

Rechnungsnummer, gegen die Zahlungen in ERP gebucht werden sollen

payment-details/payment-detail/payment-total

Gesamtbetrag

Zahlungsbetrag

zahlungsdetails/zahlungsdetails/währung/code

Währung

Zahlungswährung

Ein Beispiel für ein Zahlungsdetails-Array in json:
        "payment-details": [
{
"id": 848,
                "created-at": „2020-06-01T09:42:43-07:00“,
                „updated-at“: "2020-06-01T09:42:43-07:00",
                "Zahlungs-ID": "776",
                "payable-id": 940,
                "payable-type": "CoupaPay::Rechnung",
                "source-transaction-id": 940,
                "source-transaction-type": "InvoiceHeader",
                "source-transaction-reference": "100223",
                "Transaktionssumme": "20000.00",
                "Rabatt-Gesamt": „0.00“,
                „Adjustment-Total“: "0.00",
                "Zahlungssumme": "20000.00",
                "currency": {
"id": 1,
                    "code": "USD",
                    "decimals": 2
},
                "payable-allocations": [],
                "created-by": {
"id": 115,
                    "login": "Aninvoiceadmin",
                    "employee-number": "",
                    "Vorname": „Ahmad“,
                    „Nachname“: "Sadeddin",
                    "vollständiger Name": "Ahmad Sadeddin",
                    "email": "support@coupa.com",
                    "salesforce-id": null,
                    "avatar-thumb-url": null
},
                "updated-by": {
"id": 115,
                    "login": "Aninvoiceadmin",
                    "employee-number": "",
                    "Vorname": „Ahmad“,
                    „Nachname“: "Sadeddin",
                    "vollständiger Name": "Ahmad Sadeddin",
                    "email": "support@coupa.com",
                    "salesforce-id": null,
                    "avatar-thumb-url": null
}
}
],
    array
pay-from-account
Ein Beispiel für ein Pay-from-Account-Array in 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",
                "Typ": "CoupaPay::VirtualCardPartner",
                "payment-partner-type": "conferma",
                "notes": null,
                "configuration": {
"expiry-days": „30“,
                    „Toleranz-Pkt“: „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“,
                    „Nachname“: "Kumar",
                    "vollständiger Name": "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-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,
                                "avatar-thumb-url": null
},
                            "updated-by": {"id
": 79,
                                "login": "himicakumar", "employee-number
": "," firstname
                                ": null," „Himica“,
                                „Nachname“: "Kumar",
                                "vollständiger Name": "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“,
                                „Nachname“: "Kumar",
                                "vollständiger Name": "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“,
                            „Nachname“: "Kumar",
                            "vollständiger Name": "Himica Kumar",
                            "email": "support@coupa.com",
                            "salesforce-id": null,
                            "avatar-thumb-url": null
}
}
],
                "created-by": {
"id": 52,
                    "login": "Himica.Kumar@coupa.com",
                    "Mitarbeiternummer": null,
                    "Vorname": „Himica“,
                    „Nachname“: "Kumar",
                    "vollständiger Name": "Himica Kumar",
                    "email": "support@coupa.com",
                    "salesforce-id": null,
                    "avatar-thumb-url": null
},
                "updated-by": {
"id": 88,
                    "login": "himicareleaser",
                    "employee-number": "",
                    "firstname": „Himica“,
                    „Nachname“: "Kumar",
                    "vollständiger Name": "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“,
                „Nachname“: "Kumar",
                "vollständiger Name": "Himica Kumar",
                "email": "support@coupa.com",
                "salesforce-id": null,
                "avatar-thumb-url": null
},
            "updated-by": {
"id": 79,
                "login": "himicakumar",
                "employee-number": "",
                "firstname": „Himica“,
                „Nachname“: "Kumar",
                "vollständiger Name": "Himica Kumar",
                "email": "support@coupa.com",
                "salesforce-id": null,
                "avatar-thumb-url": null
}
},
    array
pay-to-Account
Ein Beispiel für ein Pay-to-Account-Array in 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": "inaktiv",
            "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": "aktiv",
                "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",
                        "Mitarbeiter-Nummer": "",
                        "Vorname": "Louis",
                        "Nachname": "Tayson",
                        "vollständiger Name": "Louis Tayson",
                        "email": "support@coupa.com",
                        "salesforce-id": null,
                        "avatar-thumb-url": null
},
                    "updated-by": {
"id": 171,
                        "login": "LT_Batch",
                        "Mitarbeiter-Nummer": "",
                        "Vorname": "Louis",
                        "Nachname": "Tayson",
                        "vollständiger Name": "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",
                        "Mitarbeiter-Nummer": "",
                        "Vorname": "Louis",
                        "Nachname": "Tayson",
                        "vollständiger Name": "Louis Tayson",
                        "email": "support@coupa.com",
                        "salesforce-id": null,
                        "avatar-thumb-url": null
},
                    "updated-by": {
"id": 171,
                        "login": "LT_Batch",
                        "Mitarbeiter-Nummer": "",
                        "Vorname": "Louis",
                        "Nachname": "Tayson",
                        "vollständiger Name": "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": „Teststadt“,
                „Bundesland“: "Colorado",
                "Postleitzahl": "80303",
                "active": false,
                "vat-number": null,
                "local-tax-number": null,
                "external-src-ref": „2818“,
                „external-src-name“: "Coupa Pay",
                "Land": {
"id": 223,
                    "Code": "US",
                    "Name": "United States"
},
                "vat-country": null,
                "tax-registrations": [],
                "created-by": {
"id": 171,
                    "login": "LT_Batch",
                    "Mitarbeiter-Nummer": "",
                    "Vorname": "Louis",
                    "Nachname": "Tayson",
                    "vollständiger Name": "Louis Tayson",
                    "email": "support@coupa.com",
                    "salesforce-id": null,
                    "avatar-thumb-url": null
},
                "updated-by": {
"id": 171,
                    "login": "LT_Batch",
                    "Mitarbeiter-Nummer": "",
                    "Vorname": "Louis",
                    "Nachname": "Tayson",
                    "vollständiger Name": "Louis Tayson",
                    "email": "support@coupa.com",
                    "salesforce-id": null,
                    "avatar-thumb-url": null
}
},
            "created-by": {
"id": 171,
                "login": "LT_Batch",
                "Mitarbeiter-Nummer": "",
                "Vorname": "Louis",
                "Nachname": "Tayson",
                "vollständiger Name": "Louis Tayson",
                "email": "support@coupa.com",
                "salesforce-id": null,
                "avatar-thumb-url": null
},
            "updated-by": {
"id": 171,
                "login": "LT_Batch",
                "Mitarbeiter-Nummer": "",
                "Vorname": "Louis",
                "Nachname": "Tayson",
                "vollständiger Name": "Louis Tayson",
                "email": "support@coupa.com",
                "salesforce-id": null,
                "avatar-thumb-url": null
}
},
    array
pay-from-currency          
pay-to-currency          
berichtswährung          
zahlungsempfänger
Ein Beispiel für ein Zahlungsempfänger-Array in json:
        "payee": {
"id": 1638,
            "name": „Lieferantenname Inc.“,
            „Anzeigename“: "Lieferantenname",
            "Nummer": Null,
            "Status": "Aktiv",
            "Hauptkontakt": {
"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+Charge",
                    "MA-Nummer": "",
                    "Vorname": "Lesley",
                    "Nachname": "Taylor",
                    "vollständiger Name": "Lesley Taylor",
                    "email": "support@coupa.com",
                    "salesforce-id": null,
                    "avatar-thumb-url": null
},
                "updated-by": {
"id": 171,
                    "login": "LT+Charge",
                    "MA-Nummer": "",
                    "Vorname": "Lesley",
                    "Nachname": "Taylor",
                    "vollständiger Name": "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+Charge",
                    "MA-Nummer": "",
                    "Vorname": "Lesley",
                    "Nachname": "Taylor",
                    "vollständiger Name": "Lesley Taylor",
                    "email": "support@coupa.com",
                    "salesforce-id": null,
                    "avatar-thumb-url": null
},
                "updated-by": {
"id": 171,
                    "login": "LT+Charge",
                    "MA-Nummer": "",
                    "Vorname": "Lesley",
                    "Nachname": "Taylor",
                    "vollständiger Name": "Lesley taylor",
                    "email": "support@coupa.com",
                    "salesforce-id": null,
                    "avatar-thumb-url": null
}
}
},
    lieferanten-Array
payment-batch
Ein Beispiel für ein Payment-Batch-Array in json:
        "payment-batch": {
"id": 232,
            "created-at": „2020-10-14T15:42:15-07:00“,
            „updated-at“: "2020-10-14T15:42:48-07:00",
            "status": "genehmigt",
            "description": Null,
            "created-by": {
"id": 171,
                "login": "LT+Charge",
                "MA-Nummer": "",
                "Vorname": "Lesley",
                "Nachname": "Taylor",
                "vollständiger Name": "Lesley Taylor",
                "email": "support@coupa.com",
                "salesforce-id": null,
                "avatar-thumb-url": null
},
            "updated-by": {
"id": 170,
                "login": "LT+Freigeber",
                "MA-Nummer": "",
                "Vorname": "Lesley",
                "Nachname": "Taylor",
                "vollständiger Name": "Lesley Taylor",
                "email": "support@coupa.com",
                "salesforce-id": null,
                "avatar-thumb-url": null
}
},
    zahlungs-Chargen-Array
digital-check              
erstellt von Benutzer der Erstellung         ja Benutzer
aktualisiert von Benutzer der Aktualisierung         ja Benutzer

 

 

Vergleichbare Artikel


Unterschiede zwischen XML und json in Coupa

16 December 2016

Integrationsausführungen-API

24 April 2017

Verwenden Sie diese API, um einen Integrationslauf zu erstellen, abzufragen oder zu aktualisieren sowie den Status zu aktualisieren.

Tagging-API

24 April 2017

Verwenden Sie die Tagging-API, um Tags in Ihr Drittanbietersystem einzubringen und zu exportieren.

Grund-API anfechten

05 August 2017

Hinweis: Einige Inhalte wurden maschinell übersetzt.