API: Categorization of accounts

🚧

Categorization of accounts - Beta testing

Please note that the feature is still in testing mode and hasn't been fully released yet. The only integration we currently support is the one with the Quickbooks Online platform (excl. Quickbooks Online France).

If you're interested in participating in the pilot testing, please contact your sales representative.

API endpoints for categorization of accounts

Account categories have three sub-categories:

  • Account type — the highest level classification of an account, e.g. Asset, Liability, etc.
  • Account subtype — category often used for traditional financial ratios, e.g. Current assets, Current liabilities, etc.
  • Account detail — individual accounts, e.g. Cash, Inventory, Depreciation, etc.

The endpoints are available in Swagger in UAT under Accounts. They contain the original category suggested by Codat (suggested) and the category that was confirmed by your customer (confirmed).

  • All Codat standard categories can be found under: GET /metadata/accounts/categories.
"id": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4",
      "nominalCode": "090",
      "name": "Business Bank Account",
      "fullyQualifiedCategory": "Asset.Bank",
      "fullyQualifiedName": "Asset.Bank.Business Bank Account",
      "currency": "GBP",
      "type": "Asset",
      "status": "Active",
      "isBankAccount": true,
      "modifiedDate": "2021-02-18T11:30:39Z",
      "validDatatypeLinks": [
        {
          "property": "id",
          "links": [
            "Payment.accountRef.Id"
          ]
        }
      ]
    },
    {
      "id": "16503499-9215-4a45-9839-b0fed8269304",
      "nominalCode": "610",
      "name": "Accounts Receivable",
      "fullyQualifiedCategory": "Asset.Current",
      "fullyQualifiedName": "Asset.Current.Accounts Receivable",
      "currency": "USD",
      "type": "Asset",
      "status": "Active",
      "isBankAccount": false,
      "modifiedDate": "2021-02-18T11:30:39Z",
      "validDatatypeLinks": []
    },
  • All suggested and confirmed categories for a specific connection can be obtained here: GET /companies/{companyId}/connections/{connectionId}/metadata/accounts/categories.
{
      "accountRef": {
        "id": "367f8daa-1464-4152-bf4e-21548696f916",
        "name": "Purchases"
      },
      "suggested": {
        "type": "Expense",
        "subtype": "CostOfSales",
        "detailType": "Labour"
      },
      "confirmed": {
        "type": "Expense",
        "subtype": "Operating",
        "detailType": "AmortisationDepreciation"
      }
    },
  • All confirmed categories for a specific connection can be updated here:
    PATCH /companies/{companyId}/connections/{connectionId}/metadata/accounts/categories.

In the update request body, provide:

  • type (classification of the account, e.g. Asset, Liability, Income, Expense),
  • subType (e.g. Current asset),
  • detailType.

You can provide a partial list of accounts you wish to update, or pass the whole object as null if you wish to remove the confirmed category for an account.

{
  "categories": [
    {
      "accountRef": {
        "id": "string"
      },
      "confirmed": {
        "type": "string",
        "subtype": "string",
        "detailType": "string"
      }
    }
  ]
}

Did this page help you?