Bank accounts

View BankAccounts endpoints in Swagger.

Overview

A list of bank accounts associated with a company and a specific data connection.

Bank accounts data includes:

  • The name and ID of the account in the accounting platform.
  • The currency and balance of the account.
  • The sort code and account number.

Data model

Field

Type

Description

id

string

Identifier for the account, unique for the company in the accounting platform.

accountName

string

Name of the bank account in the accounting platform.

nominalCode

string

Code used to identify each nominal account for a business.

sortCode

string

Sort code for the bank account.

Xero integrations
The sort code is only displayed when the currency = GBP and the sort code and account number sum to 14 digits. For non-GBP accounts, this field is not populated.

accountNumber

string

Account number for the bank account.

Xero integrations
Only a UK account number shows for bank accounts with GBP currency and a combined total of sort code and account number that equals 14 digits, For non-GBP accounts, the full bank account number is populated.

iBan

string

International bank account number of the account. Often used when making or receiving international payments.

currency

string
See currency

Base currency of the bank account.

balance

decimal

Balance of the bank account.

availableBalance

decimal

Total available balance of the bank account as reported by the underlying data source. This may take into account overdrafts or pending transactions for example.

overdraftLimit

decimal

Pre-arranged overdraft limit of the account.

The value is always positive. For example, an overdraftLimit of 1000 means that the balance of the account can go down to -1000.

modifiedDate

string
See date

Date the record was last updated in the Codat system.

sourceModifiedDate

string
See date

Date the record was last changed in the accounting system.

Example data

[
  {
    "id": "1234",
    "accountName": "ABC Current Account",
    "sortCode": "00-11-22",
    "accountNumber": "12345678",
    "iban": "GB29 NWBK 6016 1331 9268 19",
    "currency": "GBP",
    "balance": 2573.20,
    "availableBalance": 2573.20,
    "overdraftLimit": 1000,
    "modifiedDate": "2019-03-26T16:25:08.384Z",
    "sourceModifiedDate": "2019-03-26T16:25:08.384Z"
  },
  {
    "id": "1235",
    "accountName": "Business Savings Account",
    "sortCode": "11-23-58",
    "accountNumber": "24681379",
    "iban": "GB89 3704 0044 0532 0130 00",
    "currency": "GBP",
    "balance": 1500.32,
    "availableBalance": 1500.32,
    "modifiedDate": "2019-03-26T16:25:08.384Z",
    "sourceModifiedDate": "2019-03-26T16:25:08.384Z"
  }
]

Did this page help you?