Codat Sync For Commerce
Codat Sync for Commerce is an API service for syncing commerce transactions into accounting and finance systems.
- Base URL:
https://api.codat.io - Auth:
header:Authorization(pass your key via theapiKeyinput)
Operations
get_visible_accounts— GET /clients/{clientId}/config/ui/accounts/platform/{platformKey} — List visible accountsget_configuration— GET /config/companies/{companyId}/sync/commerce — Retrieve config preferences set for a company.list_integrations— GET /config/integrations — List information on Codat's supported integrationsget_integration_branding— GET /config/integrations/{platformKey}/branding — Get branding for an integrationget_sync_flow_url— GET /config/sync/commerce/{commerceKey}/{accountingKey}/start — Retrieve sync flow urllist_companies— GET /meta/companies — List companies
Inputs
apiKey— your codat-sync-for-commerce API keyoperation— one of the operations above- path parameters when an operation's path contains
{...} query— optional JSON object of query paramsbody— JSON object for create/update ops
Example
operation: get_visible_accounts
apiKey: <your key>
Publishes
The keys a later task may reference as {{taskName.key}}. Referencing anything not listed here resolves to nothing at run time.
erroroperationresultstatus
Input Properties
Every property this tool accepts, from its own tool.iml.
| Property | Type | Required | Default | Description |
|---|---|---|---|---|
apiKey |
string | yes | — | DEPRECATED — bind an API Key credential to the task with credentialName instead. A key pasted here is stored in the workflow definition in clear and appears in every export of it. Still honoured for workflows built before the change. |
operation |
string | yes | — | One of: get_visible_accounts, get_configuration, list_integrations, get_integration_branding, get_sync_flow_url, list_companies |
accountingKey |
string | no | — | Path parameter accountingKey (required by some operations). |
clientId |
string | no | — | Path parameter clientId (required by some operations). |
commerceKey |
string | no | — | Path parameter commerceKey (required by some operations). |
companyId |
string | no | — | Path parameter companyId (required by some operations). |
platformKey |
string | no | — | Path parameter platformKey (required by some operations). |
query |
string | no | — | Optional query params as a JSON object string, e.g. {"limit": 10}. |