Coupa Pay明細書API (/coupa_pay/statements)

支払パートナーからの明細書はAPI GET呼び出しで取得でき、PUT呼び出しでその明細書をエクスポート済みとしてマークできます。

概要

ステータスが支払承認済みの法人カード支払パートナーの明細書は、明細書APIエンドポイントに送信されたGETリクエストを使用して、CoupaからERPに取得できます。 https://{your_instance_name}/api/coupa_pay/statements 

会計またはERP支払のために明細書がエクスポートされたら、その明細書は2回目の取得を行わないように、PUT呼び出しを使用してエクスポート済みとしてマークする必要があります。  

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

  • 取得 
  • PUT(エクスポート済みをマークする場合のみ)

データのフェッチ/更新に使用するAPIキーには、Api/Coupa_Pay/ステートメントデータのインデックス作成、表示、更新の権限が必要です。

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

  • ?exported=false
  • ?payment-partner[issuing-bank]=<Bank_Name>
  • ?status=approved_for_payment(ステータスがペイロードの応答にありません)

これらのクエリパラメーターは、次のようなステートメントに結合できます。

  • API取得 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

  • 次のような https://{your_instance_name}/api/coupa_pay/statements/<ID>ペイロードを持つAPI PUT:

    • <statement><exported>true</exported></statement>

要素

id 一意の識別子(読み取り専用)   はい     はい 整数
created-at CoupaによってYYYY-MM-DDTHH:MM:SS+HH:MMZの形式で自動作成(読み取り専用)         はい

文字列($datetime)

updated-at CoupaによってYYYY-MM-DDTHH:MM:SS+HH:MMZの形式で自動作成(読み取り専用)         はい 文字列($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)
last-exported-at タイムスタンプ           文字列($datetime)
exported True / Falseは、外部の記録システムに送信されたステートメントです。(読み取り専用)         はい ブール値
支払パートナー Coupa Pay – バーチャルカードパートナー             
currency 通貨 はい       はい
作成者 作成したユーザー         はい
更新者 更新したユーザー         はい

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

関連アイテム


Coupa Core API

CoupaのRESTful APIは、お客様のデータをCoupaプラットフォームで読み取り、編集し、統合するための堅牢なアクセスを提供します。

APIの開始

Coupa APIの使用に関する一般情報、およびCSVの使用を検討するタイミング。

OAuth 2.0およびOIDCへの移行

Coupaは従来のAPIキーを廃止し、OAuth 2.0 / OIDCの使用を必要としています。R34以降、新しいAPIキーは発行されず、R35ではAPIキーはサポートされなくなります。

リソース

参照データ、トランザクションデータ、共有リソースなど、オブジェクトのタイプ別にAPIエンドポイントを整理しました。