Sync settings for online platforms

Overview

This option is a mandatory step in the platform setup. Depending on your needs, you can decide to have "snapshot" or continuous access to your clients' data. By default, the option is set to request continuous synchronization of company's data for each online platform.

Codat Portal

Before you send a link URL to companies to connect their source of data to the Codat Portal, you may decide whether you'll have single or continuous access to their financial information.

  1. Check if you have the Fetch on first link option turned on for the data you want to retrieve from the companies.
  2. Next, go to Integrations and choose the accounting/banking/commerce platform you wish the companies to connect to.
  3. Choose Manage by the selected platform.
  4. Choose one of the two options:
  • Allow one-off data sync when company authorizes connection — to ensure one-off fetch of data of all companies authorizing their connection to a given platform. When the syncing is successfully completed, the platform will disconnect. If, at some point, you will want to re-sync the data for any of the companies, the company will need to be individually authorized again.
  • Allow continuous data sync — to ensure ongoing data synchronization for all companies connected to this platform, This allows you to have access to the freshest information at all times.

One-off sync

Continuous sync

Fetches data and disconnects the company

YES

NO

Companies need to individually authorize each time via the Link

YES

NO

Need to fetch data over time and perform background refreshes

NO

YES

XERO's limit of 25 connected companies applies

NO

YES

Offers ongoing access to your client's data

NO

YES

Codat API

Configure global sync settings

To check if you have the one-off sync option active or not, use the following endpoint: GET /settings. In the response, you'll receive information whether your one-off synchronization is:

  • Disabled, which means that your current settings allow continuous syncing of all companies in your system,
  • Enabled, which means that your current settings allow a single sync of all companies in your system. Companies can have many "one-off" syncs, but they will need to be individually authorized each time.
{
  "clientId": "c44cba9a-1ad9-4079-89e3-ffd579c2a274",
  "oneTimeSync": "Disabled"
}

To change your sync settings, use the following endpoint: PATCH /settings and enter one of these values: Disabled, Enabled.

Configure sync settings at the platform level

To check what the sync settings for any of the integrations are, use the following endpoint: GET /settings/integrations/{integrationId}. You'll need an identification number of the platform (integrationId), which can be retrieved under the Integrations endpoint.

In the response, you'll receive information whether your one-off synchronization is:

  • Disabled for the selected platform, which means that your current settings allow continuous data syncing of all companies connected to this platform,
  • Enabled for the selected platform, which means that your current settings allow a single data sync of all companies that authorize connection to that platform. Companies can have many "one-off" syncs, but they will need to be individually authorized each time.
{
  "clientId": "c44cba9a-1ad9-4079-89e3-ffd579c2a274",
  "integrationId": "0f20c943-12d0-4800-9f6c-d218f62d494c",
  "oneTimeSync": "Enabled"
}

To change your current sync settings on the platform level, use the following endpoint PATCH /settings and enter one of these values: Disabled or Enabled.

Note that you can't override these settings for companies individually. All companies connected to a given platform will have the same settings.


Did this page help you?