Coupa Pay Statements API (/coupa_pay/statements)

Overview

Corporate card payment partner statements that have a status of approved for payment may be retrieved from Coupa to the ERP using a GET request sent to the Statements API endpoint: https://{your_instance_name}/api/coupa_pay/statements

Once a statement is exported for accounting or ERP payment, that statement should be marked as exported using the PUT call, so it is not retrieved a second time.

API Operations supported:

• GET
• PUT(only to mark exported)

The API key used to fetch/update data must have permission to index, show, and update Api/Coupa_Pay/Statements data.

Statement data can be queried by all fields within the payload. Typical query parameters are:

• ?exported=false
• ?payment-partner[issuing-bank]=<Bank_Name>
• ?status=approved_for_payment (status is not in the payload response)

These query parameters can be combined into a statement like the following:

• API GET https://{ your_instance_name }/api/coupa_pay/statements?status=approved_for_payment&exported=false&payment-partner[issuing-bank]= XYZBank
  • This will return statements for XYZBank Issuer Payment Partner that are approved but not exported.
  • For ERP payments you should only pull approved statements from Coupa to the ERP.

An exported statement should be marked as exported once it is fetched successfully. You can do that with a call like the following:

• API PUT https://{ your_instance_name }/api/coupa_pay/statements/<ID>?exported=true OR
• API PUT https://{ your_instance_name }/api/coupa_pay/statements/<ID> with a payload like:
  • <statement><exported>true</exported></statement>

Elements