Payments API(/ coupa_pay / payments)
このページは機械翻訳を使用して翻訳されています。
概要
Coupaペイ請求書の支払い決済APIエンドポイントに送信されたGETリクエストを使用して、ERPのような別のシステムでCoupaから取得することができます:https://<your_instance_name>/api/coupa_pay/payments
ERPへの会計処理のために請求書支払がエクスポートされたら、その支払は "exported": true,PUTコールを使用して
としてマークする必要があります。そのため、2回目には取得されません。
サポートされるAPI操作:
- GET
- PUT(エクスポート済みとしてマークする場合のみ)
APIキーを取得するために使用/更新データは、インデックス、ショー、および更新する権限を持っている必要があります ../api/coupa_pay/payments
データを。
支払データは、ペイロード内のすべてのフィールドで照会できます。一般的なクエリパラメータは次のとおりです。
- ?exported =false
- ?payment-partner [発行銀行] = <銀行名>
- ?status =承認済み
- ?status [in] =payment_initiated、completed_with_errors
- ?pay_to_account [type] = CoupaPay :: SupplierPaymentAccount(請求書支払のみを引き出し、経費支払いは引き出しません)
- ?updated-at [gt] <date-time>(注:update-atを使用して、すべての支払ステータスの変更をキャプチャしてください)
クエリパラメータは次のようにコールステートメントに組み合わせることができます:
-
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
- これにより、承認されているがまだエクスポートされていないXYZBank発行者支払パートナーの
completed_successfullyステータスが「
」および「completed_with_errors
」の請求書支払が返されます。
- これにより、承認されているがまだエクスポートされていないXYZBank発行者支払パートナーの
-
https://<your_instance_name>/api/coupa_pay/payments/?status[in]=payment_initiated,completed_with_errors&updated-at[gt]=2019-07-18T13:33:00-07:00&pay_to_account[type]=CoupaPay::SupplierPaymentAccount
-
これにより、ステータスが「payment_initiated」および「completed_with_errors」で、2019-07-18T13:33:00-07:00以降に更新されたすべての請求書支払が返されます。
-
Coupaから新規/更新済みの支払のみが取得されるようにするには、日付入力をミドルウェアの最後の統合実行日時から取得する必要があります。
-
-
エクスポートされた支払は、正常にフェッチされるとエクスポート済みとしてマークされます。次のような呼び出しでそれを行うことができます:
-
API PUT
https://<your_instance_name>/api/coupa_pay/payments/<ID>?exported=true
または -
以下のようなペイロードを持つ<b id="i13"><a id="x7" xid="i25.1.1">API PUT []:</a></b>
https://<your_instance_name>/api/coupa_pay/payments/<ID>
-
<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) | ドラフト、承認済み、支払開始済み、payment_in_progress、completed_successfully、completed_with_errors | はい | string型 | |||||||||||||||||||||
exported |
品目は以前に第三者システムにエクスポートされましたか?統合によって新しい値を見つけるために使用されます。 |
true、false | はい | ブール値 | |||||||||||||||||||||
最終エクスポート日時 | YYYY-MM-DDTHH:MM:SS + HH:MMZ形式のタイムスタンプ | 日時 | |||||||||||||||||||||||
支払バッチID | 支払バッチ識別子 請求書Coupa ID インボイス番号 合計金額 通貨 アカウント詳細から支払う アカウントの詳細に支払う |
整数 | |||||||||||||||||||||||
支払元合計 | decimal型 | ||||||||||||||||||||||||
支払合計 | decimal型 | ||||||||||||||||||||||||
合計支払元レポート | decimal型 | ||||||||||||||||||||||||
支払合計に対するレポート | |||||||||||||||||||||||||
exchange-rate | |||||||||||||||||||||||||
エラーテキスト | string型 | ||||||||||||||||||||||||
支払詳細 | 主要なデータ要素
|
支払詳細配列 | |||||||||||||||||||||||
アカウントから支払う | 勘定科目 | ||||||||||||||||||||||||
支払先アカウント | 勘定科目 | ||||||||||||||||||||||||
支払元通貨 | |||||||||||||||||||||||||
支払先通貨 | |||||||||||||||||||||||||
報告通貨 | |||||||||||||||||||||||||
受取人 | サプライヤー配列 | ||||||||||||||||||||||||
支払バッチ | 支払バッチ配列 | ||||||||||||||||||||||||
created_by | 作成したユーザー | はい | ユーザー | ||||||||||||||||||||||
updated_by | 更新したユーザー | はい | ユーザー |