Transfers
Explore the Transfers endpoints in Swagger.
Overview
Transfers are used to record the movement of money between two bank accounts
or between a bank account and a nominal account.
From the Transfers endpoints, you can:
- Retrieve a list of all transfers for a specified company
- Retrieve a single transfer for a specified company
- Add a new transfer for a specified company
Transfers is a child data type of account transactions.
Data model
Field | Type | Description |
---|---|---|
id | string | Unique identifier for the transfer. |
description | string | Description of the transfer. |
contactRef | The customer or supplier for the transfer, if available. | |
date | string | The day on which the transfer was made. |
from / to | The details of the accounts the transfer is moving from or to. | |
trackingCategoryRefs | Reference to the tracking categories this transfer is being tracked against. | |
modifiedDate | string | Date the record was last updated in the Codat system. |
sourceModifiedDate | string | Date the record was last changed in the accounting system. |
Transfer account details
accountRef | The account that the transfer is moving from or to. | |
---|---|---|
currency | string | ISO currency code recorded for the transfer in the accounting platform. |
amount | decimal | The amount transferred between accounts. |
[
{
"id": "f155f8fa-2b19-4105-842b-d21880321ecb",
"description": "Bank transfer from business account",
"contactRef": {
"id": "ddcf351f-c931-46fb-b6d9-e53cbf238847",
"dataType": "customers"
},
"date": "2021-06-02T00:00:00",
"from": {
"accountRef": {
"id": "1d1dfe84-0199-45cc-8f36-d5f4ddf586d6",
"dataType": "bankAccounts"
},
"currency": "GBP",
"amount": 50.0
},
"to": {
"accountRef": {
"id": "9ea60f8f-bd49-44ca-ac8a-e1da21ee0570",
"dataType": "bankAccounts"
},
"currency": "GBP",
"amount": 50.0
},
"trackingCategoryRefs": [{
"id": "0a549dde-8326-4978-94dd-feb4620beb3f",
"name": "region"
},
{
"id": "2d55b500-fbc4-4109-9e5f-d86e302b4046",
"name": "expenses"
}
],
"modifiedDate": "2021-06-02T10:45:42"
},
{
"id": "db3586e1-3549-4d09-93ac-707548da7514",
"description": "Bank transfer from european bank account",
"contactRef": {
"id": "eabc09f1-508d-4831-9e5d-e77623a7955d",
"dataType": "suppliers"
},
"date": "2021-06-02T00:00:00",
"from": {
"accountRef": {
"id": "1a6d0b6c-c6de-49e2-957a-ae6721009a64",
"dataType": "bankAccounts"
},
"currency": "EUR",
"amount": 25.0
},
"to": {
"accountRef": {
"id": "09a85c62-e889-4141-91e9-c7b9d97a5e2e",
"dataType": "bankAccounts"
},
"currency": "GBP",
"amount": 20.0
},
"trackingCategoryRefs": [{
"id": "2d55b500-fbc4-4109-9e5f-d86e302b4046",
"name": "expenses"
}],
"modifiedDate": "2021-06-02T10:45:42"
}
]
.
Updated 6 months ago