API Reference

Every endpoint, grouped by resource. Click through for params, examples, and response shapes — or jump straight to the Swagger UI Try-It-Out console.

Open Swagger UI OpenAPI JSON

Base URL

https://api.finzbooks.com/api/public/v1

Every endpoint below is relative to that base. All responses follow the shape described in Response envelope.

Resource groups

Contacts6 routes

Customers + vendors with nested addresses & contact persons.

Items & Taxes7 routes

Item master, HSN/SAC, GST tax catalogue, accounts read-only.

Invoices7 routes

Create, approve, void; item-driven line auto-fill.

Vendor bills, AP, RCM, ITC-blocked routing.

Payments5 routes

Customer receipts + vendor payments, unified resource.

Expenses5 routes

Direct cash/bank payments with itemised breakdown.

Estimates7 routes

Quotes with accept + convert-to-SO.

Credit & Debit Notes10 routes

GST-compliant reversal documents.

Sales & Purchase Orders11 routes

SO + PO with convert-to-invoice / convert-to-bill.

Journals & Accounts6 routes

Manual JE posting + Chart of Accounts read.

Reports14 routes

P&L, Balance Sheet, AR/AP aging, GSTR-1/3B, ledger.

Lookups6 routes

Branches, bank accounts, cost centers, currencies.

Bulk operations2 routes

Bulk-create invoices + bills with per-row error isolation.

Inline / attachment PDF download for every customer-facing doc.

Email send3 routes

Mail invoice / estimate / credit note with PDF attached.

Attachments4 routes

Generic file uploads stapled to any document.

Recurring schedules8 routes

Auto-generate invoices / bills on a cron-like cadence.

Activity timeline8 routes

Audit-log stream per document; sidebar history feed.

Comments5 routes

Inline notes stapled to any document. Author-gated edit / delete.

Conventions

Every request needs Authorization: Bearer aibk_pat_… (or aibk_oat_…). Multi-org tokens also require ?organization_id=<id>.
Single resources return { code: 0, <name>: {…} }; lists return { code: 0, <plural>: [...], page_context }.
POSTs accept an Idempotency-Key header. See Idempotency.
Errors are flat { code, message, field?, details? }. See Errors for the catalog.