API Reference
All Lumeo API endpoints, grouped by domain.
TODO — wire to real OpenAPI spec
This section is scaffolded for fumadocs-openapi generation. It currently points at
a placeholder spec path (../../backend/openapi.json) that does not exist yet. The
NestJS backend needs SwaggerModule/DocumentBuilder wired up (see
backend/src/main.ts) before this can auto-generate from real endpoints. Until then,
pages in this section are hand-written placeholders.
Lumeo's API has 150+ endpoints across 6 domains. Each domain groups endpoints by the resource they operate on, not by the underlying microservice.
Payments
Create payouts, check status, list transactions.
Compliance
FIRA, GST, ITR-4 prefill, 44ADA presumptive tax.
Ledger
Account balances, ledger entries, reconciliation status.
Tax
Tax liability calculation and filing-ready exports.
Webhooks
Event types, payload shapes, retry behavior.
Accounts
User and organization account management.
Authentication
All endpoints require a Bearer API key. See Authentication.
Errors
Lumeo uses conventional HTTP status codes. 4xx codes indicate a problem with the request (bad input, missing auth, insufficient scope); 5xx codes indicate a problem on Lumeo's side.
TODO — confirm real error schema
Document the actual error response shape (error code enum, message format) once confirmed against the NestJS exception filter.