Migrate to Codat

Learn how to migrate existing authorization tokens from your existing integrations to Codat

If you're new to Codat but have 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' connectionsConnection A link between a Codat company and a data source (like an accounting platform). Each connection represents authorized access to pull or push data from that platform. from a self-managed integration to Codat — without your customers needing to reconnect.

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

Self service migrations

Codat's APIAPI A set of rules and protocols that allows different software applications to communicate with each other. Codat provides APIs for accessing financial data from accounting, banking, and commerce platforms. allows you to provide tokens for a subset of our integrations which will allow you to self-manage a migration.

Self service token migration is currently supported for over twenty of our integrations, with more being added in the coming months. To view an up-to-date list, check out the available integrations in the OAuth Token Migrations section of our Postman collection.

Before you migrate a token, the companyCompany In Codat, a company represents your customer's business entity. Companies can have multiple connections to different data sources. and data connectionConnection A link between a Codat company and a data source (like an accounting platform). Each connection represents authorized access to pull or push data from that platform. must be created. This is required because the companyId and connectionId are parameters in the PUT token migration URL (see below). You can create the companyCompany In Codat, a company represents your customer's business entity. Companies can have multiple connections to different data sources. using a POST call to the Create company endpoint. The connectionConnection A link between a Codat company and a data source (like an accounting platform). Each connection represents authorized access to pull or push data from that platform. can be created using the Create connection endpoint.

To migrate, use the PUT connectionsConnection A link between a Codat company and a data source (like an accounting platform). Each connection represents authorized access to pull or push data from that platform. endpoint. You will need to provide the integration specific information such as the organization ID and OAuth tokens that Codat should use. Because these are different for each integration, examples of the format required for the integrations available are listed in the Postman Collection linked above.

Request URL

Authorize connection

  PUT /companies/{companyId}/connections/{connectionId}/authorization

Request Body

{
  "accessToken": "0000-0000",
  "businessId": "test-business-1234"
}

Syncing data post-migration

After successfully updating a connectionConnection A link between a Codat company and a data source (like an accounting platform). Each connection represents authorized access to pull or push data from that platform. with valid credentials, you'll need to initiate a syncSync The process of fetching the latest data from a connected data source. Syncs can be triggered manually or run automatically on a schedule. manually using the POST ​/companies​/{companyId}​/data​/all endpoint.

Fetch on first linkLink The authorization flow that allows end users to connect their accounting, banking, or commerce platforms to your application via Codat. isn't supported when performing self-service token migrations using the PUT /companies/{companyId}/connections/{connectionId}/authorization endpoint.

Managed migrations

For other platforms where we do not yet support the self service migration route, or if you have special considerations or concerns, Codat's solutions team offers a managed migration pathway.

Supported integrations

We currently have supported migrations from the following platforms: FreeAgent, FreshBooks, QuickBooks Online, Shopify, Wave, and Zoho Books.

We don't have a standard migration process for our other integrations, 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.

The migration process usually involves the following steps.

Plan your migration

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

Step	Details	Responsibility
1. Supply migration and platform details	Supply all the required details for the specific platform to the Codat support team.	Your companyCompany In Codat, a company represents your customer's business entity. Companies can have multiple connections to different data sources.
2. Schedule the migration	Agree a time when the migration can take place. Based on your companyCompany In Codat, a company represents your customer's business entity. Companies can have multiple connections to different data sources.'s data, Codat's support team estimates how long the migration will take.	Your companyCompany In Codat, a company represents your customer's business entity. Companies can have multiple connections to different data sources. and the Codat support team
3. Update your application details	Add Codat’s callback URL to the application registered with your platform provider.	Your companyCompany In Codat, a company represents your customer's business entity. Companies can have multiple connections to different data sources.
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.	Your companyCompany In Codat, a company represents your customer's business entity. Companies can have multiple connections to different data sources.
5. Migrate first companyCompany In Codat, a company represents your customer's business entity. Companies can have multiple connections to different data sources.	Codat's support team imports the name and token for a single companyCompany In Codat, a company represents your customer's business entity. Companies can have multiple connections to different data sources. and performs an end-to-end test to make sure: - No reauthorization is required. - Data syncsSync The process of fetching the latest data from a connected data source. Syncs can be triggered manually or run automatically on a schedule. complete correctly.	Codat support team
6. Complete migration	Codat's support team: - Migrates the remaining companies. - Performs end-to-end tests. - Completes a handover.	Codat support team