API reference - One Stop Invoice

Jump to section

Try-it console Same-origin /v1

API key

Stored in localStorage only · sent as Authorization: Bearer …

Production API base

https://api.onestopinvoice.com/v1

Use this URL in apps and integrations.

Meta 1 endpoint

GET /v1/me

Returns the account tied to your API key (id, business name, email, currency, GSTIN, PAN, subscription). PAN is the account business PAN (same for all documents).

Example response

{
    "ok": true,
    "data": {
        "account_id": 1,
        "business_name": "Demo Traders",
        "business_email": "hello@example.com",
        "currency": "INR",
        "business_gstin": "27AAAAA0000A1Z5",
        "business_pan": "AAAAA9999A",
        "subscription_expires_at": "2026-12-31 23:59:59"
    }
}

Clients 5 endpoints

GET /v1/clients

Paginated clients. Query: limit (max 200, default 50), offset.

Example response

{
    "ok": true,
    "data": {
        "clients": [
            {
                "client_id": 10,
                "name": "Ravi Kumar",
                "phone": "9876543210",
                "email": "ravi@client.test",
                "gstin": null
            }
        ],
        "total": 1
    }
}

POST /v1/clients

Create client (name, phone, email required). Optional: address, gstin (15-char format when used). Duplicate phone (10 digits), email, or GSTIN → 200 with data.skipped true and data.client = existing row.

Body (JSON)

Example response

{
    "ok": true,
    "data": {
        "skipped": false,
        "client": {
            "client_id": 11,
            "name": "Acme Retail Pvt Ltd",
            "phone": "9876543210",
            "email": "billing@acme.example",
            "address": "Shop 12, MG Road, Bengaluru 560001",
            "gstin": null,
            "state_code": null
        }
    }
}

GET /v1/clients/{id}

Single client by id.

Path

Client id

Example response

{
    "ok": true,
    "data": {
        "client_id": 10,
        "name": "Ravi Kumar",
        "phone": "9876543210",
        "email": "ravi@client.test"
    }
}

PATCH /v1/clients/{id}

Partial update (JSON merged).

Path

Client id

Body (JSON)

Example response

{
    "ok": true,
    "data": {
        "client_id": 10,
        "name": "Ravi K. (updated)"
    }
}

DELETE /v1/clients/{id}

Delete client. Query cascade=1 to remove related invoices/quotations/debit notes.

Path

Client id

Example response

{
    "ok": true,
    "data": {
        "deleted": true
    }
}

Invoices 5 endpoints

GET /v1/invoices

List invoices. Query: limit, offset, client_id. Rows are DB columns (no line items on list).

Example response

{
    "ok": true,
    "data": {
        "invoices": [
            {
                "invoice_id": 101,
                "client_id": 10,
                "invoice_number": "INV-2026-0042",
                "invoice_date": "2026-03-21",
                "payment_due_date": "2026-04-05",
                "payment_status": "pending",
                "status": "draft",
                "currency": "INR"
            }
        ],
        "total": 1
    }
}

POST /v1/invoices

Create invoice. Required: client_id, invoice_date, payment_due_date (Y-m-d). Each items[] row needs item_description (non-empty) or the row is skipped. Send tax splits your app already calculated (CGST+SGST for intra-state, or IGST). Optional: transport_details, lr_number (per document). Business PAN is not on the invoice; use GET /me business_pan. Optional: discount_type percentage|fixed + discount_value when DB supports it.

Body (JSON)

Example response

{
    "ok": true,
    "data": {
        "invoice_id": 101,
        "message": "created"
    }
}

GET /v1/invoices/{id}

Single invoice: header fields from invoices row plus items[] (invoice_items columns, ordered by item_id).

Path

Invoice id

Example response

{
    "ok": true,
    "data": {
        "invoice_id": 101,
        "client_id": 10,
        "invoice_number": "INV-2026-0042",
        "invoice_date": "2026-03-21",
        "payment_due_date": "2026-04-05",
        "currency": "INR",
        "items": [
            {
                "item_id": 501,
                "invoice_id": 101,
                "item_description": "Professional services March",
                "hsn_code": "998314",
                "quantity": 1,
                "rate": 10000,
                "tax_rate": 18,
                "cgst_amount": 900,
                "sgst_amount": 900,
                "igst_amount": 0,
                "total_amount": 11800
            }
        ]
    }
}

PATCH /v1/invoices/{id}

Partial update.

Path

Invoice id

Body (JSON)

Example response

{
    "ok": true,
    "data": {
        "invoice_id": 101
    }
}

DELETE /v1/invoices/{id}

Delete invoice.

Path

Invoice id

Example response

{
    "ok": true,
    "data": {
        "deleted": true
    }
}

Quotations 5 endpoints

GET /v1/quotations

List quotations. Query: limit, offset, client_id. Rows omit line items (use GET /quotations/{id} for items[]).

Example response

{
    "ok": true,
    "data": {
        "quotations": [
            {
                "quotation_id": 55,
                "client_id": 10,
                "quotation_number": "QT-2026-0007",
                "quotation_date": "2026-03-21",
                "validity_date": "2026-04-21",
                "approval_status": "pending",
                "currency": "INR"
            }
        ],
        "total": 1
    }
}

POST /v1/quotations

Create quotation. Required: client_id, quotation_date. validity_date defaults to quotation_date if omitted. items[] uses the same keys as invoice line items; each row must have item_description or it is ignored. Optional: transport_details, lr_number (per document). Business PAN from GET /me.

Body (JSON)

Example response

{
    "ok": true,
    "data": {
        "quotation_id": 55
    }
}

GET /v1/quotations/{id}

Single quotation header plus items[] (quotation_items columns).

Path

Quotation id

Example response

{
    "ok": true,
    "data": {
        "quotation_id": 55,
        "client_id": 10,
        "quotation_number": "QT-2026-0007",
        "quotation_date": "2026-03-21",
        "validity_date": "2026-04-21",
        "currency": "INR",
        "items": [
            {
                "item_id": 8801,
                "quotation_id": 55,
                "item_description": "Annual maintenance (quoted)",
                "hsn_code": "9987",
                "quantity": 1,
                "rate": 50000,
                "tax_rate": 18,
                "cgst_amount": 4500,
                "sgst_amount": 4500,
                "igst_amount": 0,
                "total_amount": 59000
            }
        ]
    }
}

PATCH /v1/quotations/{id}

Path

Quotation id

Body (JSON)

Example response

{
    "ok": true,
    "data": {
        "quotation_id": 55
    }
}

DELETE /v1/quotations/{id}

Path

Quotation id

Example response

{
    "ok": true,
    "data": {
        "deleted": true
    }
}

Debit notes 5 endpoints

GET /v1/debit-notes

List debit notes. Query: limit, offset, client_id.

Example response

{
    "ok": true,
    "data": {
        "debit_notes": [
            {
                "debit_note_id": 7,
                "client_id": 10,
                "debit_note_number": "DN-3",
                "debit_note_date": "2026-03-21",
                "currency": "INR"
            }
        ],
        "total": 1
    }
}

POST /v1/debit-notes

Create debit note with line items. Optional: transport_details, lr_number (per document). Business PAN from GET /me.

Body (JSON)

Example response

{
    "ok": true,
    "data": {
        "debit_note_id": 7
    }
}

GET /v1/debit-notes/{id}

Debit note with items[] (description, expense_date, amount per line).

Path

Debit note id

Example response

{
    "ok": true,
    "data": {
        "debit_note_id": 7,
        "client_id": 10,
        "debit_note_date": "2026-03-21",
        "currency": "INR",
        "items": [
            {
                "item_id": 120,
                "debit_note_id": 7,
                "description": "Rate difference adjustment",
                "expense_date": "2026-03-21",
                "amount": 500
            }
        ]
    }
}

PATCH /v1/debit-notes/{id}

Path

Debit note id

Body (JSON)

Example response

{
    "ok": true,
    "data": {
        "debit_note_id": 7
    }
}

DELETE /v1/debit-notes/{id}

Path

Debit note id

Example response

{
    "ok": true,
    "data": {
        "deleted": true
    }
}

Inventory 5 endpoints

GET /v1/inventory

List inventory rows (products/services).

Example response

{
    "ok": true,
    "data": {
        "items": [
            {
                "inventory_id": 3,
                "name": "Widget A",
                "type": "product",
                "rate": 250,
                "quantity": 100,
                "tax_rate": 18,
                "hsn_code": "1234"
            }
        ],
        "total": 1
    }
}

POST /v1/inventory

Create product/service line.

Body (JSON)

Example response

{
    "ok": true,
    "data": {
        "inventory_id": 3
    }
}

GET /v1/inventory/{id}

Path

Inventory id

Example response

{
    "ok": true,
    "data": {
        "inventory_id": 3,
        "name": "Widget A"
    }
}

PATCH /v1/inventory/{id}

Path

Inventory id

Body (JSON)

Example response

{
    "ok": true,
    "data": {
        "inventory_id": 3
    }
}

DELETE /v1/inventory/{id}

Path

Inventory id

Example response

{
    "ok": true,
    "data": {
        "deleted": true
    }
}

Expenses 5 endpoints

GET /v1/expenses

List expenses.

Example response

{
    "ok": true,
    "data": {
        "expenses": [
            {
                "expense_id": 9,
                "expense_description": "Office supplies",
                "expense_amount": 1200,
                "expense_date": "2026-03-20",
                "expense_category": "General"
            }
        ],
        "total": 1
    }
}

POST /v1/expenses

Create expense.

Body (JSON)

Example response

{
    "ok": true,
    "data": {
        "expense_id": 9
    }
}

GET /v1/expenses/{id}

Path

Expense id

Example response

{
    "ok": true,
    "data": {
        "expense_id": 9
    }
}

PATCH /v1/expenses/{id}

Path

Expense id

Body (JSON)

Example response

{
    "ok": true,
    "data": {
        "expense_id": 9
    }
}

DELETE /v1/expenses/{id}

Path

Expense id

Example response

{
    "ok": true,
    "data": {
        "deleted": true
    }
}

Sendouts 1 endpoint

POST /v1/sendouts

Queue email with PDF for invoice, quotation, or debit-note.

Body (JSON)

Example response

{
    "ok": true,
    "data": {
        "success": true,
        "message": "Email queued",
        "queue_id": 42
    }
}

Analytics 1 endpoint

GET /v1/analytics/summary

Dashboard-style aggregates (same idea as legacy get-analytics).

Example response

{
    "ok": true,
    "data": {
        "total_invoices": 12,
        "total_revenue": 450000,
        "note": "Shape matches your live deployment"
    }
}