Sign in

v52

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-043334230.9 KB
Source accounts

Update source account

The Update source account endpoint updates a single source account for a single data connection connected to a single company.

Tips and pitfalls

  • This endpoint makes it possible to update the accountName, status, and balance fields.
    • The status field can only be updated to 'disconnected'.
    • The balance field can only be updated on accounts that are not 'connected'.
  • Updates made here apply exclusively to source accounts and will not affect target accounts in the accounting software.
patch/companies/{companyId}/connections/{connectionId}/connectionInfo/bankFeedAccounts/{accountId}

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.

Request body

idstring required

Unique ID for the bank account.

accountNamestring nullable

The bank account name.

accountTypestring nullable

The type of bank account e.g. Credit.

accountNumberstring nullable

The account number.

sortCodestring nullable

The sort code.

currencystring ISO4217

The currency data type in Codat is the ISO 4217 currency code, e.g. GBP.

Unknown currencies

In line with the ISO 4217 specification, the code XXX is used when the data source does not return a currency for a transaction.

There are only a very small number of edge cases where this currency code is returned by the Codat system.

balancenumber nullable

The latest balance for the bank account.

modifiedDatestring

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>. Date and time fields are formatted as strings; for example:

2020-10-08T22:40:50Z
2021-01-01T00:00:00

When syncing data that contains DateTime fields from Codat, make sure you support the following cases when reading time information:

  • Coordinated Universal Time (UTC): 2021-11-15T06:00:00Z
  • Unqualified local time: 2021-11-15T01:00:00
  • UTC time offsets: 2021-11-15T01:00:00-05:00

Time zones

Not all dates from Codat will contain information about time zones.
Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced.

status'pending' | 'connected' | 'connecting' | 'disconnected' | 'unknown' nullable

Status of the source account.

feedStartDatestring

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>. Date and time fields are formatted as strings; for example:

2020-10-08T22:40:50Z
2021-01-01T00:00:00

When syncing data that contains DateTime fields from Codat, make sure you support the following cases when reading time information:

  • Coordinated Universal Time (UTC): 2021-11-15T06:00:00Z
  • Unqualified local time: 2021-11-15T01:00:00
  • UTC time offsets: 2021-11-15T01:00:00-05:00

Time zones

Not all dates from Codat will contain information about time zones.
Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced.

Example request

{
  "id": "acc-002",
  "accountName": "account-081",
  "sortCode": "123456",
  "accountType": "Credit",
  "accountNumber": "12345670",
  "currency": "GBP",
  "balance": 99.99,
  "modifiedDate": "2023-01-09T14:14:14.1057478Z",
  "status": "pending"
}

Response

Success

idstring required

Unique ID for the bank account.

accountNamestring nullable

The bank account name.

accountTypestring nullable

The type of bank account e.g. Credit.

accountNumberstring nullable

The account number.

sortCodestring nullable

The sort code.

currencystring ISO4217

The currency data type in Codat is the ISO 4217 currency code, e.g. GBP.

Unknown currencies

In line with the ISO 4217 specification, the code XXX is used when the data source does not return a currency for a transaction.

There are only a very small number of edge cases where this currency code is returned by the Codat system.

balancenumber nullable

The latest balance for the bank account.

modifiedDatestring

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>. Date and time fields are formatted as strings; for example:

2020-10-08T22:40:50Z
2021-01-01T00:00:00

When syncing data that contains DateTime fields from Codat, make sure you support the following cases when reading time information:

  • Coordinated Universal Time (UTC): 2021-11-15T06:00:00Z
  • Unqualified local time: 2021-11-15T01:00:00
  • UTC time offsets: 2021-11-15T01:00:00-05:00

Time zones

Not all dates from Codat will contain information about time zones.
Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced.

status'pending' | 'connected' | 'connecting' | 'disconnected' | 'unknown' nullable

Status of the source account.

feedStartDatestring

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>. Date and time fields are formatted as strings; for example:

2020-10-08T22:40:50Z
2021-01-01T00:00:00

When syncing data that contains DateTime fields from Codat, make sure you support the following cases when reading time information:

  • Coordinated Universal Time (UTC): 2021-11-15T06:00:00Z
  • Unqualified local time: 2021-11-15T01:00:00
  • UTC time offsets: 2021-11-15T01:00:00-05:00

Time zones

Not all dates from Codat will contain information about time zones.
Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced.

Example response

{
  "id": "acc-002",
  "accountName": "account-081",
  "sortCode": "123456",
  "accountType": "Credit",
  "accountNumber": "12345670",
  "currency": "GBP",
  "balance": 99.99,
  "modifiedDate": "2023-01-09T14:14:14.1057478Z",
  "status": "pending"
}