Retaela, Powering Retail Intelligence
API ReferenceGuidesStatusDashboard
Get Started

Ushuru Docs

Getting Started

IntroductionAuthenticationQuick Start

How-To Guides

How eTIMS WorksCreate an eTIMS InvoiceRegister ItemsCredit Notes & ReturnsReverse InvoicingInvoice VerificationFAQ

API Reference

System

Check API healthGETGet service statusGET

Initialization

Initialize devicePOSTSetup with serialPOST

Sales

Add a salePOSTGet salesGETGet sales purchasesGETGet sales transactionsGETGet invoice detailsGETAdd sale with item informationPOSTGet a saleGETOffline URL for salesGETGet sales summaryGET

Credit Notes

Add credit notePOSTAdd express credit notePOSTAdd credit note with barcodesPOSTGet credit notesGET

Reverse Invoices

Add reverse invoicePOSTAdd reverse invoice with itemsPOSTGet a reverse invoiceGETGet reverse invoicesGET

Reverse Credit Notes

Add reverse credit notePOSTAdd reverse credit note barcodesPOSTGet reverse credit notesGET

Invoice Verifications

Verify an invoicePOSTGet invoice verificationsGET

Items

Create an itemPOSTRegister a service itemPOSTRegister a goods itemPOSTGet list of itemsGETGet a specific itemGETUpdate an itemPUT

Customers

Look up a customer PINGETGet a list of customersGETSave a customerPOSTGet a customerGETUpdate a customerPATCH

Suppliers

Get a list of suppliersGETSave a supplierPOSTGet a supplierGET

Purchases

Get purchase listGETConfirm a purchasePOSTGet a specific purchaseGETLink purchase itemPOST

Imports

Get import items from eTIMSGETLink import itemPUT

Stock

Record stock movementPOSTUpdate stock quantityPUTActivate stock masterPUTSave stock master (full)PUTGet stock itemsGETGet stock movementsGETTransfer stockPOST

Reference Data

Sync reference dataPOSTGet code tablesGETSync fresh codesGETGet item classificationsGETGet taxpayer infoGETGet Kenya Revenue Authority noticesGETGet branch listGETSave branch userPOSTSave branch insurancePOSTGet eTIMS business infoGET

KRA Utilities

PIN checkerGETVAT exemption checkGETTCC checkGETInvoice checkerGET

Reference

Receipt FieldsError CodesTax TypesItem ClassificationPackaging & Quantity UnitsTransaction Status CodesReceipt Requirements

Documentation

Ushuru eTIMS API

Complete reference for the Ushuru Kenya Revenue Authority eTIMS OSCU integration API. Submit invoices, register items, and stay compliant with Kenya Revenue Authority requirements.

Base URL

http://localhost:8100/api/v1

Version: v1.0

Format: JSON

Key Endpoints

GET
/api/v1/health

Check service availability

GET
/api/v1/status

Device and taxpayer status

POST
/api/v1/initialize

Initialize device and sync reference data

POST
/api/v1/sync

Sync latest reference data from Kenya Revenue Authority

GET
/api/v1/codes

Fetch Kenya Revenue Authority code lookup tables

GET
/api/v1/customers/:pin

Look up a buyer by Kenya Revenue Authority PIN

POST
/api/v1/items/service

Register a service item

POST
/api/v1/items/goods

Register a physical goods item

GET
/api/v1/items

List all registered items

POST
/api/v1/sales

Submit a sales invoice to Kenya Revenue Authority

POST
/api/v1/sales/credit-note

Issue a credit note for a prior sale

GET
/api/v1/purchases

Fetch incoming purchase invoices

POST
/api/v1/purchases

Confirm receipt of a purchase invoice

POST
/api/v1/stock/io

Record a stock movement transaction

PUT
/api/v1/stock/master

Update master stock quantity for an item

67 endpoints documented. Use the sidebar to browse the full API reference.