Coupa PayステートメントAPI (/ coupa_pay/statements)

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

概要

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

明細書が会計またはERP支払いのためにエクスポートされると、その明細書はPUTコールを使用してエクスポートされたものとしてマークされる必要があります。そのため、2回目の取得は行われません。  

サポートされているAPIオペレーション:

  • 取得 
  • 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はhttps ://{ your_instance_name }/ api/coupa_pay/statements<ID> /? exported = trueまたは

  • APIはhttps ://{ your_instance_name }/ api/coupa_pay/statements/を次のようなペイロード<ID>で設定しました。

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

要素

iD 一意の識別子(読み取り専用)   はい     はい 整数
created - at CoupaがYY - MM - DDTHH: MM: SS + HH: MMZの形式で自動的に作成しました(読み取り専用)         はい

string ($ datetime)

updated - at CoupaがYY - MM - DDTHH: MM: SS + HH: MMZの形式で自動的に作成しました(読み取り専用)         はい string ($ datetime)
external - ref - id 外部参照識別子 はい       はい string (255)
coupa - pay - id           はい 整数
名前 名前           string (255)
金額 この割り当てのドル金額         はい 小数( 30,2 )
statement - date 次の形式の受領タイムスタンプ:YYYY - MM - DDTHH: MM: SS + HH: MMZ はい       はい string ($ datetime)
number - of - lines (読み取り専用)         はい 整数
合計 すべてのステートメント行の合計(読み取り専用)         はい 小数( 16,10 )
last - exported - at timestamp           string ($ datetime)
exported True/Falseは外部レコードシステムに送信されたステートメントです。(読み取り専用)         はい boolean
payment - partner Coupa Pay -バーチャルカードパートナー             
通貨 通貨 はい       はい
created - by 作成したユーザー         はい
更新者: 更新したユーザー         はい

関連アイテム


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エンドポイントを整理しました。