Connections

Start new sync flow

Changed on Feb 13, 2024

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

get/config/sync/commerce/{commerceKey}/{accountingKey}/start

Request

Base URL
https://api.codat.io
URL
https://api.codat.io/config/sync/commerce/{commerceKey}/{accountingKey}/start
Auth
API key in header Authorization

Path parameters

commerceKeystring required

Commerce platform key

accountingKeystring required

Accounting platform key

Query parameters

merchantIdentifierstring

Identifier for your merchant, can be the merchant name or Codat company id.

Response

Success

urlstring

Sync flow URL.

Example response

{
  "url": "https://sync-flow-integration.codat.io/57b6fad9-e3ca-447b-89db-e4ffa21e6ef3/aiwb/mqjo/start?otp=836415"
}

Changes

Feb 13, 20249bd87def9914 Revision changes
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
Oct 23, 202383c1801e91f7 Revision changes
- info
  added the non-success response with the status
- info
  added the non-success response with the status
- info
  added the non-success response with the status
- info
  added the non-success response with the status
- info
  added the non-success response with the status
- info
  added the non-success response with the status
- info
  added the non-success response with the status
- info
  added the non-success response with the status

Operation history (5 revisions)