lianja / Coupa Postman Collection - OAuth - Master / Get All Payments in a specific Invoice Payment Batch by Payment Batch ID
Back to Collection Items
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loHttp = createobject("CkHttp")
loQueryParams = createobject("CkJsonObject")
loQueryParams.UpdateInt("payment-batch-id",2873)
loQueryParams.UpdateString("pay_to_account[type]","CoupaPay::SupplierPaymentAccount")
loQueryParams.UpdateString("fields",'["id","payment-batch-id","status","exchange_rate","updated_at","released_at",{"pay_from_account":["id",{"currency":["code"]}]},{"pay_to_currency":["code"]},{"payee":["number"]},{"digital_check":["check_number"]},{"payment_details":["id","released_at","source_transaction_id","source_transaction_reference","discount_total","payment_total",{"payable_allocations":["id","updated_at","payable_to_amount","source_transaction_to_reference","source_transaction_to_id"]},{"currency":["code"]}]}]')
// Adds the "Authorization: Bearer <access_token>" header.
loHttp.AuthToken = "<access_token>"
loResp = loHttp.QuickRequestParams("GET","https://domain.com/coupa_pay/payments",loQueryParams)
if (loHttp.LastMethodSuccess = .F.) then
? loHttp.LastErrorText
release loHttp
release loQueryParams
return
endif
? str(loResp.StatusCode)
? loResp.BodyStr
release loResp
release loHttp
release loQueryParams
Curl Command
curl -G -d "payment-batch-id=2873"
-d "pay_to_account[type]=CoupaPay%3A%3ASupplierPaymentAccount"
-d "fields=%5B%22id%22,%22payment-batch-id%22,%22status%22,%22exchange_rate%22,%22updated_at%22,%22released_at%22,%7B%22pay_from_account%22%3A%5B%22id%22,%7B%22currency%22%3A%5B%22code%22%5D%7D%5D%7D,%7B%22pay_to_currency%22%3A%5B%22code%22%5D%7D,%7B%22payee%22%3A%5B%22number%22%5D%7D,%7B%22digital_check%22%3A%5B%22check_number%22%5D%7D,%7B%22payment_details%22%3A%5B%22id%22,%22released_at%22,%22source_transaction_id%22,%22source_transaction_reference%22,%22discount_total%22,%22payment_total%22,%7B%22payable_allocations%22%3A%5B%22id%22,%22updated_at%22,%22payable_to_amount%22,%22source_transaction_to_reference%22,%22source_transaction_to_id%22%5D%7D,%7B%22currency%22%3A%5B%22code%22%5D%7D%5D%7D%5D"
-H "Authorization: Bearer <access_token>"
https://domain.com/coupa_pay/payments
Postman Collection Item JSON
{
"name": "Get All Payments in a specific Invoice Payment Batch by Payment Batch ID",
"request": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{URL}}/coupa_pay/payments?payment-batch-id=2873&pay_to_account[type]=CoupaPay::SupplierPaymentAccount&fields=[\"id\",\"payment-batch-id\",\"status\",\"exchange_rate\",\"updated_at\",\"released_at\",{\"pay_from_account\":[\"id\",{\"currency\":[\"code\"]}]},{\"pay_to_currency\":[\"code\"]},{\"payee\":[\"number\"]},{\"digital_check\":[\"check_number\"]},{\"payment_details\":[\"id\",\"released_at\",\"source_transaction_id\",\"source_transaction_reference\",\"discount_total\",\"payment_total\",{\"payable_allocations\":[\"id\",\"updated_at\",\"payable_to_amount\",\"source_transaction_to_reference\",\"source_transaction_to_id\"]},{\"currency\":[\"code\"]}]}]",
"host": [
"{{URL}}"
],
"path": [
"coupa_pay",
"payments"
],
"query": [
{
"key": "payment-batch-id",
"value": "2873"
},
{
"key": "pay_to_account[type]",
"value": "CoupaPay::SupplierPaymentAccount"
},
{
"key": "fields",
"value": "[\"id\",\"payment-batch-id\",\"status\",\"exchange_rate\",\"updated_at\",\"released_at\",{\"pay_from_account\":[\"id\",{\"currency\":[\"code\"]}]},{\"pay_to_currency\":[\"code\"]},{\"payee\":[\"number\"]},{\"digital_check\":[\"check_number\"]},{\"payment_details\":[\"id\",\"released_at\",\"source_transaction_id\",\"source_transaction_reference\",\"discount_total\",\"payment_total\",{\"payable_allocations\":[\"id\",\"updated_at\",\"payable_to_amount\",\"source_transaction_to_reference\",\"source_transaction_to_id\"]},{\"currency\":[\"code\"]}]}]"
}
]
}
},
"response": [
]
}