Katixo/API DocumentationBeta

Katixo API

Build integrations with Katixo's product suite. Each product exposes its own REST API with shared authentication, response format, and conventions.

Beta notice: The Katixo APIs are in active development. Endpoints documented here are stable, but new endpoints and fields may be added. Breaking changes will be announced with at least 30 days notice via the changelog.

Products

Choose a product to explore its API reference.

📒

Katasticho ERP

Invoicing, contacts, items, inventory, GST, purchase bills, expenses, workflows — the full accounting and billing API.

🏥

Hospital OS

Beta

Patient management, OPD, IPD, laboratory, operation theatre, pharmacy, and hospital billing.

Shared platform

Authentication

JWT tokens, OTP login, refresh flow, and role-based access.

Errors

Error response format, HTTP status codes, and validation.

Base URLs

Katasticho ERP

https://api.katixo.com/api/v1

Hospital OS

https://hospital.katixo.com/api/v1

All API requests must be made over HTTPS. HTTP requests are rejected.

Quick start

1. Register and sign in to get a JWT access token (see Authentication).

2. Make your first request:

curl https://api.katixo.com/api/v1/invoices \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIs..." \
  -H "Content-Type: application/json"

Response format

All APIs share a standard ApiResponse envelope:

{
  "success": true,
  "message": "Resource retrieved successfully",
  "data": { ... },
  "errors": null
}

On error, success is false and the errors field contains validation details:

{
  "success": false,
  "message": "Validation failed",
  "data": null,
  "errors": {
    "invoiceDate": "must not be null",
    "contactId": "must not be null"
  }
}

Katasticho ERP resources

Invoices

Create, send, cancel, and manage GST-compliant invoices.

Items

Product catalog with HSN codes, pricing, batches, and BOM.

Contacts

Manage customers, vendors, GST details, and contact persons.

Inventory

Batch tracking, expiry alerts, and available stock queries.

GST & Tax

GST review center, GSTR-1, GSTR-3B data and exports.

Purchase Bills

Record purchase bills, manage attachments, and bulk post.

Expenses

Track and categorize business expenses.

Recurring Invoices

Automate invoice generation on a schedule.

Hospital OS resources

Overview

Hospital OS platform architecture and getting started.

Patients

Patient registration, search, and medical records.

OPD

Appointments, queue management, and consultations.

IPD

Admissions, bed management, and discharge summaries.

Laboratory

Test orders, sample tracking, and lab reports.

Billing

Patient billing, packages, payments, and receipts.

Conventions

Pagination — List endpoints return paginated results using Spring Pageable. Use page (0-indexed), size, and sort query parameters. Default page size is 20.

Paginated response — Paginated endpoints return a PagedResponse inside the data field:

{
  "success": true,
  "message": "...",
  "data": {
    "content": [ ... ],
    "page": 0,
    "size": 20,
    "totalElements": 142,
    "totalPages": 8,
    "last": false
  },
  "errors": null
}

Dates — Timestamps use ISO 8601 format. Financial dates use YYYY-MM-DD (LocalDate). Audit timestamps use Instant format.

Amounts — All monetary amounts use BigDecimal with up to 2 decimal places. 1234.56 represents ₹1,234.56.

IDs — All resource IDs are UUIDs (e.g., 550e8400-e29b-41d4-a716-446655440000).

Multi-tenancy — The tenant, group, and branch context is embedded in your JWT token. Both products share the same security and tenant library.