Banking transactions

📘

Changes to bank accounts and bank transactions

The Codat data types for bank accounts and bank transactions are going to change. Currently both data types are used for both accounting and banking integrations. In future, these will be separated as follows: accounting packages will use bankAccounts and accountTransactions and banking sources will use banking-accounts and banking-transactions.

The Banking Transactions data type provides an immutable source of up-to-date information on income and expenditure.

Explore the Banking Transactions endpoint in Swagger.

Overview

From the Banking Transactions endpoint, you can retrieve a list of all bank account transactions:
GET /companies/{companyId}/connections/{connectionId}/data/banking-transactions

Responses are paged, so you should provide page and pageSize query parameters in your request. See Pagination for details.

Data model

Field

Type

Description

id

string

The unique identifier of the bank transaction.

accountId

string

The unique identifier of the bank account.

description

string

The description of the bank transaction.

amount

decimal

The amount of the bank transaction.

currency

string

The currency of the bank transaction.

postedDate

date
See Date

YYYY-MM-DDT00:00:00Z

The date the bank transaction was cleared.

authorizedDate

date
See Date

YYYY-MM-DDT00:00:00Z

The date the bank transaction was authorized.

merchantName

string

The name of the merchant.

transactionCategoryRef

See Transaction category reference

An object of bank transaction category reference data.

modifiedDate

date
See Date

YYYY-MM-DDT00:00:00Z

sourceModifiedDate

date
See Date

YYYY-MM-DDT00:00:00Z

The update timestamp if available. Date from Codat cache.

Transaction category reference

Field

Type

Description

id

string

The unique category reference id for the bank transaction.

name

string

The category name reference for the bank transaction.

Example data

{
      "id": "0130b5bb-1419-40f6-8a27-7362d0381229",
      "accountId": "1703194f-7805-4da8-bac0-2ba5da4a4216",
      "description": "Payments for direct income ce149943-c157-43fc-aac7-42a716b655b6",
      "amount": 5062.39,
      "currency": "GBP",
      "postedDate": "2021-07-06T00:00:00",
      "authorizedDate": "2021-07-06T00:00:00",
      "merchantName": "New Look",
      "transactionCategoryRef": {
        "id": "health-and-fitness-sports"
      },
      "modifiedDate": "2022-05-23T16:32:50Z",
      "sourceModifiedDate": "2021-06-28T10:48:12"
    },
    {
      "id": "014a36ad-9694-4f02-9632-52889862d85a",
      "accountId": "1703194f-7805-4da8-bac0-2ba5da4a4216",
      "description": "Payment to supplier 0o31BcAHVh",
      "amount": -9051.15,
      "currency": "GBP",
      "postedDate": "2021-10-17T00:00:00",
      "authorizedDate": "2021-10-17T00:00:00",
      "merchantName": "IKEA",
      "transactionCategoryRef": {
        "id": "personal-care-laundry"
      },
      "modifiedDate": "2022-05-23T16:32:50Z",
      "sourceModifiedDate": "2022-05-01T05:43:12"
    }

Did this page help you?