COcodatio
Accounts

Get account

Changed on

The Get account endpoint returns a single account for a given accountId.

Accounts are financial accounts maintained by a bank or other financial institution.

Before using this endpoint, you must have retrieved data for the company.

get/companies/{companyId}/connections/{connectionId}/data/banking-accounts/{accountId}

Request

  • Base URL
    https://api.codat.io
  • Auth
    API key in header Authorization

Path parameters

companyIdstring uuid required

Unique identifier for your SMB in Codat.

Example:8a210b68-6988-11ed-a1eb-0242ac120002

Unique identifier for a company.

connectionIdstring uuid required

Unique identifier for a company's data connection.

Example:2e9d2c44-f675-40ba-8049-353bfcb5e171

Unique identifier for a connection.

accountIdstring required
Example:13d946f0-c5d5-42bc-b092-97ece17923ab

Unique identifier for an account.

Response

Success

idstring required

The ID of the account from the provider.

namestring required

The name of the account according to the provider.

informalNamestring nullable

The friendly name of the account, chosen by the holder. This may not have been set by the account holder and therefore is not always available.

holderstring nullable

The name of the person or company who holds the account.

type'Unknown' | 'Credit' | 'Debit' required

The type of transactions and balances on the account.
For Credit accounts, positive balances are liabilities, and positive transactions reduce liabilities.
For Debit accounts, positive balances are assets, and positive transactions increase assets.

balanceAccountBalanceAmounts required(unresolved $ref)
identifiersAccountIdentifiers required(unresolved $ref)
currencystring required

The currency code for the account.

institutionAccountInstitution required(unresolved $ref)
modifiedDatestring

The date when the record was last fetched from the accounting software, commerce software, or open banking provider and updated in Codat’s data cache.

Use it to identify and retrieve records that have changed since your last fetch. For example, filtering modifiedDate to today will provide new records updated in Codat today.

This date is populated for all data types except for attachments, balance sheets, company information, and profit & loss reports (read more).

In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>.

sourceModifiedDatestring

The date when a record was last modified in the accounting software, usually by the business or a business process. For example, when payments are made against an invoice.

It is not populated (read more) when:

  • Pulling attachments
  • The accounting software does not provide modification dates for a data type
  • A record has been deleted from the source platform and Codat doesn't have a record of when the deletion occurred
  • A record has been voided. For certain platforms that soft delete records, isDeleted metadata is used to identify void records

In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>.

Example response

{
  "results": [
    {
      "id": "1703194f-7805-4da8-bac0-2ba5da4a4216",
      "name": "Business Current Account",
      "informalName": "Codat",
      "holder": "Codat Ltd",
      "type": "Debit",
      "balance": {
        "available": -459987.97,
        "current": -459964.9,
        "limit": 5000
      },
      "identifiers": {
        "type": "Depository",
        "subtype": "checking",
        "number": "46762629",
        "bankCode": 9911,
        "iban": "GB29 LOYD 4773 2346 7626 29",
        "bic": "LOYDGB21006",
        "maskedAccountNumber": "LOYDGB21006"
      },
      "currency": "GBP",
      "institution": {
        "id": "lloyds-bank",
        "name": "Lloyds Bank"
      },
      "modifiedDate": "2022-05-23T16:32:50Z",
      "sourceModifiedDate": "2021-08-14T05:04:12"
    }
  ]
}

Changes

  • a26d38c3e530Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 63409d8e7593Revision changes
    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status