Table of Contents
Bank Transfers
Methods supported: POST, PUT, GET, DELETE
The BookID represents the unique GUID of the Book the user wants to write data to, retrieved from GET Books endpoint. For example c1b3da90-e9df-4d57-8cfb-71a1d7bfe401
Reckon One Module | Endpoint | Additional Parameter(s) | HTTP Method | Request URL | Description | API Portal | Countries |
Core | Bank Transfers |
| POST | Create a bank transfer transaction | AU/NZ/UK | ||
Core | Bank Transfers |
| PUT | Update a bank transfer transaction | AU/NZ/UK | ||
Core | Bank Transfers |
| GET | Get a bank transfer transaction by ID | AU/NZ/UK | ||
Core | Bank Transfers |
| GET | Get a list of bank transfer transactions | AU/NZ/UK | ||
Core | Bank Transfers |
| DELETE | Delete a bank transfer transaction | AU/NZ/UK |
Sample
Sample POST
The below example will create a new bank transfer transaction and set the reconciliation status as "UNCLEARED" in Reckon One.
Method: POST
{
"TransferDate": "2018-09-25",
"Description": "Transfer of funds",
"FromBankAccountId": "4cd7c12f-1931-4938-a739-1fe758fbd633",
"FromReconciliationStatus": 0,
"ToBankAccountId": "128be71d-2997-49e8-84a2-3f63e4542792",
"ToReconciliationStatus": 0,
"Amount": 200.00
}Sample Response:
{"cbca4e2b-be61-4318-88c1-d452f28ecd25"}
Sample PUT
The below example will update an existing bank transfer transaction and change the amount from 200 to 300.
Method: PUT
{
"TransferDate": "2018-09-25",
"Description": "Transfer of funds",
"FromBankAccountId": "4cd7c12f-1931-4938-a739-1fe758fbd633",
"FromReconciliationStatus": 0,
"ToBankAccountId": "128be71d-2997-49e8-84a2-3f63e4542792",
"ToReconciliationStatus": 0,
"Amount": 300.00
}Sample Delete
The below example will delete an existing bank transfer transaction.
Method: DELETE
Request URL: https://api.reckon.com/R1/624fee50-ba4c-4d5b-a5af-d6d6f995b1d6/banktransfers/014c6a8b-f9d2-4a6b-bb56-1d83f132d167
Details of each object
Data Field | Description | Data Type | Mandatory? |
TransferDate | Date of the bank transfer transaction | UTC (yyyy-mm-dd) | Yes |
Description | Description of the Bank transfer | Alphanumeric | No |
FromBankAccountId | Unique ID of the Bank Account retrieved from Bank Accounts endpoint, NOT from Chart of Accounts endpoint | GUID | Yes |
FromReconciliationStatus | Set the Reconciliation status of the transfer transaction of the "Transfer from" Bank account | 0 - Uncleared 1 - Cleared 2 - Reconcilied (can be used for PUT only where the transaction is already reconciled in Reckon One. You can't set it as reconciled via API | No |
ToBankAccountId | Unique ID of the Bank Account retrieved from Bank Accounts endpoint, NOT from Chart of Accounts endpoint | GUID | Yes |
ToReconciliationStatus | Set the Reconciliation status of the transaction of the "Transfer to" Bank account | 0 - Uncleared 1 - Cleared 2 - Reconcilied (can be used for PUT only where the transaction is already reconciled in Reckon One. You can't set it as reconciled via API | No |
Amount | Total amount of the transfer | Numeric | No |
TransferId | The GUID of a bank transfer transaction. You will get the ID as the response after you successfully post a new bank transfer or when GET a list of bank transfer transactions | GUID | Yes |
Reckon One UI:
