May 19, 2026 Documentation update No migration requiredDocumentation Index
Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt
Use this file to discover all available pages before exploring further.
Affects
Teams building statement experiences with Midaz account operations, including integrators, solution architects, backend engineers, and product teams defining account activity views. This update applies to the public documentation portal. It does not change Midaz runtime API behavior.
What changed
New statement-building guide
Midaz now has a dedicated guide for building account statements from ledger operations. The guide explains how to:- Retrieve account operations for a specific period
- Apply query filters and pagination
- Transform each operation into a statement row
- Use
directionto display incoming and outgoing values - Treat
ON_HOLDandRELEASEas balance lock and release events - Keep settled statement views focused on operations with
balanceAffected=true - Add business context through transaction metadata
Clearer customer-facing framing
The page makes the core model explicit: Midaz returns ledger events. The integrating system turns those events into the statement experience that end users see. This avoids treating the operations endpoint as a ready-made statement screen. It is the source data for a statement.Practical examples
The guide includes a flow view, field mapping, display rules, pagination guidance, metadata examples, and a sample statement output. Before Teams had the API reference for listing account operations, but no single guide that connected those operations to a user-facing statement. After Teams can follow one page to move from account operations to a rendered statement view.Impact
This is a documentation-only update. No migration is required. Existing Midaz integrations keep working as they do today. Use the new guide when designing, implementing, or reviewing account statement experiences that use Midaz account operations.
What you need to do
Review the new account statement guide if your product displays account activity, balances, or transaction history to end users.
Use
direction, not type, to decide whether a value appears as incoming or outgoing in the statement.Add business metadata when creating transactions if your statement needs user-friendly descriptions, counterparties, channels, categories, or payment references.