Coupa PayステートメントAPI(/ coupa_pay / statements)
このページは機械翻訳を使用して翻訳されています。
概要
支払いが承認のステータスを持つ企業のカード決済パートナーステートメントは、ステートメントのAPIエンドポイントに送信されたGETリクエストを使用してERPにCoupaから取得することができます:https://{your_instance_name}/api/coupa_pay/statements
会計またはERP支払のために明細書がエクスポートされたら、その明細書はPUTコールを使用してエクスポート済みとしてマークする必要があります。そのため、2度目に取得されません。
サポートされるAPI操作:
- GET
- PUT(エクスポート済みとしてマークする場合のみ)
データの取得/更新に使用するAPIキーには、Api / Coupa_Pay / Statementsデータのインデックス作成、表示、更新の権限が必要です。
明細書データは、ペイロード内のすべてのフィールドで照会できます。一般的なクエリパラメータは次のとおりです。
- ?exported = false
- ?payment-partner [発行銀行] = <銀行名>
- ?status = approved_for_payment(ステータスはペイロード応答にありません)
これらのクエリパラメーターは、次のようなステートメントに組み合わせることができます。
-
API GET
https://{your_instance_name}/api/coupa_pay/statements?status=approved_for_payment&exported=false&payment-partner[issuing-bank]=XYZBank
- これにより、承認されているがエクスポートされていないXYZBank発行者支払パートナーのステートメントが返されます。
- ERP支払の場合、承認された明細書のみをCoupaからERPにプルする必要があります。
エクスポートされたステートメントは、正常にフェッチされたらエクスポート済みとしてマークする必要があります。次のような呼び出しでそれを行うことができます:
-
API PUT
https://{your_instance_name}/api/coupa_pay/statements/<ID>?exported=true
または -
以下のようなペイロードを持つ<b id="i5"><a id="x4" xid="i19.1.1">API PUT []:</a></b>
https://{your_instance_name}/api/coupa_pay/statements/<ID>
-
<statement><exported>true</exported></statement>
-
要素
id | 一意の識別子(読み取り専用) | はい | はい | 整数 | |||
created-at | 「YYYY-MM-DDTHH:MM:SS+HH:MMZ」の形式で、Coupaによって自動的に作成されます | はい |
文字列($ datetime) |
||||
updated-at | 「YYYY-MM-DDTHH:MM:SS+HH:MMZ」の形式で、Coupaによって自動的に作成されます | はい | 文字列($ datetime) | ||||
external-ref-id | 外部参照識別子 | はい | はい | 文字列(255) | |||
coupa-pay-id | はい | 整数 | |||||
name | 名前 | 文字列(255) | |||||
amount | この配分の金額 | はい | 小数(30,2) | ||||
statement-date | YYYY-MM-DDTHH:MM:SS + HH:MMZ形式の受領タイムスタンプ | はい | はい | 文字列($ datetime) | |||
number-of-lines | 読み取り専用 | はい | 整数 | ||||
total | すべてのステートメント行の合計(読み取り専用) | はい | 小数(16,10) | ||||
最終エクスポート日時 | タイムスタンプ | 文字列($ datetime) | |||||
exported | 真/偽は、記録の外部システムに送信されたステートメントでした。 (読み取り専用) | はい | ブール値 | ||||
支払パートナー | Coupa Pay-バーチャルカードパートナー | ||||||
currency | 通貨 | はい | はい | ||||
created_by | 作成したユーザー | はい | |||||
updated_by | 更新したユーザー | はい |