何かお探しですか？製品 Coupa製品ドキュメントインテグレーション技術文書 Coupa Core API リソース取引リソース支払API (/coupa_pay/payments )

支払API (/coupa_pay/payments )

Coupa Payインボイス支払APIを使用すると、ERP会計システムを使用して支払品目を計上して照合できます。

概要

Coupa Payインボイス支払は、支払APIエンドポイントに送信されたGETリクエストを使用して、ERPなどの別のシステムによってCoupaから取得される場合があります。 https://<your_instance_name>/api/coupa_pay/payments

インボイス支払が会計のためにERPにエクスポートされたら、その支払はPUT呼び出しを使用してマークする必要があるため、2回目は取得されません "exported": true, 。

サポートされているAPI操作：

取得
PUT（エクスポート済みにマークする場合のみ）

データのフェッチ/更新に使用するAPIキーには、データのインデックス作成、表示、更新の権限が必要 ../api/coupa_pay/paymentsです。

支払データは、ペイロード内のすべてのフィールドでクエリできます。一般的なクエリパラメーターは次のとおりです。

?exported=false
?payment-partner[issuing-bank]=<Bank_Name>
？ステータス=承認済み
?status[in]=payment_initiated,completed_with_errors
?pay_to_account[type]=CoupaPay::SupplierPaymentAccount（経費支払ではなく、請求書支払のみを取得する）
?updated-at[gt]>(注:update-atを使用して、すべての支払ステータスの変更が取得されたことを確認します)

クエリパラメーターは、次のようなコールステートメントに組み合わせることができます。

API取得
- 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
  - これにより、承認済みで、まだエクスポートされていないXYZBank発行者支払パートナーのステータスが「completed_successfully」および「completed_with_errors」のインボイス支払が返されます。

エクスポートされた支払は、正常にフェッチされたらエクスポート済みとしてマークする必要があります。次のような呼び出しで実行できます。

API PUTまたhttps://<your_instance_name>/api/coupa_pay/payments/<ID>?exported=trueは
次のようなhttps://<your_instance_name>/api/coupa_pay/payments/<ID>ペイロードを持つAPI PUT:
- <coupa-pay-payment><exported>true</exported></coupa-pay-payment>

要素

名前説明必須一意許容値で出力データタイプ

id Coupaの一意の支払識別子はいはい整数

created-at 「YYYY-MM-DDTHH:MM:SS+HH:MMZ」の形式で、Coupaによって自動的に作成されますはい日時

updated-at 「YYYY-MM-DDTHH:MM:SS+HH:MMZ」の形式で、Coupaによって自動的に作成されますはい日時

line-num 品目番号はい整数

external-ref-id 支払プロバイダーによって設定された参照ID はい整数

status 支払ステータス(payment_initiated; payment_in_progress, completed_successfully;completed_with_errors) draft、approved、payment initiated、payment_in_progress、completed_successfully、completed_with_errors はい string型

exported

品目は以前にサードパーティシステムにエクスポートされましたか？新しい値を見つけるためにインテグレーションによって使用されます。

true、false

はい

ブール値

last-exported-at 「YYYY-MM-DDTHH:MM:SS+HH:MMZ」の形式のタイムスタンプ日時

支払バッチID 支払バッチ識別子

インボイスCoupa ID
インボイス番号
合計金額
通貨
支払元アカウントの詳細
支払先アカウントの詳細整数

支払元合計 decimal型

支払先合計 decimal型

reporting-pay-from-total decimal型

報告 – 支払先合計

exchange-rate

エラーテキスト string型

支払詳細

主要データ要素

payment-details/payment-detail/created-at	支払作成日
payment-details/payment-detail/updated-at	支払更新日
payment-details/payment-detail/source-transaction-id	インボイスCoupa ID
payment-details/payment-detail/source-transaction-refe レンス	インボイス番号	ERPで支払を投稿するための請求書番号
payment-details/payment-detail/payment-total	合計金額	支払金額
payment-details/payment-detail/currency/code	通貨	支払通貨

JSONのpayment-details配列の例：: "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 } } ],

配列

支払元アカウント

JSONのpay-from-account配列の例：: "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 } },

配列

支払先アカウント

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 } },

配列

支払元通貨

支払先通貨

報告通貨

受取人

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 } } },

サプライヤー配列

支払バッチ

JSONのpayment-batch配列の例：: "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 } },

支払バッチアレイ

デジタル小切手

作成者作成したユーザーはいユーザー

更新者更新したユーザーはいユーザー

このページに表示されている一部、または全ての内容は、機械翻訳によるものです。ご了承ください。

支払API (/coupa_pay/payments )

概要

要素

関連アイテム