1. 🔌 Developer API
  2. 🧾 Invoices API
MudraHQ AppAdmin ConsoleGitHub
  • 🔌 API Reference Overview
  • 🧾 Invoices API
  • ⚖️ Statutory Privacy API

🧾 Invoices API

REST API endpoints for creating, searching, updating, and settling GST-compliant tax invoices.

Loading documentation…

🔌 API Reference Overview< Previous⚖️ Statutory Privacy APINext >

Powered by heyo-docs

On this page

1. List InvoicesQuery ParametersSample Response2. Create Tax InvoiceRequest BodyResponse

The Invoices API allows merchants to programmatically issue tax invoices, compute GST splits, retrieve billing ledgers, and manage payment states.


1. List Invoices

GET /api/invoices

Retrieve a paginated list of invoices with optional search, status filtering, and date range query parameters.

Query Parameters

  • status (optional): Filter by status (DRAFT, SENT, PAID, PARTIALLY_PAID, OVERDUE, CANCELLED).
  • customerId (optional): Filter bills for a specific customer.
  • search (optional): Search by invoice number or customer name.
  • page (optional): Page number (defaults to 1).
  • limit (optional): Page size (defaults to 20).

Sample Response

json
{  "invoices": [    {      "id": "cmudmwabc0001",      "invoiceNo": "INV-2026-0001",      "date": "2026-09-24T00:00:00.000Z",      "dueDate": "2026-10-09T00:00:00.000Z",      "status": "PAID",      "subtotal": 8400.00,      "cgst": 756.00,      "sgst": 756.00,      "igst": 0.00,      "total": 9912.00,      "paidAmount": 9912.00,      "balanceAmount": 0.00,      "customer": {        "id": "cmudcust001",        "name": "Kalyan Infra Projects",        "phone": "+91 9733445566"      }    }  ],  "total": 1,  "page": 1,  "totalPages": 1}

2. Create Tax Invoice

POST /api/invoices

Creates a new sequential tax invoice, computes applicable CGST/SGST or IGST tax breakdowns, decrements inventory stock, and generates a dynamic UPI payment QR code.

Request Body

json
{  "customerId": "cmudcust001",  "date": "2026-09-24",  "dueDate": "2026-10-09",  "items": [    {      "productId": "cmudprod001",      "name": "Industrial Rotary Hammer Drill 850W",      "quantity": 2,      "unitPrice": 4200.00,      "taxRate": 18,      "hsn": "8467"    }  ],  "notes": "Payment due within 15 days of delivery."}

Response

json
{  "message": "Invoice created successfully",  "invoice": {    "id": "cmudmwabc0002",    "invoiceNo": "INV-2026-0002",    "total": 9912.00,    "status": "SENT",    "publicUrl": "https://mudrahq.tech/view/cmudmwabc0002"  }}