Lumeo Docs

Changelog

API changes, versioned and dated.

Lumeo uses date-based API versioning. The current version is 2026-07. Breaking changes are introduced only with a new version and announced here at least 30 days in advance.

2026-07-01: 2026-07

Initial public release of the Lumeo developer API.

New endpoints

  • POST /payments/initiate: record a payout intent
  • POST /payments/confirm: trigger compliance check and settlement
  • GET /payments/payouts/:id: fetch payment status
  • GET /compliance/fira/:firaId: fetch an auto-generated FIRA
  • GET /compliance/gst/summary: year-to-date GST position
  • GET /compliance/itr4/prefill: ITR-4 (44ADA) prefill data
  • GET /ledger/accounts/:id/balance: account balance (paise, integer)
  • GET /ledger/accounts/:id/entries: paginated journal entries
  • GET /ledger/reconciliation/:paymentId: reconciliation status
  • POST /ledger/reconciliation/:paymentId/resolve: manual reconciliation resolution
  • GET /tax/liability: estimated income tax liability
  • GET /tax/sequestration: sequestration reserve balance
  • POST /tax/sequestration/policy: configure sequestration rate
  • GET /tax/exports/gst3b: GST-3B-ready JSON export
  • GET /tax/exports/itr4: ITR-4-ready JSON export
  • POST /webhooks: register a webhook endpoint
  • GET /webhooks/:id/deliveries: delivery log with retry history

Webhook events (initial set)

payout.initiated, payout.confirmed, payout.settled, payout.failed, payout.manual_review, fira.generated, reconciliation.completed, reconciliation.pending, tax.updated, yield.allocated

SDKs

  • @lumeo/sdk v1.0.0: TypeScript / Node.js

Upcoming

The following are planned for a future release. They are not stable and not yet available in sandbox:

  • GET /payments/payouts: paginated list with date/status filtering
  • POST /payments/payouts/:id/cancel: cancel a payment before settlement
  • Batch payout endpoint: up to 50 recipients in a single call
  • Python and Go SDKs
  • Yield allocation API: configure and query yield instrument allocation

On this page