Loan writeback

Create bank feed account mapping

Changed on

The Create bank account mapping endpoint creates a new mapping between a source bank account and a potential account in the accounting software (target account).

A bank feed account mapping is a specified link between the source account (provided by the Codat user) and the target account (the end user's account in the underlying software).

To find valid target account options, first call the List bank feed account mappings endpoint.

For custom builds only

Only use this endpoint if you are building your own account management UI.

Account mapping variability

The method of mapping the source account to the target account varies depending on the accounting software your company uses.

Mapping options:

  1. API Mapping: Integrate the mapping journey directly into your application for a seamless user experience.
  2. Codat UI Mapping: If you prefer a quicker setup, you can utilize Codat's provided user interface for mapping.
  3. Accounting Platform Mapping: For some accounting software, the mapping process must be conducted within the software itself.

Integration-specific behavior

Bank Feed IntegrationAPI MappingCodat UI MappingAccounting Platform Mapping
Xero✅✅
FreeAgent✅✅
Oracle NetSuite✅✅
Exact Online (NL)✅✅
QuickBooks Online✅
Sage✅
post/companies/{companyId}/connections/{connectionId}/bankFeedAccounts/mapping

Request

  • Base URL: https://api.codat.io
  • URL: https://api.codat.io/companies/{companyId}/connections/{connectionId}/bankFeedAccounts/mapping
  • Auth: API key in header Authorization

Request body

sourceAccountIdstring required

Unique ID for the source account

targetAccountIdstring nullable

Unique ID for the target 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

{
  "sourceAccountId": "acc-002",
  "targetAccountId": "account-081"
}

Response

Success

sourceAccountIdstring

Unique ID for the source account.

targetAccountIdstring nullable

Unique ID for the target account.

statusstring nullable

Status of the POST request.

errorstring nullable

Error returned during the post request

Example response

{
  "sourceAccountId": "acc-002",
  "targetAccountId": "account-081",
  "status": "Failed",
  "error": "A feed connection already exists to this account"
}

Changes