Explore Accounts endpoints in Swagger.

Overview

Accounts are the categories a business uses to record accounting transactions. From the Accounts endpoints, you can retrieve a list of all accounts for a specified company.

The categories for an account include:

Asset
Expense
Income
Liability
Equity.

📘
Accounts with no category
If an account is pulled from the chart of accounts and its nominal code does not lie within the category layout for the company's accounts, then the type is Unknown. The fullyQualifiedCategory and fullyQualifiedName fields return null.
This approach gives a true representation of the company's accounts whilst preventing distorting financials such as a company's profit and loss and balance sheet reports.

Data model

👍
Filtering bank accounts
Use the isBankAccount boolean to filter the company's accounts to show only bank accounts.

Field	Type	Description
id	string	Identifier for the account, unique for the company.
nominalCode	string	Reference given to each nominal account for a business. It ensures money is allocated to the correct account. This code isn't a unique identifier in the Codat system.
name	string	Name of the account.
description	string	Description for the account.
fullyQualifiedCategory	string	Full category of the account. For example: Liability.Current or Income.Revenue. See example data.
fullyQualifiedName	string	Full name of the account, for example: `Liability.Current.VAT` `Income.Revenue.Sales`
currency	string See currency	Currency of the account.
currentBalance	decimal	Current balance in the account.
type	string	Type of account, either: `Unknown` `Asset` `Expense` `Income` `Liability` `Equity`
status	string	Status of the account, either: `Unknown` `Active` `Archived` `Pending`
isBankAccount	boolean	Confirms whether the account is a bank account or not.
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.

Account reference

Data types that reference an account, for example bill and invoice line items, use an accountRef that includes the ID and name of the linked account.

Field	Type	Description
id	string	Unique identifier for the account in the accounting platform.
name	string	Name of the account in the accounting platform.

Example data

{
    "accounts": [
        {
        "id": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4",
        "nominalCode": "090",
        "name": "Business Bank Account",
        "description": "1st Account for core transactions",  
        "fullyQualifiedCategory": "Asset.Bank",
        "fullyQualifiedName": "Asset.Bank.Business Bank Account",
        "currency": "GBP",
        "currentBalance": null,
        "type": "Asset",
        "status": "Active",
        "isBankAccount": true,
        "modifiedDate": null,
        "sourceModifiedDate": null
      },
      {
        "id": "16503499-9215-4a45-9839-b0fed8269304",
        "nominalCode": "610",
        "name": "Accounts Receivable",
        "fullyQualifiedCategory": "Asset.Current",
        "fullyQualifiedName": "Asset.Current.Accounts Receivable",
        "currency": "USD",
        "currentBalance": null,
        "type": "Asset",
        "status": "Active",
        "isBankAccount": false,
        "modifiedDate": null,
        "sourceModifiedDate": null
      },
      {
        "id": "ac3e7278-24f5-40ae-b759-032d8339c373",
        "nominalCode": "800",
        "name": "Accounts Payable",
        "fullyQualifiedCategory": "Liability.Current",
        "fullyQualifiedName": "Liability.Current.Accounts Payable",
        "currency": "USD",
        "currentBalance": null,
        "type": "Liability",
        "status": "Active",
        "isBankAccount": false,
        "modifiedDate": null,
        "sourceModifiedDate": null
      },
      {
        "id": "3f267b10-757d-44c0-bef9-20f70cc8fbe3",
        "nominalCode": "200",
        "name": "Sales",
        "fullyQualifiedCategory": "Income.Revenue",
        "fullyQualifiedName": "Income.Revenue.Sales",
        "currency": "USD",
        "currentBalance": null,
        "type": "Income",
        "status": "Active",
        "isBankAccount": false,
        "modifiedDate": null,
        "sourceModifiedDate": null
      }
    ]
  }

Accounts

Overview

📘
Accounts with no category

Data model

👍
Filtering bank accounts

Account reference

Example data

Overview

📘Accounts with no category

Data model

👍Filtering bank accounts

Account reference

Example data

📘
Accounts with no category

👍
Filtering bank accounts