eTIMS API Reference Overview

The Compliance API registers items, issues KRA-signed sales and credit notes, records stock and reads supplier invoices for a Kenyan business. This is the reference for its endpoints. For a guided path, start with the Quickstart.

This is a separate product from the Accounting API. It has its own keys, its own base URL and its own docs. See Which API do I need?.

Base URL and authentication

All paths below start with /v1 and are served from one address, for both the sandbox and production:

https://sync2books-compliance-api.apps.kintro.money/v1

Send your API key in the x-api-key header, or as Authorization: Bearer <key>. The key decides whether you reach the KRA sandbox (cmp_sk_test_...) or production (cmp_sk_live_...). See Authentication & API keys.

curl -H "x-api-key: cmp_sk_test_xxxxxxxxxxxxxxxxxxxxxxxx" "$S2B_URL/me"

Conventions


Success	`{ "data": { ... } }`. Lists add `"pagination": { "nextCursor", "pageSize" }`.
Errors	`{ "error": { "code", "message" } }`. See Errors & Troubleshooting.
Repeats	Send an `Idempotency-Key` on sales and credit notes. See Idempotency.
Paging	Cursor-based. See Pagination.
Limits	120 requests per minute per application by default. See Rate limits.
Money	Kenya shillings, and sale prices are tax inclusive.

Resources at a glance

Resource	What it is for	Scope
Identity	`GET /v1/me`: what the key can do	none
Businesses	The businesses and branches a key can act for	`lookups:read`
Items	Create items and register them with KRA	`catalog:read`, `catalog:write`
Stock	Adjust and transfer stock	`stock:write`
Sales	Issue sales, read them, download receipts, retry, resend callbacks	`sales:read`, `sales:write`
Credit notes	Reverse an accepted sale in full	`sales:write`
Purchases	Fetch and read supplier invoices KRA holds	`purchases:read`
Lookups	KRA code lists and item classifications	`lookups:read`

The endpoint pages are generated from the OpenAPI specification, with a request and response example for each call.

Try it

Open an endpoint, enter a test key once and send the request from the browser.

Use a test key in the playground. Never paste a live key into a shared browser or a shared screen: a live call files a real tax document.

Start here

Guides

API conventions

Reference data

Going live

API reference

Endpoints

Resources

eTIMS API Reference Overview

Base URL and authentication

Conventions

Resources at a glance

Try it

Read next

​Base URL and authentication

​Conventions

​Resources at a glance

​Try it

​Read next

Base URL and authentication

Conventions

Resources at a glance

Try it

Read next