Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt

Use this file to discover all available pages before exploring further.

March 30, 2026 Documentation update Action required

​
Affects

Teams using affected Midaz APIs or planning Cycle 6 integration changes. This update applies to the public documentation portal. It does not change the runtime API behavior unless the linked product documentation says otherwise.

​
What changed

The Midaz API documentation has been updated to reflect all changes shipped in Cycle 6. This includes new endpoints, updated schemas, additional query filters, and new error codes — all localized in English, Portuguese, and Spanish.

​
New endpoints

​
Ledger Settings

Two new endpoints allow you to manage per-Ledger validation rules via the API: These endpoints control whether Account Type validation and Route validation are enforced for a specific Ledger.

​
Balance History

Two new endpoints support point-in-time balance queries for auditing, reconciliation, and historical reporting:
The date parameter is required and must follow the format yyyy-mm-dd hh:mm:ss. If no balance data exists for the specified timestamp, a 404 error is returned.

​
Updated schemas

​
Transaction Routing

  • Operation Routes now include accountingEntries and support a bidirectional route type
  • Transaction Routes use a new operationRoutes object format
  • Operations include new fields: direction, routeId, and routeCode
The Transaction Routing guide was updated to reflect the new structure and behavior.

​
New query filters

EndpointNew filters
List Organizationslegal_name, doing_business_as
List Ledgersname
List Operationsdirection, route_id

​
New error codes

Error codes 0140–0158 were added to the error reference, covering validation failures for the new Ledger Settings and routing features.

​
OpenAPI spec alignment

All published OpenAPI specs were aligned with the actual codebase versions:
SpecUpdated to
Ledgerv3.5.0
CRMlatest stable
Fees Enginelatest stable
Access Managerlatest stable

​
Impact

This documentation update includes information teams should review before changing the affected integration or deployment.

​
What you need to do

1
Review new Ledger Settings, Balance History, Transaction Routing, filters, and error documentation before your next Midaz integration change.

​
Deadline

Before your next related integration, deployment, or upgrade change.

​
Why

The public documentation was updated to reflect Cycle 6 API behavior and endpoint coverage.