Sync for Commerce API - Codat | Specway Docs

Own Codat? Customize your docs with AI search, analytics, and more.

Claim your docs

Sync for Commerce API

Codat

Powered by Specway

Own Codat? Customize your docs with AI search, analytics, and more.

Claim your docs

Sync for Commerce API

Codat

Powered by Specway

Back to APIs Authentication

Endpoints

List visible accountsGET

Run a Commerce sync from the last successful syncPOST

Create or update configuration.POST
Get branding for an integrationGET
List information on Codat's supported integrationsGET
Retrieve config preferences set for a company.GET
Retrieve sync flow urlGET

Create a data connectionPOST
Create a sync for commerce companyPOST
Get status for a company's syncsGET
List companiesGET
List data connectionsGET
Run a Commerce sync from a given date rangePOST
Update data connectionPATCH

Retrieve preferences for text fields on Sync FlowGET
Update preferences for text fields on sync flowPATCH
Update the visible accounts on Sync FlowPATCH

Back to APIs Authentication

Endpoints

List visible accountsGET

Run a Commerce sync from the last successful syncPOST

Create or update configuration.POST
Get branding for an integrationGET
List information on Codat's supported integrationsGET
Retrieve config preferences set for a company.GET
Retrieve sync flow urlGET

Create a data connectionPOST
Create a sync for commerce companyPOST
Get status for a company's syncsGET
List companiesGET
List data connectionsGET
Run a Commerce sync from a given date rangePOST
Update data connectionPATCH

Retrieve preferences for text fields on Sync FlowGET
Update preferences for text fields on sync flowPATCH
Update the visible accounts on Sync FlowPATCH

Sync for Commerce API

The API for Sync for Commerce. Sync for Commerce is an API and a set of supporting tools. It has been built to enable e-commerce, point of sale platforms to provide high-quality integrations with numerous accounting platform through standardized API, seamlessly transforming business sale's data into accounting artefacts. [Read More...](https://docs.codat.io/sfc/overview)

Base URL

https://api.codat.io

Endpoints

17 endpoints available

/meta/companies

List companies

Sync for Commerce API

The API for Sync for Commerce. Sync for Commerce is an API and a set of supporting tools. It has been built to enable e-commerce, point of sale platforms to provide high-quality integrations with numerous accounting platform through standardized API, seamlessly transforming business sale's data into accounting artefacts. [Read More...](https://docs.codat.io/sfc/overview)

Base URL

https://api.codat.io

Endpoints

17 endpoints available

/meta/companies

List companies

GET

/config/integrations

List information on Codat's supported integrations

/meta/companies/sync

Create a sync for commerce company

/sync/commerce/config/ui/text

Retrieve preferences for text fields on Sync Flow

/sync/commerce/config/ui/text

Update preferences for text fields on sync flow

/meta/companies/{companyId}/connections

List data connections

/meta/companies/{companyId}/connections

Create a data connection

/companies/{companyId}/sync/commerce/latest

Run a Commerce sync from the last successful sync

/config/companies/{companyId}/sync/commerce

Retrieve config preferences set for a company.

/config/companies/{companyId}/sync/commerce

Create or update configuration.

/config/integrations/{platformKey}/branding

Get branding for an integration

/meta/companies/{companyId}/sync/commerce/status

Get status for a company's syncs

/meta/companies/{companyId}/sync/commerce/historic

Run a Commerce sync from a given date range

/meta/companies/{companyId}/connections/{connectionId}

Update data connection

/sync/commerce/config/ui/accounts/platform/{commerceKey}

Update the visible accounts on Sync Flow

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

Retrieve sync flow url

/clients/{clientId}/config/ui/accounts/platform/{platformKey}

List visible accounts

GET

/config/integrations

List information on Codat's supported integrations

/meta/companies/sync

Create a sync for commerce company

/sync/commerce/config/ui/text

Retrieve preferences for text fields on Sync Flow

/sync/commerce/config/ui/text

Update preferences for text fields on sync flow

/meta/companies/{companyId}/connections

List data connections

/meta/companies/{companyId}/connections

Create a data connection

/companies/{companyId}/sync/commerce/latest

Run a Commerce sync from the last successful sync

/config/companies/{companyId}/sync/commerce

Retrieve config preferences set for a company.

/config/companies/{companyId}/sync/commerce

Create or update configuration.

/config/integrations/{platformKey}/branding

Get branding for an integration

/meta/companies/{companyId}/sync/commerce/status

Get status for a company's syncs

/meta/companies/{companyId}/sync/commerce/historic

Run a Commerce sync from a given date range

/meta/companies/{companyId}/connections/{connectionId}

Update data connection

/sync/commerce/config/ui/accounts/platform/{commerceKey}

Update the visible accounts on Sync Flow

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

Retrieve sync flow url

/clients/{clientId}/config/ui/accounts/platform/{platformKey}

List visible accounts