Coupa Pay明細API (/coupa_pay/statements)
概要
支払いが承認されたステータスを持つ法人カード支払いパートナーの明細書は、明細書APIエンドポイントに送信されたGETリクエストを使用して、CoupaからERPに取得できます。 https ://{your_instance_name}/api/coupa_pay/statements
会計またはERP支払のために明細書がエクスポートされると、その明細書はPUTコールを使用してエクスポート済みとしてマークされる必要があるため、2回目の取得は行われません。
サポートされているAPI操作:
- GET
- PUT (エクスポート済みとしてマークするためのみ)
データの取得/更新に使用されるAPIキーには、Api/Coupa_Pay/明細データのインデックス作成、表示、更新の権限が必要です。
明細データは、ペイロード内のすべてのフィールドで検索できます。 一般的な検索パラメーターは次のとおりです。
- ? exported = false
- ? payment - partner [issuing - bank] = <Bank_Name
- ?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 = trueOR - APIは、次のようなペイロードを持つ
https :// {your_instance_name}/ api/coupa_pay/statements/<ID>を置きます。<statement><exported>true</exported></statement>
Elements
| フィールド名 | フィールドの説明 | 必須フィールド? | 一意 | 許容値 | Api_Inフィールド? | Api_Outフィールド? | データタイプ |
|---|---|---|---|---|---|---|---|
| ID | 一意の識別子(読み取り専用) | はい | yes | 整数 | |||
| 作成日時 | CoupaがYYY-MM-DDTHH:MM:SS+HH:MMZの形式で自動的に作成(読み取り専用) | yes | string($datetime) | ||||
| updated-at | CoupaがYYY-MM-DDTHH:MM:SS+HH:MMZの形式で自動的に作成(読み取り専用) | yes | string($datetime) | ||||
| external-ref-id | 外部参照識別子 | はい | yes | string(255) | |||
| coupa-pay-id | yes | 整数 | |||||
| 名前 | Name (名前) | string(255) | |||||
| 金額 | この割当のドル金額 | yes | decimal(30,2) | ||||
| statement-date | 領収書のタイムスタンプの形式: YYYY-MM-DDTHH:MM:SS+HH:MMZ | はい | yes | string($datetime) | |||
| number-of-lines | (読み取り専用) | はい | 整数 | ||||
| total | すべての明細書明細の合計(読み取り専用) | はい | decimal(16,10) | ||||
| last-exported-at | タイムスタンプ | string($datetime) | |||||
| exported | True/Falseは、外部の記録システムに送信されたステートメントです。 (読み取り専用) | はい | boolean | ||||
| payment-partner | Coupa Pay - バーチャルカードパートナー | ||||||
| currency | Currency | yes | yes | Currency | |||
| created-by | 作成したユーザー | yes | ユーザー | ||||
| updated-by | 更新したユーザー | yes | ユーザー |