Configuration

The configuration of the Bank Sync module controls how a linked banking transaction data source is synchronised with a linked banking or bank feeds data destination.

Open in the Bank Sync API Explorer

Data model

Field
Type
Description

companyId

string

Codat unique identifier for the company.

companyName

string

Name of the company from the bank data source.

enabled

boolean

Whether synchronisation is turned on or off.

schedule

See Schedule.

accountMappings

Schedule

Field
Type
Description

selectedFrequency

string

Chosen frequency for the synchronisation, selected from frequencyOptions.

frequencyOptions

Array of string

Options for the frequency of synchronisation, either Hourly or Daily.

startDate

string
See date

Date on which the first synchronisation begins.

Backdate the start date to synchronise historic transactions.

syncHourUtc

int

Hour of the day in which the synchronisation runs unless the selected frequency is hourly.

Account mappings

Field
Type
Description

sourceAccounts

Array of Account objects

Array of accounts from the bank data source for which transactions can be synchronised.

destinationAccounts

Array of Account objects

Array of accounts at the bank data destination which transactions can be synchronised to.

mappings

Array of object

Array of pairs of source and destination account IDs, representing which account transactions can be synchronised between them.

Accounts

Field
Type
Description

id

string

Identifier for the account, unique for the company.

name

string

Name of the account.

bankCode

string

Bank reference for the account, in the UK this is the sort code.

accountNumber

string

Reference number for the account.

description

string

Description of the account, if provided.

Updated 3 months ago

Configuration


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.