---
title: "Start new sync flow"
method: GET
path: "/config/sync/commerce/{commerceKey}/{accountingKey}/start"
tags: ["Connections"]
---

# Start new sync flow

`GET /config/sync/commerce/{commerceKey}/{accountingKey}/start`

Create a new company and connections. Get a URL for Sync Flow, including a one time passcode.

## Path parameters

- `commerceKey` string, required
- `accountingKey` string, required

## Query parameters

- `merchantIdentifier` string

## Response `200`

Success

- SyncFlowUrl
  - `url` string — Sync flow URL.

## Other responses

- `400` — The request made is not valid.
- `401` — Your API request was not properly authorized.
- `402` — An account limit has been exceeded. The type of limit is described in the error property: - You have exceeded the 50-company limit that applies to a Free plan. Delete any companies you no longer need and retry the request. - The requested sync schedule is not allowed. You requested an hourly sync schedule but this functionality is not included in the Free plan. - Your Free account is older than 365 days and has expired. Contact support@codat.io.
- `403` — You are using an outdated API key or a key not associated with that resource.
- `404` — One or more of the resources you referenced could not be found. This might be because your company or data connection id is wrong, or was already deleted.
- `429` — Too many requests were made in a given amount of time. Wait a short period and then try again.
- `500` — There is a problem with our server. Please try again later.
- `503` — The Codat API is temporarily offline for maintenance. Please try again later.

## Changes

> 52 revisions in range; 16 could not be searched.

- **2024-02-13** `9bd87def9914` — 8 info
  - added the optional property `validation` to the response with the `400` status
  - added the optional property `validation` to the response with the `401` status
  - added the optional property `validation` to the response with the `402` status
  - added the optional property `validation` to the response with the `403` status
  - …4 more
- **2023-10-23** `83c1801e91f7` — 8 info
  - added the non-success response with the status `400`
  - added the non-success response with the status `401`
  - added the non-success response with the status `402`
  - added the non-success response with the status `403`
  - …4 more

[Change history](https://skmtc.dev/codatio/apis/codat-sync-commerce/changes/config/sync/commerce/:commerceKey/:accountingKey/start/get.md)

---

[API](https://skmtc.dev/codatio/apis/codat-sync-commerce.md) · [All operations](https://skmtc.dev/codatio/apis/codat-sync-commerce/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/codatio/codat-sync-commerce/revisions/f669e8c3c34f/schema)