Bank file details

Bank file details provide detailed information about a bank file payment transaction, such as payment details and bank file errors.

List bank file details

get/objects/cash-management/bank-file-detail

Returns a collection with a key, ID, and link for each bank file detail object. This operation is mostly for use in testing; use the query service to find objects that meet certain criteria and to specify properties that are returned.

SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples 
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "152",
      • "id": "152",
      • "href": "/objects/cash-management/bank-file-detail/152"
      },
    • {
      • "key": "147",
      • "id": "147",
      • "href": "/objects/cash-management/bank-file-detail/147"
      },
    • {
      • "key": "213",
      • "id": "213",
      • "href": "/objects/cash-management/bank-file-detail/213"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100,
    • "next": 0,
    • "previous": 0
    }
}
Get a bank file detail
get/objects/cash-management/bank-file-detail/{key}
Returns detailed information for a specified bank file detail object.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique key for the bank file details.


 
 Example:  134
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "key": "792",
    • "id": "792",
    • "amount": "1200.00",
    • "description": "Bank file payment FOR INVOICE 02387429",
    • "audit": {
      • "createdDateTime": "2025-03-27T16:24:18Z",
      • "modifiedDateTime": "2025-03-27T16:24:18Z",
      • "createdByUser": {
        },
      • "createdBy": "159",
      • "modifiedByUser": {
        },
      • "modifiedBy": "159"
      },
    • "paymentId": "1579",
    • "payee": {
      • "key": "2107",
      • "id": "TECHSOL",
      • "name": "Tech Solutions",
      • "href": "/objects/accounts-payable/vendor/2107"
      },
    • "bankFile": {
      • "key": "13",
      • "id": "13",
      • "href": "/objects/cash-management/bank-file/13"
      },
    • "bankFileErrors": [
      • "{Field Name : payments.debtorAgent.identification, Error : must contain 6 numbers and no spaces.}",
      • "{Field Name : payments.creditorAgent.identification, Error : must contain 6 numbers.}"
      ],
    • "href": "/objects/cash-management/bank-file-detail/792"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}