📘
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.

Explore the Banking Transaction Categories endpoint in Swagger.

Overview

The Banking Transaction Categories data type provides a list of hierarchical categories associated with a transaction for greater contextual meaning to transaction activity.

From the Banking Transaction Categories endpoint, you can retrieve:

A list of all banking transaction categories:
GET /companies/{companyId}/connections/{connectionId}/data/banking-transactionCategories
Details of a single banking transaction category under a specific category ID:
GET /companies/{companyId}/connections/{connectionId}/data/banking-transactionCategories/{transactionCategoryId}

Note that in this endpoint example, auto-and-transport is a transaction category.

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 category.
name	string	The name of the bank transaction category.
parentId	string	The unique identifier of the parent bank transaction category.
hasChildren	boolean	A Boolean indicating whether there are other bank transaction categories beneath this one in the hierarchy.
status	string	Status of the bank transaction category, i.e. "active", "archived", "unknown".
modifiedDate	string See Date	YYYY-MM-DDT00:00:00Z
sourceModifiedDate	string See Date	YYYY-MM-DDT00:00:00Z The update timestamp if available. Date from Codat cache.
subcategories	array See Transaction category for a specific ID	Only returned for banking transaction category for a specific category id endpoint. A collection of subcategories that are nested beneath this category.

Example data for transaction categories

{
    "transactionCategories": [
        {
            "id": "uncategorized",
            "name": "Uncategorized",
            "hasChildren": true,
            "status": "Active",
            "sourceModifiedDate": "2021-09-13T11:14:31"
        },
        {
            "id": "uncategorized-cash-atm",
            "name": "Cash & ATM",
            "parentId": "uncategorized",
            "hasChildren": false,
            "status": "Active",
            "sourceModifiedDate": "2021-02-22T07:01:31"
        },
        {
            "id": "uncategorized-check",
            "name": "Check",
            "parentId": "uncategorized",
            "hasChildren": false,
            "status": "Active",
            "sourceModifiedDate": "2021-08-26T03:47:31"
        },
        {
            "id": "taxes-uk-inhertance-tax",
            "name": "Inhertance Tax",
            "parentId": "taxes",
            "hasChildren": false,
            "status": "Active",
            "sourceModifiedDate": "2021-02-05T01:34:31"
        },
        {
            "id": "taxes-uk-vat",
            "name": "Value Added Tax (VAT)",
            "parentId": "taxes",
            "hasChildren": false,
            "status": "Active",
            "sourceModifiedDate": "2021-08-29T13:07:31"
        }
    ]
}

Example data for transaction category for a specific category ID

{
    "id": "entertainment",
    "name": "Entertainment",
    "hasChildren": true,
    "status": "Active",
    "modifiedDate": "2022-03-23T16:12:28Z",
    "sourceModifiedDate": "2020-11-13T10:41:31",
    "subcategories": [
        {
            "id": "entertainment-arts",
            "name": "Arts",
            "parentId": "entertainment",
            "hasChildren": false,
            "status": "Active",
            "modifiedDate": "2022-03-23T16:12:28",
            "sourceModifiedDate": "2020-11-17T22:50:31",
            "subcategories": []
        },
        {
            "id": "entertainment-dating",
            "name": "Dating",
            "parentId": "entertainment",
            "hasChildren": false,
            "status": "Active",
            "modifiedDate": "2022-03-23T16:12:28",
            "sourceModifiedDate": "2021-10-22T07:32:31",
            "subcategories": []
        },
        {
            "id": "entertainment-games",
            "name": "Games",
            "parentId": "entertainment",
            "hasChildren": false,
            "status": "Active",
            "modifiedDate": "2022-03-23T16:12:28",
            "sourceModifiedDate": "2021-09-24T09:57:31",
            "subcategories": []
        },
        {
            "id": "entertainment-newspaper-and-magazines",
            "name": "Newspaper & Magazines",
            "parentId": "entertainment",
            "hasChildren": false,
            "status": "Active",
            "modifiedDate": "2022-03-23T16:12:28",
            "sourceModifiedDate": "2021-07-19T20:13:31",
            "subcategories": []
        },
        {
            "id": "entertainment-social-club",
            "name": "Social Club",
            "parentId": "entertainment",
            "hasChildren": false,
            "status": "Active",
            "modifiedDate": "2022-03-23T16:12:28",
            "sourceModifiedDate": "2021-03-14T03:48:31",
            "subcategories": []
        },
        {
            "id": "entertainment-sport",
            "name": "Sport",
            "parentId": "entertainment",
            "hasChildren": false,
            "status": "Active",
            "modifiedDate": "2022-03-23T16:12:28",
            "sourceModifiedDate": "2021-11-15T07:27:31",
            "subcategories": []
        }
    ]
}

Banking transaction categories

📘
Changes to bank accounts and bank transactions

Overview

Data model

Example data for transaction categories

Example data for transaction category for a specific category ID

📘Changes to bank accounts and bank transactions

Overview

Data model

Example data for transaction categories

Example data for transaction category for a specific category ID

📘
Changes to bank accounts and bank transactions