API Endpoints Directory

All routes are mounted under the /api prefix and require a Bearer token unless explicitly marked public.

1. Authentication & Identity (/auth)

Method	Endpoint	Description
POST	/api/auth/login	Email/password login; returns JWT and user context
POST	/api/auth/pin	Quick 4-digit POS counter PIN login
POST	/api/auth/logout	Revokes current session token
GET	/api/auth/session	Validates session token and returns active user and tenant
POST	/api/auth/manager-override	Ephemeral high-privilege manager approval
DELETE	/api/auth/sessions/:id/revoke	Revokes active concurrent device session

2. Organization & Workspace

Method	Endpoint	Description
GET	/api/tenants	List accessible tenants for authenticated user
PATCH	/api/tenants/:id	Update tenant details, trade name, GSTIN, and currency
GET	/api/branches	List branches for active tenant
POST	/api/branches	Create a new store branch / warehouse outlet
GET	/api/users	List staff and cashiers across branches
POST	/api/users	Invite user or create counter cashier
GET	/api/roles	List RBAC roles and granular permission sets

3. Catalog & Products

Method	Endpoint	Description
GET	/api/products	Paginated product search with barcode, SKU, category filters
POST	/api/products	Create product with HSN code, tax rate, cost and selling prices
GET	/api/products/:id	Get full product details
PATCH	/api/products/:id	Update product attributes
DELETE	/api/products/:id	Soft-delete product
GET	/api/categories	List product categories
POST	/api/categories	Create hierarchical category
GET	/api/uoms	List Units of Measure (e.g. PCS, KG, BOX) (alias: /api/units)

4. Sales & Counter Billing

Method	Endpoint	Description
POST	/api/sales	Create complete sale transaction with atomic inventory decrement
GET	/api/sales	Paginated sale invoice search
GET	/api/sales/:id	Get invoice details with line items, tax split, and payments
GET	/api/sales/:id/invoice	Branded HTML / PDF thermal invoice representation
POST	/api/sales/hold	Suspend current cart and issue held ticket number
GET	/api/sales/holds	List active held tickets for current register
PATCH	/api/sales/:id/payment	Apply subsequent payment to pending credit sale
POST	/api/sales/:id/credit-note	Issue sales return credit note

5. Cash Register & Shift Operations (/register)

Method	Endpoint	Description
GET	/api/register/status	Current register status and active shift summary
POST	/api/register/open	Open new shift with initial cash float
POST	/api/register/cash-movement	Record Pay-In or Pay-Out
POST	/api/register/cash-drop	Drop excess cash into branch drop safe
GET	/api/register/x-report	Mid-shift financial tally without closing drawer
POST	/api/register/handover	Blind shift handover with physical note denomination count
POST	/api/register/close	Lock shift and generate final Z-Report
POST	/api/register/z-report/dispatch-owner	Email daily Z-Report PDF to tenant owner

6. Inventory & Warehousing (/inventory)

Method	Endpoint	Description
GET	/api/inventory/overview	Branch stock levels, valuation, and low-stock indicators
GET	/api/inventory/movements	Historical stock ledger movements
POST	/api/inventory/adjustments	Manual stock variance adjustment (damage, shrinkage)
GET	/api/inventory/audits	List physical stocktaking audit sessions
POST	/api/inventory/audits	Start a new stocktaking audit cycle
POST	/api/inventory/audits/:id/scans	Record barcode count scan
POST	/api/inventory/audits/:id/reconcile	Approve and reconcile physical count variances
POST	/api/inventory/transfers	Initiate inter-branch stock transfer
POST	/api/inventory/rtv	Return to vendor with automatic debit note creation

7. Purchases & Vendors (/purchases)

Method	Endpoint	Description
GET	/api/purchases	List purchase orders and vendor bills
POST	/api/purchases	Create purchase order
PATCH	/api/purchases/:id/receive	Receive goods into inventory and record supplier invoice
POST	/api/purchases/:id/payment	Record vendor accounts payable settlement
POST	/api/purchases/:id/debit-note	Issue debit note against supplier invoice

8. Parties & Accounts

Method	Endpoint	Description
GET	/api/customers	Search customer directory
POST	/api/customers	Create customer with GSTIN validation
GET	/api/customers/lookup	Quick phone/GSTIN lookup at counter
GET	/api/customers/:id/statement	Chronological customer statement of account (SOA)
GET	/api/suppliers	Search supplier directory
GET	/api/suppliers/:id/statement	Supplier statement of account

9. Enterprise Documents

Method	Endpoint	Description
GET	/api/quotations	List sales quotations
POST	/api/quotations	Create sales quotation
POST	/api/quotations/:id/convert-to-sale	Convert accepted quotation into sale
GET	/api/delivery-challans	List delivery challans
POST	/api/delivery-challans/:id/convert-invoice	Convert delivery challan into tax invoice
GET	/api/eway-bills/:id/json	NIC-compatible JSON payload for E-Way portal
GET	/api/gift-cards/balance/:code	Fast gift card balance verification
POST	/api/gift-cards/redeem	Deduct amount from gift card

10. Reports & Analytics (/reports)

Method	Endpoint	Description
GET	/api/reports/summary	Executive high-level sales and revenue metrics
GET	/api/reports/revenue-by-day	Daily revenue trends
GET	/api/reports/pnl	Profit and loss analysis
GET	/api/reports/aging-analysis	Accounts receivable and payable aging buckets (30/60/90 days)
GET	/api/reports/dead-stock	Dormant inventory without sales activity
GET	/api/reports/export	Export sales or inventory data to CSV/Excel