codat.io – sync-for-commerce

OpenAPI apis-guru ecommerce

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.

Homepage: https://api.apis.guru/v2/specs/codat.io:sync-for-commerce/1.1.json
Provider: codat.io:sync-for-commerce / sync-for-commerce
OpenAPI version: 3.1.0
Spec (JSON): https://api.apis.guru/v2/specs/codat.io/sync-for-commerce/1.1/openapi.json
Spec (YAML): https://api.apis.guru/v2/specs/codat.io/sync-for-commerce/1.1/openapi.yaml

Tools (19)

Extracted live via the executor SDK.

companyManagement.createCompany

Creates a Codat company with a commerce partner data connection.
companyManagement.createConnection

Create a data connection for company.
companyManagement.listCompanies

Retrieve a list of all companies the client has created.
companyManagement.listConnections

Retrieve previously created data connections.
companyManagement.updateConnection

Update a data connection
configuration.getConfiguration

Retrieve current config preferences.
configuration.getSyncStatus

Check the sync history and sync status for a company.
configuration.setConfiguration

Make changes to configuration preferences.
integrations.getIntegrationBranding

Retrieve Integration branding assets.
integrations.listIntegrations

Retrieve a list of available integrations support by datatype and state of release.
sync.requestSync

Run a Commerce sync from the last successful sync up to the date provided (optional), otherwise UtcNow is used. If there was no previously successful sync, the start date in the config is used.
sync.requestSyncForDateRange

Run a Commerce sync from the specified start date to the specified finish date in the request payload.
syncFlowPreferences.getConfigTextSyncFlow

To enable retrieval of preferences set for the text fields on Sync Flow.
syncFlowPreferences.getSyncFlowUrl

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

Enable retrieval for accounts which are visible on sync flow.
syncFlowPreferences.updateConfigTextSyncFlow

To enable update of preferences set for the text fields on sync flow.
syncFlowPreferences.updateVisibleAccountsSyncFlow

To enable update of accounts visible preferences set on Sync Flow.
openapi.previewSpec

Preview an OpenAPI document before adding it as a source
openapi.addSource

Add an OpenAPI source and register its operations as tools