Codat Sync for Commerce
Browse all Codat APIsOfficial vendor OpenAPI document · agent-readyE CommerceOrder ManagementapiKey22 EndpointsREST
For Agents
Configure and trigger automated sync of a merchant's commerce sales, fees, and refunds into their accounting software, with integration branding and lifecycle controls.
Use for: I want to start a Sync for Commerce flow between Shopify and QuickBooks, List all sync integrations available for a merchant, Get the sync configuration for a specific merchant company, Authorize a merchant's accounting connection for sync
Not supported: Does not handle reading commerce data, payment processing, or general ledger CRUD - use for the configuration and execution of automated sync from a commerce platform into accounting software only.
Codat's Sync for Commerce API automates the daily push of commerce platform sales, fees, and refunds into a merchant's accounting software. It manages the connection lifecycle between a commerce source (Shopify, Square, Stripe) and an accounting destination (QuickBooks, Xero, Sage), exposes sync configuration and integration metadata, and provides advanced controls for partners embedding the experience. Commerce platforms and reseller partners use it to ship a 'sync to accounting' feature without per-platform engineering.
Install Jentic One Beta
Connect the Sync for Commerce to your agent
Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Sync for Commerce, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.
Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.
1
Step 1: Jentic One Host machine
# On the machine that will host your Jentic One instance:
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fcodat.io%2Fsync-for-commerce" | sh2
Step 2: Agent machine
# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fcodat.io%2Fsync-for-commerce" | sh
jentic register # connects your agent to your Jentic One instanceJentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.
Capabilities
What an agent can do with Sync for Commerce API.
Configure a Sync for Commerce connection between a commerce source and an accounting destination
Trigger and monitor scheduled syncs of sales, fees, and refunds into the accounting platform
Manage company and connection records that tie merchants to their sync configuration
Authorize accounting connections via the connection authorization flow
List and configure available commerce-to-accounting integration pairs
Apply branded sync flow settings so partners can match the integration to their UI
Use advanced controls to override defaults for specific merchant configurations
Use Cases
Patterns agents use Sync for Commerce API for, with concrete tasks.
★ Commerce Platform Accounting Add-On
Commerce platforms like Shopify partners or marketplace operators use Sync for Commerce to ship a native 'sync to QuickBooks' or 'sync to Xero' feature for merchants. The /config/sync/commerce/{commerceKey}/{accountingKey}/start endpoint launches the hosted flow and the /companies/{companyId}/connections endpoints manage the resulting connection lifecycle so merchants get reconciled accounting without manual exports.
Start a Sync for Commerce flow for company {companyId} with commerce key 'shopify' and accounting key 'quickbooksonline'.
Reseller and ISV Embedded Sync
ISVs and resellers embed Sync for Commerce inside vertical SaaS so their merchants can push sales to accounting without the ISV building the integration. The /config/integrations and /config/integrations/{platformKey}/branding endpoints let the ISV configure which platform pairs are exposed and apply their brand to the hosted flow.
List available integrations and update the branding for platform key 'shopify' so the hosted flow shows the partner logo.
Daily Sales Reconciliation
Multi-channel merchants use Sync for Commerce to write each day's gross sales, fees, refunds, and tax components into their accounting ledger as a single posted journal. The /companies/{companyId}/sync/commerce config endpoint controls cadence and mapping, and the standard sync endpoints monitor each run so the finance team knows the day's totals reconciled.
Trigger a sync for company {companyId} and monitor the run until it returns a final status.
AI Agent Onboarding Assistant
AI agents that onboard merchants to a Sync for Commerce experience use Jentic to drive the flow. The agent searches Jentic for 'start sync for commerce', loads the schema, and walks the merchant through commerce and accounting selection. Jentic isolates the Codat API key in its vault so the agent only handles the merchant-facing inputs.
Search Jentic for 'sync for commerce start', load the operation, and start the hosted flow for a Shopify merchant connecting to Xero.
Key Endpoints
22 endpoints — codat's sync for commerce api automates the daily push of commerce platform sales, fees, and refunds into a merchant's accounting software.
METHOD
PATH
DESCRIPTION
GET
/config/sync/commerce/{commerceKey}/{accountingKey}/start
Start the hosted Sync for Commerce flow
POST
/companies
Create a company record for a sync merchant
POST
/companies/{companyId}/connections
Create a connection for the merchant
POST
/companies/{companyId}/connections/{connectionId}/authorization
Authorize the accounting connection
GET
/config/companies/{companyId}/sync/commerce
Read the sync configuration for a merchant
GET
/config/integrations
List available commerce and accounting integrations
GET
/config/integrations/{platformKey}/branding
Get branding settings for a specific platform
GET
/config/sync/commerce/{commerceKey}/{accountingKey}/start
Start the hosted Sync for Commerce flow
POST
/companies
Create a company record for a sync merchant
POST
/companies/{companyId}/connections
Create a connection for the merchant
POST
/companies/{companyId}/connections/{connectionId}/authorization
Authorize the accounting connection
GET
/config/companies/{companyId}/sync/commerce
Read the sync configuration for a merchant
GET
/config/integrations
List available commerce and accounting integrations
GET
/config/integrations/{platformKey}/branding
Get branding settings for a specific platform
Why Jentic?
What agents get from Jentic-routed access to this vendor.
Setup
Wiring Codat Sync for Commerce by hand means building its Basic API-key header, targeting api.codat.io, and managing company creation, connection authorization, and sync configuration yourself. Through Jentic you install once, import Sync for Commerce from the API Directory, store the Codat API key once, and your agent calls it.
Permission scoping
Sync for Commerce puts the company id in the URL path (/companies/{companyId}/connections/... and /config/companies/{companyId}/sync/commerce), so a rule can pin your agent to one company: it configures and reads sync setup for that company and nothing else. You choose the operations it may call, so creating connections or authorizing them is only in the allowed set if you add it.
Credential isolation
Your Codat API key is stored once, encrypted, by your own Jentic One instance and injected at execution time as the Basic Authorization header. It never enters the agent's prompt, logs, or context.
Intent-based discovery
Agents search Jentic by intent such as 'sync commerce sales to accounting' or 'list available accounting integrations', and Jentic returns the matching Sync for Commerce operation with its input schema so the agent calls the right endpoint without browsing the reference docs.
Related APIs
Alternatives and complements available in the Jentic catalogue.
FAQs
Specific to using Sync for Commerce API through Jentic.
What authentication does the Sync for Commerce API use?
The API uses an API key passed in the Authorization header as 'Basic <base64-encoded-key>'. The single security scheme in the spec is named auth_header. Through Jentic, the Codat API key is stored encrypted in the vault and the Authorization header is constructed inside Jentic, never reaching the agent.
Can I start a sync flow between Shopify and QuickBooks programmatically?
Yes. Call GET /config/sync/commerce/{commerceKey}/{accountingKey}/start with commerceKey='shopify' and accountingKey='quickbooksonline' to launch the hosted flow URL the merchant completes. After authorization the standard sync endpoints under /companies/{companyId} take over for ongoing runs.
What are the rate limits for the Sync for Commerce API?
Codat does not publish a fixed rate limit in the OpenAPI spec; limits are governed at the company and connection level and depend on the underlying commerce and accounting platforms. Codat returns HTTP 429 with a Retry-After header when limits are hit and recommends exponential backoff.
How do I list available platform pairs through Jentic?
Search Jentic for 'sync for commerce integrations', load the GET /config/integrations operation, and execute it. Install with pip install jentic and use the standard async search, load, and execute flow.
Can I brand the hosted Sync for Commerce flow for my partner integration?
Yes. Use the /config/integrations/{platformKey}/branding endpoint to apply your partner branding to the hosted onboarding flow. ISVs and resellers use this to keep the experience inside their own UI shell while Codat runs the underlying connection plumbing.
Can I limit what my agent is allowed to do with the Sync for Commerce API?
Yes. Because you self-host Jentic One, your own rules decide which operations and credentials the agent may use. Sync for Commerce puts the company id in the URL path, so you can pin the agent to a single company for reading and configuring its sync setup under /config/companies/{companyId}/sync/commerce and nothing else. State-changing operations such as creating connections at /companies/{companyId}/connections or authorizing them are only in the allowed set if you explicitly add them.
GET STARTED