Companies & connections

The Accounting API is built on a small set of objects. When you sync expenses to QuickBooks, Xero or another accounting system, you work with companies and connections. (The eTIMS API has its own model of businesses and branches: see eTIMS core concepts.)

The object model

Organization ── Application ──┬── Credential (Development: sk_development_…)
   (you)        (your product)└── Credential (Production:  sk_production_…)
                     │
                     └── Company ──── Connection (QuickBooks / Xero / Sage …)
                       (your SMB
                        customer)

Object	What it represents
Organization	Your business on Sync2Books.
Application	Your product or integration. Owns the API keys.
Company	One of your SMB customers. Everything syncable is scoped to a company.
Connection	A link from a company to an external system (an accounting platform).

A single company can hold multiple connections — e.g. QuickBooks and Odoo — at the same time.

Create a company

A company represents your SMB customer. Create one with the POST /companies endpoint; the response includes the company id you use in every subsequent call.

curl -X POST "https://api.sync2books.com/companies" \
  -H "X-API-Key: {apiKey}" \
  -H "Content-Type: application/json" \
  -d '{ "name": "Acme Corporation" }'

{
  "company": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Acme Corporation",
    "isActive": true
  },
  "authUrl": "https://appcenter.intuit.com/connect/oauth2?..."
}

Save company.id. For accounting integrations the response also returns an authUrl to start the OAuth connection.

Connect an accounting system (Expenses)

To sync expenses, connect the company to an accounting platform. The simplest path is the Link component; you can also drive the OAuth flow directly with the authUrl.

# fetch an authorization URL for an existing company
curl -X GET "https://api.sync2books.com/companies/{companyId}/auth-url?integrationKey=quickbooks" \
  -H "X-API-Key: {apiKey}"

The authUrl only carries a working client_id and redirect_uri once your Application has QuickBooks credentials configured — see Set up the QuickBooks Online integration. Without that step, authUrl still comes back but silently fails to redirect anywhere.

Once the OAuth flow completes, the connection is created and status becomes connected. List a company’s connections to get the connectionId you need for syncing:

curl -X GET "https://api.sync2books.com/connections/company/{companyId}" \
  -H "X-API-Key: {apiKey}"

Kenyan tax compliance (eTIMS)

eTIMS is a separate product with its own dashboard, API keys and objects. You register a business there once, in the compliance dashboard, and its API acts on businesses and branches rather than companies. See the eTIMS API docs.

Get started

Core concepts

Accounting API — Expenses

Accounting API — Connected systems

Link component

Companies & connections

The object model

Create a company

Connect an accounting system (Expenses)

Kenyan tax compliance (eTIMS)

Next steps

The sync model

Get started with Expenses

​The object model

​Create a company

​Connect an accounting system (Expenses)

​Kenyan tax compliance (eTIMS)

​Next steps

The sync model

Get started with Expenses

The object model

Create a company

Connect an accounting system (Expenses)

Kenyan tax compliance (eTIMS)

Next steps