Migrating an existing integration to Codat

If you’re new to Codat but you've already built and use an OAuth application with one of our supported integrations, you’re in the right place. Codat’s token migration process allows you to seamlessly migrate your customers' connections from a self-run integration to Codat, without your customers needing to reconnect.

This article describes the information we'll need from you, and provides an overview of the migration process.

📘

Supported integrations

We currently support migrations for the following platforms: Exact Online, FreeAgent, FreshBooks, Kashoo, Pandle, QuickBooks Online, Sage Business Cloud Accounting, Wave, Xero, and Zoho Books.

We don't have a standard migration process for Clearbooks, KashFlow, and MYOB AccountRight Live, but are happy to explore possible solutions. Please get in touch with your solutions engineer if you need to discuss migrating one of these integrations.

What do I need to provide?

You need to supply:

  • A spreadsheet - .xls or .csv file - that includes names of the companies that Codat need to migrate, and their token details.
  • Secure credentials for your application, for example, client ID and client secret.

The exact details of tokens and credentials varies between different platforms; please contact your solutions engineer or our support team to discuss the specific details requirements for your migration.

What is the typical migration process?

The migration process usually involves the following steps. We recommend that you don’t start migration until you've set up your platform integration in Codat’s UAT and Production environments, and done some initial testing.

👍

Plan your migration

Every migration is different so please make sure you talk to your solutions engineer, or contact our support team as early as possible to discuss and plan your migration.

1. Supply migration and platform details

Supply a spreadsheet, with the details described above, to the Codat support team.

Responsibility: Your company

2. Update your application details

Add Codat’s callback URL to the application registered with your platform provider.

Responsibility: Your company

3. Schedule the migration

Agree a time when the migration can take place. Based on your company's data, Codat's support team estimates how long the migration will take.

Responsibility: Your company and the Codat support team

4. Disable data syncing

Disable data syncing in your existing application for all companies that you have chosen to migrate. This is to prevent tokens from becoming invalid.

Responsibility: Your company

5. Migrate first company

Codat's support team imports the name and token for a single company and performs an end-to-end test in UAT and Production to make sure:

  • No reauthorisation is required.
  • Data syncs complete correctly.

Responsibility: Codat support team

6. Complete migration

Codat's support team:

  • Migrates the remaining companies.
  • Performs end-to-end tests.
  • Completes a handover.

Responsibility: Codat support team


Did this page help you?