latestOpenAPI 3.0.02026-08-10233809957.8 KB
5cdfae3fa1fa
Bank Transfers
Gets the latest bank transfers for a business.
get/bankTransfers
Query parameters
businessNamestring required
Unique business name identifier.
serviceName'xero' | 'sageBusinessCloud' | 'myob' | 'zohoBooks' required
Name of accounting service provider.
startDatestring
The start date of the Transaction report frequency in the format: YYYY-MM-DD.
endDatestring
The end date of the Transaction report frequency in the format: YYYY-MM-DD.
offsetnumber
The offset is the position in the dataset of a particular record.
limitnumber
This is the size of the results set you would like (default: 100).
orderBystring
Response
Example response
{
"meta": {
"reportId": [
"5fad8a342a88364234392fb5",
"5fad8a342a88364234392fb6"
],
"serviceName": "xero",
"businessName": "Railz",
"startDate": "2020-11-25T01:02:03Z",
"endDate": "2020-11-30T01:02:03Z",
"createdAt": "2020-11-25T01:02:03Z",
"updatedAt": "2020-11-30T01:02:03Z"
},
"count": 1,
"data": [
{
"id": "123",
"date": "2021-03-09T10:18:29.985Z",
"currencyRate": 1.13,
"totalAmount": 1000.5,
"fromAccountRef": {
"id": "1233455",
"name": "Business Savings Account"
},
"toAccountRef": {
"id": "327623",
"name": "Business Bank Account"
},
"fromBankTransactionId": "b11794bc",
"toBankTransactionId": "b11794cd",
"memo": "Reference to bank transfer.",
"sourceModifiedDate": "2021-03-09T10:18:29.985Z",
"currencyRef": {
"id": "CAD",
"name": "Canadian Dollar",
"symbol": "USD,CAD"
}
}
]
}