v52

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-055983641.5 KB
Sync flow preferences

Retrieve sync flow url

Get a URL for Sync Flow including a one time passcode.

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

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"
}