API Reference

Inkvoice exposes a REST API at /api/v1/. All endpoints return JSON.

Base URL

https://your-domain.com/api/v1

Authentication

Most endpoints require a valid JWT token. Obtain one via the login endpoint.

Include the token as a cookie (set automatically by the login response) or as a Bearer token:

Authorization: Bearer <token>

Response Format

All responses follow a consistent format:

Success

{
  "success": true,
  "data": { ... }
}

Error

{
  "success": false,
  "error": "Description of what went wrong"
}

Paginated Lists

{
  "success": true,
  "data": [ ... ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 142
  }
}

Common Query Parameters

Parameter	Description
page	Page number (default: 1)
limit	Items per page (default: 20)
search	Search term (applies to name, email, etc.)
sort	Sort field
order	Sort direction (asc or desc)

Endpoints

Section	Base Path
Authentication	/api/v1/auth
Invoices	/api/v1/invoices
Quotes	/api/v1/quotes
Customers	/api/v1/customers
Products	/api/v1/products
Templates	/api/v1/templates
Settings	/api/v1/settings
Reports	/api/v1/reports

Public Endpoints

These endpoints do not require authentication:

Method	Path	Description
GET	/api/v1/public/invoices/:shareToken	View shared invoice
POST	/api/v1/public/invoices/:shareToken/pay	Initiate Stripe payment
GET	/api/v1/public/invoices/:shareToken/preview	Invoice PDF preview
GET	/api/v1/public/quotes/:shareToken	View shared quote
GET	/api/v1/public/quotes/:shareToken/preview	Quote PDF preview
GET	/health	Health check