API Documentation

Build integrations with our API.

Everything you need to connect your application with KRA eTIMS — authenticate, choose a business or branch, and make your first request.

Explore API Reference View FAQ

Quick start

Five steps from zero to a successful authenticated call.

01
Get your API key
Open Settings → API Settings in the Business Panel and copy a Business or Branch key.
02
Authenticate your request
Send X-API-Key: YOUR_BRANCH_API_KEY (or a Business API Key for business-scoped calls).
03
Choose your business or branch
Use a Business API Key for business-scoped resources. Use a Branch API Key for sales, items, stock, and device workflows.
04
Make your first API request
Start with credit balance or initialize the branch device when required.
05
Process the response
Read JSON status, data, and handle validation or auth errors.

Authentication

Authenticate with the X-API-Key header. Never put real keys in source control — use placeholders like YOUR_BUSINESS_API_KEY and YOUR_BRANCH_API_KEY.

Headers

X-API-Key: YOUR_BRANCH_API_KEY
Accept: application/json
Content-Type: application/json

Business API Key

Authenticates API requests within the scope of the associated business.
Scope: credits, branch list, subscriptions, suppliers, cross-branch inventory summary.
Cannot call branch operations such as sales, items, stock, initialize, or credit notes.
Supplied as X-API-Key: YOUR_BUSINESS_API_KEY.

Branch API Key

Authenticates API requests within the scope of the associated branch only.
Scope: device init, products, inventory, sales, purchases, credit notes, notices, code lists.
May also call business-scoped endpoints for the same business — not other branches or businesses.
Supplied as X-API-Key: YOUR_BRANCH_API_KEY.

Base URL

All versioned public endpoints live under /api/v1.

Base URL

https://altitax.altifysolutions.com/public/api/v1

First API request

Check your credit balance. Accepts a Business API Key or Branch API Key.

cURL

curl --request GET \
  --url "https://altitax.altifysolutions.com/public/api/v1/credits/balance" \
  --header "X-API-Key: YOUR_BUSINESS_API_KEY" \
  --header "Accept: application/json"

Example response

JSON

{
  "status": "success",
  "data": {
    "business_id": "business_01HXXXXXXXXXXXXXXXXXXXXX",
    "business_name": "Acme Trading Ltd",
    "credits_balance": 125,
    "currency": "KES",
    "last_transaction": "2026-03-10T12:00:00.000000Z"
  }
}

API capabilities

Public resource groups available in the interactive API Reference.

Open API Reference →

Business

List branches for the authenticated business.
Credits & Subscriptions

Check the credit balance for the authenticated business.
Customers

List, create, retrieve, and update customers; look up taxpayer information.
Suppliers

Manage suppliers used across purchases and sourcing.
Items / Products

Create and manage products; item codes are generated automatically and prices are tax-inclusive.
Inventory & Stock

Adjust item stock or transfer stock between branches using public item and branch IDs.
Sales

Create sales and sales credit notes; retrieve sales and credit-note details.
Purchases

Pull and retrieve purchases synchronized from eTIMS/KRA.
Reverse Invoicing

Create reverse invoices and reverse-invoice credit notes, then sync to KRA/eTIMS.
Imported Items

Retrieve and sync imported-item records for clearance workflows.
Notices

View KRA notices stored locally for your business.

Typical credit costs

Chargeable operations deduct credits from the business balance.

Sale / invoice: 5
Credit note: 5
Purchase: 3
Stock movement: 2