Welcome to Codat's API Documentation

Develop against the Codat API.

Guides    API Explorer

Configuration

The Bank Sync module configuration is used to set up the options for how a linked banking transaction data source should be synchronised with a linked banking or bank feeds data destination.

Open in the Bank Sync API Explorer

Data Model

Field
Type
Description

companyId

string

The Codat unique identifier for the Company

companyName

string

The name of the company from the source bank

enabled

boolean

If the synchronisation is turned on or off

schedule

See Schedule below.

accountMappings

See Account Mappings below.

Schedule

Field
Type
Description

selectedFrequency

string

The chosen frequency for the synchronisation, selected from frequency options

frequencyOptions

Array of string

Options for the frequency of synchronisation

Possible options are:
Hourly, Daily

startDate

string
See Date

The date at which the first synchronisation should begin from.

A date in the past will synchronise historic transactions from then i.e backdated

syncHourUtc

int

The hour of the day in which the synchronisation should run, not used when selected frequency is hourly

Account Mappings

Field
Type
Description

sourceAccounts

Array of account objects

An array of the accounts from the bank data source for which transactions can be synchronised from

destinationAccounts

Array of account objects

An array of the accounts at the bank data destination which transactions can be synchronised to

mappings

Array of object

An array of pairs of source and destination account ids, representing which accounts transactions should be synchronised between

Accounts

Field
Type
Description

id

string

Identifier for the account, unique for the company

name

string

The name of the account

bankCode

string

The bank reference for the account, in the UK this will be the sort code

accountNumber

string

The reference number for the account

description

string

A description of the account, if provided

Updated 10 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.