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 = true OR
  • APIは、次のようなペイロードを持つ https :// {your_instance_name}/ api/coupa_pay/statements/<ID> を置きます。
    • <statement><exported>true</exported></statement>

Elements

フィールド名フィールドの説明必須フィールド?一意許容値Api_Inフィールド?Api_Outフィールド?データタイプ
ID一意の識別子(読み取り専用)はいyes&#10;整数
作成日時CoupaがYYY-MM-DDTHH:MM:SS+HH:MMZの形式で自動的に作成(読み取り専用)yes&#10;string($datetime)
updated-atCoupaがYYY-MM-DDTHH:MM:SS+HH:MMZの形式で自動的に作成(読み取り専用)yes&#10;string($datetime)
external-ref-id外部参照識別子はいyes&#10;string(255)
coupa-pay-idyes&#10;整数
名前Name (名前)string(255)
金額この割当のドル金額yes&#10;decimal(30,2)
statement-date領収書のタイムスタンプの形式: YYYY-MM-DDTHH:MM:SS+HH:MMZはいyes&#10;string($datetime)
number-of-lines(読み取り専用)はい整数
totalすべての明細書明細の合計(読み取り専用)はいdecimal(16,10)
last-exported-atタイムスタンプstring($datetime)
exportedTrue/Falseは、外部の記録システムに送信されたステートメントです。 (読み取り専用)はいboolean
payment-partnerCoupa Pay - バーチャルカードパートナー
currencyCurrencyyes&#10;yes&#10;Currency
created-by作成したユーザーyes&#10;ユーザー
updated-by更新したユーザーyes&#10;ユーザー