# Lerian

## Docs

- [Our plugins](https://docs.lerian.studio/en/about-plugins.md): Explore the plugins available across Lerian products.
- [Our products](https://docs.lerian.studio/en/about-products.md): Discover the source-available Lerian products — Midaz, Reporter, Matcher, Flowker, and Tracer — and how they compose into a financial platform.
- [January 2026](https://docs.lerian.studio/en/changelog/2026/2026-01.md)
- [February 2026](https://docs.lerian.studio/en/changelog/2026/2026-02.md)
- [March 2026](https://docs.lerian.studio/en/changelog/2026/2026-03.md)
- [April 2026](https://docs.lerian.studio/en/changelog/2026/2026-04.md)
- [Matcher documentation refresh](https://docs.lerian.studio/en/changelog/2026/matcher-doc-refresh.md): Complete documentation refresh for Matcher, covering guides, API reference, OpenAPI specification, and Lerian Console integration.
- [News](https://docs.lerian.studio/en/changelog/changelog.md)
- [2024 in review](https://docs.lerian.studio/en/changelog/releases-2024.md)
- [2025 in review](https://docs.lerian.studio/en/changelog/releases-2025.md)
- [Core Banking vision](https://docs.lerian.studio/en/core-banking-vision.md): Understand Lerian's vision for modern core banking, structured around four pillars — Ledger, transactional services, governance, and connectivity.
- [SaaS and BYOC](https://docs.lerian.studio/en/deployment-models.md): Understand how Lerian can be deployed: fully managed (SaaS) or in your own infrastructure (BYOC).
- [Compliance and audit](https://docs.lerian.studio/en/flowker/compliance-and-audit.md): How Flowker supports regulatory compliance with immutable audit trails, hash chain integrity, and validation-before-Ledger architecture.
- [Field mapping reference](https://docs.lerian.studio/en/flowker/field-mapping-reference.md): Complete reference for input mappings, output mappings, and data transformations in Flowker executor nodes.
- [Core concepts](https://docs.lerian.studio/en/flowker/flowker-concepts.md): Understand the building blocks of Flowker: workflows, nodes, edges, catalog, provider configurations, templates, executions, dashboard, and audit.
- [Getting started with Flowker](https://docs.lerian.studio/en/flowker/flowker-getting-started.md): Learn how Flowker automates financial operations through real business scenarios — from payment orchestration to fraud prevention.
- [Flowker in Lerian Console](https://docs.lerian.studio/en/flowker/flowker-in-lerian-console.md): Manage workflows visually through the Lerian Console — design, execute, monitor, and audit without writing API calls.
- [Observability in Flowker](https://docs.lerian.studio/en/flowker/flowker-observability-guide.md): Monitor workflow executions, step progress, and service health in Flowker — telemetry collected automatically with no manual instrumentation.
- [Integration guide](https://docs.lerian.studio/en/flowker/integration-guide.md): Connect external services to Flowker using executors. Configure authentication, test connectivity, and run workflows with real integrations.
- [Security](https://docs.lerian.studio/en/flowker/security.md): Protect Flowker workflows, data, and integrations with API Key authentication, per-executor credentials, and HTTPS-enforced endpoints.
- [Use cases](https://docs.lerian.studio/en/flowker/use-cases.md): Real-world business scenarios where Flowker transforms financial operations — from transaction validation to provider integration.
- [What is Flowker?](https://docs.lerian.studio/en/flowker/what-is-flowker.md): Orchestrate financial workflows with Flowker — automate anti-fraud checks, approvals, payment routing, and onboarding with full audit trails.
- [Why Flowker?](https://docs.lerian.studio/en/flowker/why-flowker.md): The business case for Flowker — how it reduces integration time, eliminates compliance gaps, and gives teams flexibility to move faster.
- [Workflow Design Guide](https://docs.lerian.studio/en/flowker/workflow-design-guide.md): Design Flowker workflows with confidence — node types, edges, real-world patterns, status transitions, and best practices for reliable orchestration.
- [Getting started](https://docs.lerian.studio/en/getting-started.md): Begin with Lerian — evaluate the platform, choose a deployment model, and run your first double-entry transaction with Midaz.
- [Glossary](https://docs.lerian.studio/en/glossary.md): Key financial and platform terms explained for non-technical audiences
- [Welcome](https://docs.lerian.studio/en/index.md): Explore Lerian Docs — guides, platform capabilities, and technical references for the entire Lerian ecosystem of source-available products.
- [Contexts and sources](https://docs.lerian.studio/en/matcher/configuration/matcher-contexts-and-sources.md): Learn how contexts define reconciliation scope and sources connect the systems that feed transaction data into Matcher.
- [Exception routing](https://docs.lerian.studio/en/matcher/configuration/matcher-exception-routing.md): Classify, assign, and escalate unmatched transactions with severity-based SLAs and routing to external workflow systems.
- [Fee rules](https://docs.lerian.studio/en/matcher/configuration/matcher-fee-rules.md): Model expected transaction fees so Matcher adjusts amounts before comparison and avoids false exceptions on predictable charges.
- [Field mapping](https://docs.lerian.studio/en/matcher/configuration/matcher-field-mapping.md): Translate source-specific transaction fields into Matcher's canonical schema so you can compare data consistently across systems.
- [Match rules](https://docs.lerian.studio/en/matcher/configuration/matcher-match-rules.md): Configure exact, tolerance, and date-lag rules to control how Matcher compares transactions across sources.
- [Multi-Tenant mode](https://docs.lerian.studio/en/matcher/configuration/matcher-multi-tenant.md): Run Matcher in multi-tenant mode to serve multiple clients with isolated databases, message brokers, caches, and storage.
- [Runtime configuration (Systemplane)](https://docs.lerian.studio/en/matcher/configuration/matcher-systemplane.md): View and modify Matcher's operational configuration at runtime through Systemplane, without restarting the service.
- [Generating reports](https://docs.lerian.studio/en/matcher/daily-reconciliation/matcher-generating-reports.md): Generate reconciliation summaries, match details, exception views, and audit trails to monitor outcomes and meet compliance needs.
- [Resolving exceptions](https://docs.lerian.studio/en/matcher/daily-reconciliation/matcher-resolving-exceptions.md): Review, prioritize, and resolve transactions Matcher couldn't reconcile automatically using severity, lifecycle, and audit-friendly actions.
- [Reviewing matches](https://docs.lerian.studio/en/matcher/daily-reconciliation/matcher-reviewing-matches.md): Interpret match results, understand confidence scores, and approve or reject proposed matches after a reconciliation run.
- [Uploading files](https://docs.lerian.studio/en/matcher/daily-reconciliation/matcher-uploading-files.md): Import transaction data into Matcher from CSV, JSON, or XML files using the supported field structure and ingestion rules.
- [Installing Matcher](https://docs.lerian.studio/en/matcher/getting-started/matcher-installation.md): Deploy Matcher in development and production using Docker Compose, environment variables, and the supported infrastructure stack.
- [Prerequisites](https://docs.lerian.studio/en/matcher/getting-started/matcher-prerequisites.md): Check the infrastructure, dependencies, and runtime requirements your environment needs before deploying Matcher.
- [Getting started with Matcher](https://docs.lerian.studio/en/matcher/getting-started/matcher-quick-start.md): Walk through the five-stage reconciliation lifecycle, from defining a context to resolving exceptions on your first match run.
- [Discovery](https://docs.lerian.studio/en/matcher/integrations/matcher-discovery.md): Use Discovery and Fetcher to detect external data sources, inspect their schemas, and pull transactions into Matcher automatically.
- [External sources](https://docs.lerian.studio/en/matcher/integrations/matcher-external-sources.md): Connect banks, payment gateways, ERPs, and other external systems to Matcher and ingest their transaction data.
- [Midaz integration](https://docs.lerian.studio/en/matcher/integrations/matcher-midaz-integration.md): Connect Matcher to Midaz Ledger to query transactions directly and reconcile them against external sources without file exports.
- [Webhooks and callbacks](https://docs.lerian.studio/en/matcher/integrations/matcher-webhooks-callbacks.md): Stream Matcher events to external tools and receive resolution callbacks to keep your reconciliation workflows in sync.
- [Architecture](https://docs.lerian.studio/en/matcher/matcher-architecture.md): Explore Matcher's modular monolith built on DDD, hexagonal architecture, and CQRS, with eight bounded contexts that evolve independently.
- [Matcher concepts](https://docs.lerian.studio/en/matcher/matcher-concepts.md): Understand the five core concepts that power Matcher: contexts, sources, field maps, rules, and matches.
- [Confidence scoring](https://docs.lerian.studio/en/matcher/reference/matcher-confidence-scoring.md): See how Matcher calculates a 0–100 confidence score from amount, currency, date, and reference checks to grade every match.
- [Multi-currency matching](https://docs.lerian.studio/en/matcher/reference/matcher-multi-currency.md): Reconcile transactions in different currencies by converting amounts to a common base before applying Matcher's matching rules.
- [Security](https://docs.lerian.studio/en/matcher/reference/matcher-security.md): Review Matcher's defense-in-depth security: authentication, RBAC, tenant isolation, encryption, and audit logging across every layer.
- [Split and aggregate matches](https://docs.lerian.studio/en/matcher/reference/matcher-split-aggregate.md): Reconcile 1:N, N:1, and N:M transaction patterns using context types and rule allocation flags to control how amounts are distributed.
- [Pix reconciliation](https://docs.lerian.studio/en/matcher/use-case-guides/matcher-pix-reconciliation.md): Configure Matcher to reconcile Pix cash-in and cash-out transactions between Midaz Ledger and BACEN's SPI settlement extracts.
- [Matcher in Lerian Console](https://docs.lerian.studio/en/matcher/using-matcher-in-lerian-console.md): Manage reconciliation contexts, matches, exceptions, and audit logs through Matcher's module in the Lerian Console.
- [What is Matcher?](https://docs.lerian.studio/en/matcher/what-is-matcher.md): Discover how Lerian's source-available reconciliation engine automates transaction matching, exception handling, and audit trails.
- [About Midaz](https://docs.lerian.studio/en/midaz/about-midaz.md): High-level overview of Midaz architecture and core components
- [Midaz libs](https://docs.lerian.studio/en/midaz/about-midaz-libs.md): Discover Midaz shared libraries for Go and TypeScript — reusable components that reduce duplication and accelerate development.
- [Midaz SDKs](https://docs.lerian.studio/en/midaz/about-midaz-sdk.md): Build on Midaz with official Go and TypeScript SDKs — clean interfaces, strong typing, and production-ready defaults.
- [Account types](https://docs.lerian.studio/en/midaz/account-types.md): Classify accounts to enforce Ledger structure, validate transactions, and align account behavior with your business rules.
- [Accounting](https://docs.lerian.studio/en/midaz/accounting-in-midaz.md): Comprehensive guide to understanding and implementing accounting principles in Midaz
- [Accounting](https://docs.lerian.studio/en/midaz/accounting-overview.md): Learn how to classify accounts and validate transactions with Midaz's accounting layer
- [Accounts](https://docs.lerian.studio/en/midaz/accounts.md): Use Accounts as the core financial unit of a Midaz Ledger, recording debits, credits, and balances tied to a specific Asset.
- [Accounts](https://docs.lerian.studio/en/midaz/accounts-overview.md): Learn how to create, group, and classify accounts in Midaz
- [Transaction amount](https://docs.lerian.studio/en/midaz/amount.md): Use the new numeric value field to record Transaction amounts with arbitrary precision — no more scale mismatches or rounding errors.
- [Architecture](https://docs.lerian.studio/en/midaz/architecture.md): Explore the microservices architecture that lets Midaz run on any cloud, scale components independently, and deploy without downtime.
- [Assets](https://docs.lerian.studio/en/midaz/assets.md): Define the currencies, cryptocurrencies, and tokenized instruments your Accounts hold — multi-asset support across a single Ledger.
- [Async transaction processing](https://docs.lerian.studio/en/midaz/async-transaction-processing.md): Process transactions asynchronously through RabbitMQ to reduce API latency and sustain higher throughput at scale.
- [Balances](https://docs.lerian.studio/en/midaz/balances.md): Track multiple Balances per Account to segment funds — investment reserves, credit limits, and operational funds without extra Accounts.
- [Production ready](https://docs.lerian.studio/en/midaz/best-practices.md): Essential best practices for running Midaz in production
- [Bulk Recorder](https://docs.lerian.studio/en/midaz/bulk-recorder.md): Batch transaction messages from RabbitMQ into optimized bulk inserts and gain over 10x throughput for high-volume workloads.
- [Common mistakes to avoid](https://docs.lerian.studio/en/midaz/common-mistakes-to-avoid.md): Avoid the typical pitfalls of Midaz implementations — Ledger structuring, Asset segregation, Transaction routing, and external Accounts.
- [Community support](https://docs.lerian.studio/en/midaz/community-support.md): Connect with the Midaz community on GitHub Discussions and Discord to ask questions, report bugs, and share feedback with maintainers.
- [Midaz entities](https://docs.lerian.studio/en/midaz/core-entities.md): Learn how to work with Midaz core entities, accounts, and transactions
- [Key features](https://docs.lerian.studio/en/midaz/core-features.md): Explore the core capabilities that make Midaz adaptable and scalable — native events, multi-asset support, segments, and double-entry accounting.
- [Alias Accounts](https://docs.lerian.studio/en/midaz/crm/alias-accounts.md): Link Holders to Midaz Ledger Accounts with Alias Accounts, adding banking, regulatory, and related-party context for CRM-driven features.
- [Best practices](https://docs.lerian.studio/en/midaz/crm/crm-best-practices.md): Operational, integration, and data management best practices for deploying and using CRM in production.
- [Core Concepts](https://docs.lerian.studio/en/midaz/crm/crm-core-concepts-overview.md): Understand the key entities managed by CRM: Holders and Alias Accounts
- [CRM data security](https://docs.lerian.studio/en/midaz/crm/crm-data-security.md): Protect personal CRM data with TLS in transit, field-level encryption at rest, and practices aligned with GDPR and LGPD.
- [Getting started with CRM](https://docs.lerian.studio/en/midaz/crm/crm-getting-started.md): Create Holders and link them to Ledger Accounts via Aliases — register customers and companies behind your Midaz Accounts.
- [Migrating from standalone CRM](https://docs.lerian.studio/en/midaz/crm/crm-migration-guide.md): Complete guide for migrating from the standalone plugin-crm deployment to the CRM component integrated into Midaz.
- [What is CRM?](https://docs.lerian.studio/en/midaz/crm/crm-overview.md): CRM is the optional data layer that enriches Midaz Ledger Accounts with customer profiles, identity, and business context.
- [Using CRM](https://docs.lerian.studio/en/midaz/crm/crm-using-overview.md): Learn how to configure and operate CRM through the API and Midaz Console
- [Holders](https://docs.lerian.studio/en/midaz/crm/holders.md): Represent the individuals or organizations behind Midaz accounts, storing identity, contact, and compliance attributes in CRM.
- [CRM in Lerian Console](https://docs.lerian.studio/en/midaz/crm/using-crm-with-midaz-console.md): Manage Holders and Alias Accounts visually inside the Midaz Module of Lerian Console — no API calls needed.
- [Data model](https://docs.lerian.studio/en/midaz/data-model.md): Reference the core tables and schemas that power Midaz, designed for developers and database administrators working close to the data.
- [Deployment strategies](https://docs.lerian.studio/en/midaz/deployment.md): Choose the right deployment strategy for Midaz under BYOC — Kubernetes with Helm, Terraform foundations, and infrastructure prerequisites.
- [Event publisher](https://docs.lerian.studio/en/midaz/event-publisher.md): Publish transaction events to RabbitMQ in real time so external systems can react without tight coupling to Midaz.
- [FAQ](https://docs.lerian.studio/en/midaz/faq.md): Find answers to common questions about Lerian APIs, multi-tenancy, SaaS isolation, pagination, and platform configuration.
- [Foundation](https://docs.lerian.studio/en/midaz/foundation-overview.md): Learn about the structural building blocks of your financial data in Midaz
- [Getting help](https://docs.lerian.studio/en/midaz/getting-help.md): Find the right support channel for Midaz — community resources for open-source users and the Lerian Support Portal for Enterprise clients.
- [Prerequisites](https://docs.lerian.studio/en/midaz/installing-and-deploying-overview.md): System requirements and prerequisites before installing Midaz
- [Ledgers](https://docs.lerian.studio/en/midaz/ledgers.md): Use Ledgers as the financial backbone of your Organization, tracking every Transaction with full traceability and segregation.
- [Lerian MCP](https://docs.lerian.studio/en/midaz/lerian-mcp.md): Connect AI assistants like Claude, Cursor, or Windsurf to the Midaz ecosystem with secure, real-time access to docs, APIs, and local services.
- [Lerian Support Portal](https://docs.lerian.studio/en/midaz/lerian-support-portal.md): Open tickets, report incidents, and request services through the official Lerian Support Portal — for Enterprise clients with SLA-backed response times.
- [lib-commons](https://docs.lerian.studio/en/midaz/lib-commons.md): Build resilient Go microservices with Lerian's shared library — database connectors, messaging, observability, and standardized error handling.
- [lib-commons-js](https://docs.lerian.studio/en/midaz/lib-commons-js.md): Reuse Lerian's TypeScript building blocks across Node.js and frontend projects — shared models, helpers, and Midaz integration in one library.
- [Metadata indexes](https://docs.lerian.studio/en/midaz/metadata-indexes.md): Improve query performance on metadata fields by creating custom indexes in MongoDB.
- [Midaz for academic records](https://docs.lerian.studio/en/midaz/midaz-for-academic-record-management.md): Use Midaz to record enrollments, grades, and achievements as immutable Ledger transactions — automated transcripts and audit-ready histories.
- [Midaz with Pix Transaction Routes](https://docs.lerian.studio/en/midaz/midaz-for-pix-transaction-routes.md): Model validated, reusable Pix transfer flows with Transaction and Operation Routes, from peer-to-peer payments to fee collection.
- [Midaz with Pix and automated fees](https://docs.lerian.studio/en/midaz/midaz-for-pix-with-fees.md): Combine Midaz, the Pix Plugin, and Fees Engine to launch Pix with automated fee management and full audit traceability.
- [Midaz for supply chains](https://docs.lerian.studio/en/midaz/midaz-for-supply-chain-management.md): Bring Ledger-grade traceability to manufacturing, recording every material movement as an immutable, auditable transaction.
- [Getting started with Midaz](https://docs.lerian.studio/en/midaz/midaz-getting-started.md): Run Midaz locally, create your first organization, Ledger, accounts, and process your first transaction in under 10 minutes.
- [Midaz in a global portfolio](https://docs.lerian.studio/en/midaz/midaz-in-a-global-portfolio.md): Manage multi-currency Accounts under a single client Portfolio — BRL, USD, EUR, and more in a unified Ledger view.
- [Midaz in banking](https://docs.lerian.studio/en/midaz/midaz-in-banking.md): Discover how Midaz powers retail, corporate, and personalized banking through Portfolios, Segments, and dedicated settlement Accounts.
- [Midaz models](https://docs.lerian.studio/en/midaz/midaz-models.md): Compare Midaz Community and Enterprise models — choose the licensing tier that fits your needs and pair it with SaaS or BYOC deployment.
- [Midaz production best practices](https://docs.lerian.studio/en/midaz/midaz-production-best-practices.md): Set up Midaz for production with multi-AZ deployment, autoscaling, managed services, and the Kubernetes resilience patterns Lerian recommends.
- [Midaz SDK for Go](https://docs.lerian.studio/en/midaz/midaz-sdk-go.md): Build Go applications on top of Midaz with the official SDK — clear abstractions for Ledgers, Portfolios, and Transactions.
- [Midaz SDK for TypeScript](https://docs.lerian.studio/en/midaz/midaz-sdk-typescript.md): Build typed financial integrations with the Midaz SDK for TypeScript — builder pattern, automatic retries, observability, and strict validation.
- [Midaz SDKs & libs](https://docs.lerian.studio/en/midaz/midaz-sdks-libs-overview.md): Official SDKs and libraries for integrating Midaz into your applications
- [Installing Midaz](https://docs.lerian.studio/en/midaz/midaz-setup.md): Install Midaz locally with Docker Compose — the full environment, Ledger and Console included, in just a few commands.
- [Midaz Terraform Foundation](https://docs.lerian.studio/en/midaz/midaz-terraform-foundation.md): Provision the base infrastructure for Midaz on AWS, GCP, or Azure with ready-made Terraform examples — networking, databases, and Kubernetes.
- [Observability](https://docs.lerian.studio/en/midaz/observability-in-midaz.md): Monitor metrics, logs, and traces across your Midaz deployments with OpenTelemetry and Lerian's managed observability stack.
- [Operations](https://docs.lerian.studio/en/midaz/operations.md): Operations are the smallest unit of financial activity in Midaz: a single Ledger entry, either a debit or credit on an Account.
- [Organizations](https://docs.lerian.studio/en/midaz/organizations.md): Define the top-level Organization that owns your Midaz Ledgers — represent banks, fintechs, and parent-child hierarchies for subsidiaries.
- [Fees Engine billing package examples](https://docs.lerian.studio/en/midaz/plugins/fees-engine/billing-package-examples.md): Walk through real billing-package scenarios, from boleto tiered pricing to maintenance charges, with full configuration examples.
- [Fees Engine calculations](https://docs.lerian.studio/en/midaz/plugins/fees-engine/fee-engine-calculation.md): Understand how Fees Engine calculates, allocates, and exempts fees with traceable, compliant rules for complex accounting flows.
- [Fees Engine best practices](https://docs.lerian.studio/en/midaz/plugins/fees-engine/fees-engine-best-practices.md): Configuration, operational, and integration best practices for deploying and using the Fees Engine plugin in production.
- [What is Fees Engine?](https://docs.lerian.studio/en/midaz/plugins/fees-engine/fees-engine-overview.md): Fees Engine controls how fees and billing are configured, calculated, and tracked across per-transaction and per-period scenarios.
- [Using Fees Engine](https://docs.lerian.studio/en/midaz/plugins/fees-engine/using-fee-engine.md): Use Fees Engine to apply per-transaction fee packages and per-period billing packages aligned with your business rules.
- [Fees Engine in Lerian Console](https://docs.lerian.studio/en/midaz/plugins/fees-engine/using-fee-engine-with-midaz-console.md): Define, test, and apply fees visually with the Fees Engine plugin in the Midaz Module — no code required for fee packages and estimations.
- [Installing and deploying](https://docs.lerian.studio/en/midaz/plugins/installing-and-deploying-plugins.md): Step-by-step guide for installing and deploying Midaz plugins on Kubernetes using Helm.
- [Version compatibility](https://docs.lerian.studio/en/midaz/plugins/midaz-version-compatibility.md): Check which plugin versions match each Midaz Core release before deploying or upgrading your environment.
- [DICT](https://docs.lerian.studio/en/midaz/plugins/pix/main-domains-dict.md): A regulated directory for Pix key registration, validation, portability, and ownership integrity.
- [MED](https://docs.lerian.studio/en/midaz/plugins/pix/main-domains-med.md): Handle Pix disputes through MED, BACEN's regulated framework for fraud, unauthorized transactions, and operational errors.
- [Main domains](https://docs.lerian.studio/en/midaz/plugins/pix/main-domains-overview.md): Pix operates through a set of functional domains defined and regulated by the Central Bank of Brazil (BACEN).
- [QR Codes](https://docs.lerian.studio/en/midaz/plugins/pix/main-domains-qrcodes.md): Pix QR Codes are one of the most widely adopted payment initiation methods in Brazil.
- [Transactions](https://docs.lerian.studio/en/midaz/plugins/pix/main-domains-transactions.md): Pix transactions are the core operational flow of Brazil’s instant payment system.
- [Best practices](https://docs.lerian.studio/en/midaz/plugins/pix/pix-best-practices.md): Pix is a real-time payment system, but a reliable integration depends on more than just calling APIs.
- [Pix glossary](https://docs.lerian.studio/en/midaz/plugins/pix/pix-glossary.md): A reference guide to the core terminology used in Brazil’s instant payment system.
- [Pix modalities](https://docs.lerian.studio/en/midaz/plugins/pix/pix-modalities.md): A comprehensive overview of the main payment modalities defined by the Central Bank of Brazil (BACEN).
- [What is Pix?](https://docs.lerian.studio/en/midaz/plugins/pix/pix-overview.md): Pix is Brazil’s official instant payment system, developed and regulated by the Central Bank of Brazil (BACEN).
- [Pix Switch](https://docs.lerian.studio/en/midaz/plugins/pix/pix-switch.md): Pix Switch is Lerian's unified Pix plugin: one application layer, any provider, covering orchestration, keys, QR Codes, and disputes.
- [Plugin use cases](https://docs.lerian.studio/en/midaz/plugins/plugin-uses-cases.md): End-to-end scenarios that combine Midaz with plugins to solve real operational challenges
- [Best practices for TED](https://docs.lerian.studio/en/midaz/plugins/ted/ted-best-practices.md): Apply proven patterns when integrating TED — show fees before confirmation, handle settlement windows, and reduce customer complaints.
- [TED configuration](https://docs.lerian.studio/en/midaz/plugins/ted/ted-configuration.md): Configure TED across infrastructure, tenant, and account levels — limits, fee policies, and operating hours adjustable at runtime.
- [TED data and reporting](https://docs.lerian.studio/en/midaz/plugins/ted/ted-data-model.md): Reference the data fields and status lifecycles available for TED transfers — reconciliation, audit trails, and compliance reporting.
- [TED developer guide](https://docs.lerian.studio/en/midaz/plugins/ted/ted-developer-guide.md): Implement TED integrations correctly — idempotency, retry strategy, state handling, and webhook validation patterns for reliable transfers.
- [TED glossary](https://docs.lerian.studio/en/midaz/plugins/ted/ted-glossary.md): Reference glossary of TED-related terms, BACEN acronyms, ISO 20022 codes, and SPB infrastructure abbreviations.
- [Receive TED (TED IN)](https://docs.lerian.studio/en/midaz/plugins/ted/ted-in.md): Receive TED transfers automatically — the plugin polls SPB, validates recipient Accounts, and credits funds with no manual intervention.
- [How the TED plugin works](https://docs.lerian.studio/en/midaz/plugins/ted/ted-in-lerian.md): Understand how the TED plugin handles SPB communication, fee calculation, settlement, and webhook notifications across the full transfer lifecycle.
- [Send TED (TED OUT)](https://docs.lerian.studio/en/midaz/plugins/ted/ted-out.md): Send TED transfers to any Brazilian bank with a two-step initiate-and-confirm flow — fee preview, same-day settlement, and BACEN compliance.
- [What is Bank Transfer (TED)?](https://docs.lerian.studio/en/midaz/plugins/ted/ted-overview.md): Move money between Brazilian banks the same business day with Lerian's TED plugin — sending, receiving, P2P, and BACEN compliance built in.
- [Internal TED transfers (P2P)](https://docs.lerian.studio/en/midaz/plugins/ted/ted-p2p.md): Move funds between Accounts within your institution in under 2 seconds, 24/7, without BACEN routing — automatic detection, no extra integration.
- [Transfer types](https://docs.lerian.studio/en/midaz/plugins/ted/ted-transfer-types.md): The TED plugin supports three transfer types: TED OUT, TED IN, and P2P.
- [TED webhooks](https://docs.lerian.studio/en/midaz/plugins/ted/ted-webhooks.md): React to TED transfer events in real time with webhooks — completed, failed, chargeback, and reconciliation notifications without polling.
- [What are plugins?](https://docs.lerian.studio/en/midaz/plugins/what-are-plugins.md): Plugins are how you extend a product without changing its core.
- [Portfolios](https://docs.lerian.studio/en/midaz/portfolios.md): Group accounts under a single customer or business unit to view total relationships and apply policies at the wallet level.
- [Recommended workflow](https://docs.lerian.studio/en/midaz/recommended-workflow.md): Follow the recommended onboarding workflow to set up Organizations, Ledgers, Assets, and Accounts step by step in Midaz.
- [Rest API](https://docs.lerian.studio/en/midaz/rest-api.md): Integrate with Midaz through RESTful APIs across Onboarding, Portfolio, and Transactions domains — JSON, versioning, and predictable design.
- [Scalability strategies](https://docs.lerian.studio/en/midaz/scalability-strategies.md): Scale Midaz to millions of Accounts and Transactions per day — partitioning by Ledgers, horizontal service scaling, and read replicas.
- [Security](https://docs.lerian.studio/en/midaz/security.md): Understand how Midaz protects your financial operations with security by design, threat modeling, and OWASP-aligned controls.
- [Security recommendations](https://docs.lerian.studio/en/midaz/security-recommendations.md): Apply Lerian's shared responsibility security model — infrastructure hardening, network segmentation, TLS, and Zero Trust patterns.
- [Segments](https://docs.lerian.studio/en/midaz/segments.md): Group Accounts into Segments to deliver tailored benefits — VIP rates, student perks, fee waivers, and personalized rules across Portfolios.
- [Structuring bank operations with Midaz](https://docs.lerian.studio/en/midaz/structuring-bank-operation.md): Design Organizations, Ledgers, Portfolios, and Segments for retail and corporate banking — best practices for scalable hierarchies.
- [Transaction Routing](https://docs.lerian.studio/en/midaz/transaction-routing-entities.md): Validate every Transaction with Transaction Routes and Operation Routes — enforce structure and business rules before recording any movement.
- [Transactions](https://docs.lerian.studio/en/midaz/transactions.md): Record financial events with Midaz double-entry Transactions — multiple Balances, debits, credits, and full traceability across Accounts.
- [Transactions DSL](https://docs.lerian.studio/en/midaz/transactions-dsl.md): Migrate away from the deprecated Gold DSL and learn how legacy .gold files structured Midaz transactions before the current API.
- [Transactions](https://docs.lerian.studio/en/midaz/transactions-overview.md): Learn how financial value moves through Midaz
- [Updating Midaz](https://docs.lerian.studio/en/midaz/updating-midaz.md): Update your Midaz environment safely — local Docker upgrades and Helm-based rollouts to keep your installation secure and current.
- [Midaz use cases](https://docs.lerian.studio/en/midaz/use-cases.md): Discover when and how to use Midaz across different industries
- [Midaz in Lerian Console](https://docs.lerian.studio/en/midaz/using-midaz-in-lerian-console.md): Manage Midaz visually inside the Lerian Console — Organizations, Ledgers, Accounts, Transactions, and plugins from a single web interface.
- [What is Midaz?](https://docs.lerian.studio/en/midaz/what-is-midaz.md): Learn what Midaz is, key features, and when to use it for your financial system
- [Multi-tenancy](https://docs.lerian.studio/en/multi-tenancy.md): How Lerian isolates data between tenants in shared deployments.
- [Open by design](https://docs.lerian.studio/en/open-by-design.md): Understand why Lerian builds source-available financial infrastructure — transparency, independence, extensibility, and trust by design.
- [Our values](https://docs.lerian.studio/en/our-values.md): Learn Lerian's mission and the values that guide our work — strength, courage, integrity, audacity, and leadership in financial infrastructure.
- [API Reference templates](https://docs.lerian.studio/en/partners-hub/api-reference-template.md): Adopt the official Lerian templates for API reference pages — endpoints, schemas, errors, and OpenAPI specs — to keep docs precise and predictable.
- [API standards](https://docs.lerian.studio/en/partners-hub/api-standards.md): Design conventions and requirements for plugin APIs in the Lerian ecosystem.
- [Architecture and operations](https://docs.lerian.studio/en/partners-hub/architecture-operations.md): Follow the architecture, observability, and operational standards every plugin must meet to interoperate with Midaz and run in production.
- [Capitalization](https://docs.lerian.studio/en/partners-hub/capitalization.md): Reference the capitalization rules used across Lerian docs — sentence case for headings, exact casing for product names, and common edge cases.
- [Our coding standards](https://docs.lerian.studio/en/partners-hub/coding-standards.md): Review the technical, security, and compliance standards every plugin must meet to be approved for the Lerian Marketplace.
- [Error model](https://docs.lerian.studio/en/partners-hub/error-model.md): Reference the structured error response Lerian APIs return — codes, titles, messages, and field-level validation — to handle failures consistently.
- [Guides templates](https://docs.lerian.studio/en/partners-hub/guides-template.md): Adopt the official Lerian templates for narrative docs — product overviews, architecture, getting started, entity references, and how-to guides.
- [Welcome to our Partner's Hub](https://docs.lerian.studio/en/partners-hub/introduction.md): Discover the standards, processes, and resources you need to build, document, and publish plugins for the Lerian platform.
- [Licensing basics](https://docs.lerian.studio/en/partners-hub/license-manager.md): Understand how Lerian licenses enterprise features and plugins, why they exist, and how the modular monetization model is structured.
- [License Manager error list](https://docs.lerian.studio/en/partners-hub/license-manager-error-list.md): Reference every License Manager error code, title, and message so you can diagnose authorization failures on paid Lerian plugins.
- [Plugin lifecycle](https://docs.lerian.studio/en/partners-hub/lifecycle-gov.md): Follow the versioning, release, and support standards every plugin must meet to stay predictable across the Lerian ecosystem after launch.
- [Quality and performance](https://docs.lerian.studio/en/partners-hub/quality-performance.md): Review the testing, performance, and resilience standards every plugin must meet to be approved for the Lerian Marketplace.
- [SDKs guidelines](https://docs.lerian.studio/en/partners-hub/sdk-guideline.md): Follow Lerian's SDK best practices — repository layout, error handling, examples, and version alignment — to accelerate plugin adoption.
- [Security and compliance](https://docs.lerian.studio/en/partners-hub/security-compliance.md): Review the mandatory security and compliance baseline — OWASP ASVS, CIS, secret management, audits, and LGPD — every Lerian plugin must meet.
- [Technical guidelines](https://docs.lerian.studio/en/partners-hub/technical-guidelines.md): Explore the technical expectations for partner solutions — architecture, APIs, quality, security, and SDKs — across the Lerian Marketplace.
- [Documentation templates](https://docs.lerian.studio/en/partners-hub/templates.md): Explore the official documentation templates Lerian uses for guides and API references so your content stays consistent and clear.
- [Voice and tone](https://docs.lerian.studio/en/partners-hub/voice-tone.md): Learn how Lerian writes — assertive, tech-friendly, and clear by design — so every guide, reference, and changelog sounds consistent.
- [Our writing guidelines](https://docs.lerian.studio/en/partners-hub/writing-guidelines.md): Follow the Lerian writing guidelines that keep documentation clear, scannable, and consistent across the entire ecosystem.
- [Our writing standards](https://docs.lerian.studio/en/partners-hub/writing-standards.md): Adopt the Lerian writing standards and templates so every guide and reference shares the same voice, structure, and usability.
- [What is Access Manager?](https://docs.lerian.studio/en/platform/access-manager/access-manager.md): Control who accesses what across Lerian products with centralized authentication, authorization, and identity management.
- [Best practices](https://docs.lerian.studio/en/platform/access-manager/am-best-practices.md): Operate Access Manager securely — manage credentials, lock down environments, and protect identity and authorization at scale.
- [Auth and Identity services](https://docs.lerian.studio/en/platform/access-manager/am-components.md): Understand the two services behind Access Manager — Auth handles tokens and validation, Identity manages users and roles.
- [Auth service](https://docs.lerian.studio/en/platform/access-manager/auth-plugin.md): Issue and validate OAuth2/OIDC tokens, enforce permissions, and cache credentials with the centralized Auth service across Lerian apps.
- [Enabling Access Manager](https://docs.lerian.studio/en/platform/access-manager/enabling-access-manager.md): Activate Access Manager across Lerian products — set the Auth environment variables in each `.env` so your services start enforcing access.
- [Identity service](https://docs.lerian.studio/en/platform/access-manager/identity-plugin.md): Manage users, roles, groups, and OAuth2 authentication centrally with the Identity service — the access control backbone for Lerian products.
- [Using Access Manager](https://docs.lerian.studio/en/platform/access-manager/using-access-manager.md): Integrate Access Manager into your application — set up authentication, manage tokens, and combine Auth and Identity for end-to-end access control.
- [Access Manager via Lerian Console](https://docs.lerian.studio/en/platform/access-manager/using-access-manager-with-midaz-console.md): Manage users, M2M applications, and authentication settings for Access Manager visually through the Lerian Console — no direct API calls.
- [Access Manager via Helm](https://docs.lerian.studio/en/platform/helm/access-manager/access-manager-helm.md): Helm chart installation and version reference for Access Manager.
- [Lerian Console via Helm](https://docs.lerian.studio/en/platform/helm/console/console-helm.md): Helm chart installation and version reference for the Lerian Console.
- [Helm at Lerian](https://docs.lerian.studio/en/platform/helm/helm-overview.md): Overview of Lerian's Helm charts, OCI registry, versioning scheme, and links to product-specific deployment guides.
- [Helm chart version compatibility](https://docs.lerian.studio/en/platform/helm/helm-version-compatibility.md): Reference table mapping Helm chart versions to application versions for Midaz, plugins, and related products.
- [Infrastructure via Helm](https://docs.lerian.studio/en/platform/helm/infrastructure/infrastructure-helm.md): Helm charts for Lerian infrastructure components — OTEL Collector, Fetcher, Flowker, Tracer, and Underwriter.
- [Midaz components reference](https://docs.lerian.studio/en/platform/helm/midaz/midaz-components-reference.md): Configure Helm chart components for Midaz — Ledger, Onboarding, Transaction, and CRM — with deployment, service, and ingress settings.
- [Configuration reference](https://docs.lerian.studio/en/platform/helm/midaz/midaz-configuration-reference.md): Reference all Ledger service Helm parameters — module-specific databases, external secrets, and deployment flags for Midaz on Kubernetes.
- [Configuring dependencies](https://docs.lerian.studio/en/platform/helm/midaz/midaz-dependencies.md): Configure Midaz Helm dependencies — Valkey, PostgreSQL, MongoDB, RabbitMQ — using bundled charts or external managed services for production.
- [Midaz via Helm](https://docs.lerian.studio/en/platform/helm/midaz/midaz-helm-overview.md): Midaz Helm chart — installation, configuration, upgrading, and troubleshooting.
- [Configuring ingress](https://docs.lerian.studio/en/platform/helm/midaz/midaz-ingress.md): Expose Midaz services through Kubernetes ingress — set hostnames, TLS secrets, and controller annotations for NGINX, ALB, or Traefik.
- [Install & configure](https://docs.lerian.studio/en/platform/helm/midaz/midaz-install-configure-overview.md): Deploy Midaz on Kubernetes with Helm — from initial install to fine-tuning ingress, observability, dependencies, and components.
- [Installing Midaz via Helm](https://docs.lerian.studio/en/platform/helm/midaz/midaz-installation.md): Install Midaz on Kubernetes with the official Helm chart — Ledger, databases, and observability stack in a single command.
- [Migrating from v3.x to v4.x](https://docs.lerian.studio/en/platform/helm/midaz/midaz-migrate-v3-to-v4.md): Migrate your Midaz Helm deployment from v3.x to v4.x — handle breaking changes, configuration mappings, and post-upgrade verification.
- [Migrating from v3.x to v5.x](https://docs.lerian.studio/en/platform/helm/midaz/midaz-migrate-v3-to-v5.md): Upgrade your Midaz Helm deployment directly from v3.x to v5.x — address breaking changes from both major versions in a single migration.
- [Migrating from v4.x to v5.x](https://docs.lerian.studio/en/platform/helm/midaz/midaz-migrate-v4-to-v5.md): Migrate your Midaz Helm deployment from v4.x to v5.x — follow the pre-upgrade checklist, run migrations, and validate the new release.
- [Migrating Midaz via Helm](https://docs.lerian.studio/en/platform/helm/midaz/midaz-migrating-overview.md): Plan migrations between major Midaz Helm chart versions — pick the right path and review breaking changes before upgrading.
- [Configuring observability](https://docs.lerian.studio/en/platform/helm/midaz/midaz-observability.md): Enable the Grafana OTEL LGTM stack — Loki, Tempo, Mimir, and Grafana — to collect logs, traces, and metrics from your Midaz deployment.
- [Production values reference](https://docs.lerian.studio/en/platform/helm/midaz/midaz-production-values.md): Annotated production-ready values.yaml reference for deploying Midaz on Kubernetes with Helm.
- [Rollback and troubleshooting](https://docs.lerian.studio/en/platform/helm/midaz/midaz-rollback-troubleshooting.md): Roll back a failed Midaz Helm upgrade and troubleshoot common post-upgrade issues — pod crashes, schema errors, and broken integrations.
- [Helm troubleshooting](https://docs.lerian.studio/en/platform/helm/midaz/midaz-troubleshooting.md): Diagnose and resolve common issues when deploying or operating Midaz on Kubernetes — pod failures, ingress errors, and dependency conflicts.
- [Uninstalling Midaz deployment](https://docs.lerian.studio/en/platform/helm/midaz/midaz-uninstall.md): Fully remove a Midaz Helm deployment from Kubernetes — Helm-managed resources, persistent volumes, secrets, and the namespace itself.
- [Midaz Helm upgrade checklist](https://docs.lerian.studio/en/platform/helm/midaz/midaz-upgrade-checklist.md): Follow best practices and verification steps before, during, and after a Midaz Helm upgrade to ensure safe production rollouts.
- [Midaz Helm upgrade guide](https://docs.lerian.studio/en/platform/helm/midaz/midaz-upgrade-guide.md): Upgrade your Midaz Helm deployment to v5.x — quick start, version-specific migration paths, breaking changes, and post-upgrade checks.
- [Upgrading Midaz via Helm](https://docs.lerian.studio/en/platform/helm/midaz/midaz-upgrading-overview.md): Plan and execute Midaz Helm upgrades — version-to-version guides, configuration reference, checklists, and rollback procedures.
- [Bank Transfer (TED) via Helm](https://docs.lerian.studio/en/platform/helm/plugins/plugin-bank-transfer-helm.md): Helm chart installation and version reference for the Bank Transfer (TED) plugin.
- [CRM via Helm](https://docs.lerian.studio/en/platform/helm/plugins/plugin-crm-helm.md): Helm chart installation and version reference for the CRM plugin.
- [Fees Engine via Helm](https://docs.lerian.studio/en/platform/helm/plugins/plugin-fees-helm.md): Helm chart installation and version reference for the Fees Engine plugin.
- [Pix via Helm](https://docs.lerian.studio/en/platform/helm/plugins/plugin-pix-helm.md): Helm chart installation and version reference for the Pix plugin.
- [Indirect Pix (BTG) via Helm](https://docs.lerian.studio/en/platform/helm/plugins/plugin-pix-indirect-helm.md): Helm chart installation and version reference for the Pix Indirect BTG plugin.
- [Plugins via Helm](https://docs.lerian.studio/en/platform/helm/plugins/plugins-helm-overview.md): Overview of Helm charts for Lerian Enterprise plugins.
- [Reporter via Helm](https://docs.lerian.studio/en/platform/helm/reporter/reporter-helm.md): Helm chart installation and version reference for the Reporter product.
- [Console overview](https://docs.lerian.studio/en/platform/lerian-console/about-lerian-console.md): Manage and operate every Lerian product from a single web interface with unified authentication, navigation, and product administration.
- [Activating and deactivating a workflow](https://docs.lerian.studio/en/platform/lerian-console/flowker-console/activating-deactivating-workflow.md): Control whether a workflow is live for execution by activating, deactivating, or moving it back to draft status as your needs change.
- [Adding a provider](https://docs.lerian.studio/en/platform/lerian-console/flowker-console/adding-a-provider.md): Configure a connection to an external system so Flowker workflows can interact with the services they need to automate.
- [Audit Trail overview](https://docs.lerian.studio/en/platform/lerian-console/flowker-console/audit-trail-overview.md): Track every action performed in Flowker with a tamper-proof, filterable record built for compliance and troubleshooting.
- [Canvas editor](https://docs.lerian.studio/en/platform/lerian-console/flowker-console/canvas-editor.md): Design workflows visually with a drag-and-drop canvas where you add, connect, and configure nodes to model automated processes.
- [Cloning a workflow](https://docs.lerian.studio/en/platform/lerian-console/flowker-console/cloning-a-workflow.md): Duplicate an existing workflow with all its nodes and configurations to quickly build a new variant in Draft status.
- [Create a workflow from scratch](https://docs.lerian.studio/en/platform/lerian-console/flowker-console/create-from-scratch.md): Build a workflow from a blank canvas, defining every trigger, executor, and condition that drives your automation.
- [Create a workflow from a template](https://docs.lerian.studio/en/platform/lerian-console/flowker-console/create-from-template.md): Start from a pre-built template with nodes and connections in place, then customize it to fit your automation use case.
- [Creating Workflows](https://docs.lerian.studio/en/platform/lerian-console/flowker-console/creating-workflows.md): Create a workflow from a blank canvas or a pre-built template — both paths start from the + New Workflow button in Flowker.
- [Deleting a provider](https://docs.lerian.studio/en/platform/lerian-console/flowker-console/deleting-a-provider.md): Remove a provider configuration from Flowker when it is no longer needed for any workflow integration.
- [Deleting a workflow](https://docs.lerian.studio/en/platform/lerian-console/flowker-console/deleting-a-workflow.md): Remove a workflow from the Console when it is obsolete or no longer required for your automation processes.
- [Editing a provider](https://docs.lerian.studio/en/platform/lerian-console/flowker-console/editing-a-provider.md): Update an existing provider to change its connection parameters, credentials, or name without disrupting active workflows.
- [Editing a workflow](https://docs.lerian.studio/en/platform/lerian-console/flowker-console/editing-a-workflow.md): Update a workflow's name, modify its nodes and connections, or reconfigure individual node parameters as your logic evolves.
- [Executions overview](https://docs.lerian.studio/en/platform/lerian-console/flowker-console/executions-overview.md): Monitor workflow runs, investigate failures, and review results from a complete history of every execution in Flowker.
- [Flowker Dashboard](https://docs.lerian.studio/en/platform/lerian-console/flowker-console/flowker-dashboard.md): View an at-a-glance summary of workflow activity, key metrics, recent workflows, and execution history from the Flowker home page.
- [Flowker module overview](https://docs.lerian.studio/en/platform/lerian-console/flowker-console/flowker-module.md): Design visual workflows, configure provider integrations, run automated processes, and monitor executions through the Flowker module.
- [Managing workflows](https://docs.lerian.studio/en/platform/lerian-console/flowker-console/managing-workflows.md): Modify workflow structure, manage lifecycle status, duplicate for reuse, or remove workflows from the Flowker Console.
- [Providers overview](https://docs.lerian.studio/en/platform/lerian-console/flowker-console/providers-overview.md): Manage external service integrations that workflows can connect to, with reusable connection details and credentials in one place.
- [Testing a provider](https://docs.lerian.studio/en/platform/lerian-console/flowker-console/testing-a-provider.md): Verify that a provider's credentials and connection settings are correct before using it in any workflow.
- [Viewing execution details](https://docs.lerian.studio/en/platform/lerian-console/flowker-console/viewing-execution-details.md): Inspect a workflow execution to understand its progress, review outputs, and diagnose failures node by node.
- [Workflows overview](https://docs.lerian.studio/en/platform/lerian-console/flowker-console/workflows-overview.md): Manage Flowker's automated processes built from triggers, actions, conditionals, and provider nodes connected on a visual canvas.
- [Context Rules](https://docs.lerian.studio/en/platform/lerian-console/matcher-console/context-rules.md): Define match rules that control how the engine pairs transactions across data sources for accurate reconciliation results.
- [Context Schedules](https://docs.lerian.studio/en/platform/lerian-console/matcher-console/context-schedules.md): Automate reconciliation by defining when the Matcher engine should run matching for a context without manual intervention.
- [Context Sources](https://docs.lerian.studio/en/platform/lerian-console/matcher-console/context-sources.md): Configure where transaction data comes from and how it connects to a reconciliation context for accurate matching.
- [Exception Details](https://docs.lerian.studio/en/platform/lerian-console/matcher-console/exception-details.md): View full information about a reconciliation exception, resolve it, and review every action taken on its audit trail.
- [Executing a Reconciliation](https://docs.lerian.studio/en/platform/lerian-console/matcher-console/executing-reconciliation.md): Trigger the matching engine manually for a context, preview results in a dry run, and commit confirmed matches on demand.
- [Managing Actor Mappings](https://docs.lerian.studio/en/platform/lerian-console/matcher-console/managing-actor-mappings.md): Associate opaque actor IDs from JWT authentication with readable names and emails to support GDPR pseudonymization and erasure.
- [Archives](https://docs.lerian.studio/en/platform/lerian-console/matcher-console/managing-archives.md): Browse and download archived reconciliation data automatically generated by your data retention policies and organized by period.
- [Audit Logs](https://docs.lerian.studio/en/platform/lerian-console/matcher-console/managing-audit-logs.md): Track every change to your reconciliation configuration and operations with a filterable record built for compliance and troubleshooting.
- [Managing Contexts](https://docs.lerian.studio/en/platform/lerian-console/matcher-console/managing-contexts.md): Group sources, rules, and schedules into reconciliation contexts that define each specific matching workflow you operate.
- [Managing Disputes](https://docs.lerian.studio/en/platform/lerian-console/matcher-console/managing-disputes.md): Track formal challenges raised against reconciliation exceptions, submit evidence, follow state changes, and record resolutions.
- [Managing Exceptions](https://docs.lerian.studio/en/platform/lerian-console/matcher-console/managing-exceptions.md): Review reconciliation exceptions — transactions that could not be matched automatically — and resolve them through human review.
- [Managing Fee Schedules](https://docs.lerian.studio/en/platform/lerian-console/matcher-console/managing-fee-schedules.md): Define flat, percentage, or tiered fees so the reconciliation engine can automatically verify and flag fee discrepancies on matches.
- [Managing Matches](https://docs.lerian.studio/en/platform/lerian-console/matcher-console/managing-matches.md): Review confirmed match groups, check confidence scores, and initiate manual matching for any reconciliation context and run.
- [Managing Reconciliations](https://docs.lerian.studio/en/platform/lerian-console/matcher-console/managing-reconciliations.md): Upload transaction data and start new reconciliation runs for any context configured in the Matcher module.
- [Manual Matching](https://docs.lerian.studio/en/platform/lerian-console/matcher-console/manual-matching.md): Link transactions that the automatic engine could not reconcile by searching candidates and creating match groups manually.
- [Matcher Dashboard](https://docs.lerian.studio/en/platform/lerian-console/matcher-console/matcher-dashboard.md): Monitor reconciliation health for the active context with key metrics, trend charts, breakdown views, and recent run history.
- [Matcher in Lerian Console](https://docs.lerian.studio/en/platform/lerian-console/matcher-console/matcher-module.md): Configure sources and match rules, upload transaction data, run reconciliations, and resolve exceptions — all from a visual interface.
- [Operational History](https://docs.lerian.studio/en/platform/lerian-console/matcher-console/operational-history.md): View ingestion jobs, reconciliation runs, and export jobs for every Matcher context in a single centralized history page.
- [Uploading Reconciliation Data](https://docs.lerian.studio/en/platform/lerian-console/matcher-console/uploading-reconciliation-data.md): Upload transaction data from your sources through a guided wizard so the Matcher engine can pair them in the next reconciliation run.
- [Adding a Porfolio to an Account](https://docs.lerian.studio/en/platform/lerian-console/midaz-console/adding-portfolio-to-account.md): Link an Account to a Portfolio so you can group related Accounts and apply policies at the wallet level.
- [Adding a Segment to an Account](https://docs.lerian.studio/en/platform/lerian-console/midaz-console/adding-segment-to-account.md): Assign a Segment to an Account to group it by characteristics and apply specific benefits or rules.
- [Checking Transaction details](https://docs.lerian.studio/en/platform/lerian-console/midaz-console/checking-transaction-details.md): View the full details of a Transaction in the Console to audit movements and confirm what was recorded.
- [Configuring Ledger Settings](https://docs.lerian.studio/en/platform/lerian-console/midaz-console/configuring-ledger-settings.md): Enable validation rules that control how Accounts and Transactions behave inside a specific Ledger.
- [Creating a new Ledger](https://docs.lerian.studio/en/platform/lerian-console/midaz-console/creating-a-new-ledger.md): Set up a new Ledger inside your Organization to track another stream of Transactions with full segregation.
- [Creating a Portfolio](https://docs.lerian.studio/en/platform/lerian-console/midaz-console/creating-a-portfolio.md): Set up a new Portfolio in the Console to group Accounts under a customer or business unit.
- [Creating a Segment](https://docs.lerian.studio/en/platform/lerian-console/midaz-console/creating-a-segment.md): Define a new Segment in the Console to classify Accounts by shared characteristics or business rules.
- [Creating a Transaction](https://docs.lerian.studio/en/platform/lerian-console/midaz-console/creating-a-transaction.md): Record a new Transaction in the Console to move Asset balances between Accounts in your Ledger.
- [Creating an Account](https://docs.lerian.studio/en/platform/lerian-console/midaz-console/creating-an-account.md): Open a new Account in your Ledger to start receiving and sending Asset balances through Transactions.
- [Creating an Account Type](https://docs.lerian.studio/en/platform/lerian-console/midaz-console/creating-an-account-type.md): Add a new Account Type to enforce Ledger structure and validate which Transactions an Account can take part in.
- [Creating an Accounting Route](https://docs.lerian.studio/en/platform/lerian-console/midaz-console/creating-an-accounting-route.md): Build an Accounting Route through the guided wizard to define how Transactions and operations are routed.
- [Creating an Asset](https://docs.lerian.studio/en/platform/lerian-console/midaz-console/creating-an-asset.md): Register a new Asset in your Ledger to track currencies, tokens, or any unit of value used in Transactions.
- [Creating an Organization](https://docs.lerian.studio/en/platform/lerian-console/midaz-console/creating-an-organization.md): Set up a new Organization in the Midaz Module — the top-level entity that holds your Ledgers and operations.
- [Creating an Alias from the Holder](https://docs.lerian.studio/en/platform/lerian-console/midaz-console/crm-alias-from-holder.md): Create an Alias Account directly from a Holder's page to link the Account to its owner in one step.
- [Creating a Holder](https://docs.lerian.studio/en/platform/lerian-console/midaz-console/crm-creating-a-holder.md): Register a new Holder in the CRM module to represent the person or entity that owns one or more Accounts.
- [Creating an Alias Account](https://docs.lerian.studio/en/platform/lerian-console/midaz-console/crm-creating-alias-account.md): Set up an Alias Account in the CRM to give a Holder a friendly identifier for their underlying Account.
- [Deleting a Holder](https://docs.lerian.studio/en/platform/lerian-console/midaz-console/crm-deleting-a-holder.md): Remove a Holder from the CRM when they no longer hold Accounts — this action cannot be undone.
- [Deleting an Alias Account](https://docs.lerian.studio/en/platform/lerian-console/midaz-console/crm-deleting-alias-account.md): Permanently remove an Alias Account from the CRM — once deleted, the Alias cannot be recovered.
- [Editing a Holder](https://docs.lerian.studio/en/platform/lerian-console/midaz-console/crm-editing-a-holder.md): Update a Holder's personal or business information in the CRM to keep records accurate and current.
- [Editing an Alias Account](https://docs.lerian.studio/en/platform/lerian-console/midaz-console/crm-editing-alias-account.md): Update an Alias Account's information in the CRM to keep its details aligned with the underlying Account.
- [Deleting a Ledger](https://docs.lerian.studio/en/platform/lerian-console/midaz-console/deleting-a-ledger.md): Remove a Ledger from your Organization when it is no longer in use — be aware of consequences before proceeding.
- [Deleting a Portfolio](https://docs.lerian.studio/en/platform/lerian-console/midaz-console/deleting-a-portfolio.md): Remove a Portfolio from the Console when its Accounts no longer need to be grouped together.
- [Deleting a Segment](https://docs.lerian.studio/en/platform/lerian-console/midaz-console/deleting-a-segment.md): Remove a Segment from the Console when it is no longer used to classify Accounts in your Ledger.
- [Deleting an Account](https://docs.lerian.studio/en/platform/lerian-console/midaz-console/deleting-an-account.md): Permanently remove an Account from your Ledger — once deleted, the Account and its history cannot be recovered.
- [Deleting an Asset](https://docs.lerian.studio/en/platform/lerian-console/midaz-console/deleting-an-asset.md): Remove an Asset from your Ledger after moving any remaining balances to an External Account.
- [Deleting an Organization](https://docs.lerian.studio/en/platform/lerian-console/midaz-console/deleting-an-organization.md): Permanently remove an Organization from the Midaz Module along with its Ledgers and configurations.
- [Editing a Ledger](https://docs.lerian.studio/en/platform/lerian-console/midaz-console/editing-a-ledger.md): Update a Ledger's name, metadata, or details directly from the Console without redeploying anything.
- [Editing Account information](https://docs.lerian.studio/en/platform/lerian-console/midaz-console/editing-account-information.md): Update an Account's name, metadata, or other details from the Console to keep its information current.
- [Editing an Account Type](https://docs.lerian.studio/en/platform/lerian-console/midaz-console/editing-account-type.md): Update an Account Type's information from the Console to refine validation rules and Ledger structure.
- [Editing an Accounting Route](https://docs.lerian.studio/en/platform/lerian-console/midaz-console/editing-an-accounting-route.md): Update an Accounting Route to change its Transaction route information or modify its operation routes.
- [Editing an Organization](https://docs.lerian.studio/en/platform/lerian-console/midaz-console/editing-an-organization.md): Update an Organization's details from the Midaz Module to keep its profile and configuration current.
- [Editing Asset information](https://docs.lerian.studio/en/platform/lerian-console/midaz-console/editing-asset-information.md): Update an Asset's name, metadata, or other details from the Console without affecting its balances.
- [Editing Portfolio information](https://docs.lerian.studio/en/platform/lerian-console/midaz-console/editing-portfolio-information.md): Update a Portfolio's name, metadata, or details directly in the Console to keep groupings accurate.
- [Editing Segment information](https://docs.lerian.studio/en/platform/lerian-console/midaz-console/editing-segment-information.md): Update a Segment's name, metadata, or details from the Console to refine how Accounts are classified.
- [Creating a Fee Package](https://docs.lerian.studio/en/platform/lerian-console/midaz-console/fe-creating-a-package.md): Build a new Fee Package in the Midaz Module to define how fees are calculated and applied to Transactions.
- [Deleting a Fee Package](https://docs.lerian.studio/en/platform/lerian-console/midaz-console/fe-deleting-a-package.md): Permanently remove a Fee Package from the Midaz Module — once deleted, the package cannot be recovered.
- [Editing a Fee Package](https://docs.lerian.studio/en/platform/lerian-console/midaz-console/fe-editing-a-package.md): Update an existing Fee Package to refine fee rules or adjust how charges apply to your Transactions.
- [Running a Fee Estimation](https://docs.lerian.studio/en/platform/lerian-console/midaz-console/fe-fee-simulation.md): Use the Fee Calculator to estimate how fees will apply before running real Transactions in your Ledger.
- [Fees Engine](https://docs.lerian.studio/en/platform/lerian-console/midaz-console/fees-engine-overview.md): Understand how the Fees Engine lets you define, simulate, and apply fee rules to Transactions in the Midaz Module.
- [Managing Account Types](https://docs.lerian.studio/en/platform/lerian-console/midaz-console/managing-account-types.md): Create, edit, and delete Account Types from the Midaz Module to enforce Ledger structure across your Accounts.
- [Managing Accounting Routes](https://docs.lerian.studio/en/platform/lerian-console/midaz-console/managing-accounting-routes.md): Create, edit, and delete Accounting Routes from the Console to control how Transactions and operations flow.
- [Managing Accounts](https://docs.lerian.studio/en/platform/lerian-console/midaz-console/managing-accounts.md): Create, edit, and delete Accounts from the Lerian Console to keep your Ledger structure clean and current.
- [Managing Assets](https://docs.lerian.studio/en/platform/lerian-console/midaz-console/managing-assets.md): Create, edit, and delete the Assets registered in your Ledger directly from the Midaz Module.
- [Managing Alias Accounts](https://docs.lerian.studio/en/platform/lerian-console/midaz-console/managing-crm-alias-accounts.md): Create, edit, and delete Alias Accounts in the CRM to give Holders friendly identifiers for their Accounts.
- [Managing Holders](https://docs.lerian.studio/en/platform/lerian-console/midaz-console/managing-crm-holders.md): Create, edit, and delete Holders in the CRM to manage the people and entities that own your Accounts.
- [Fee Calculator](https://docs.lerian.studio/en/platform/lerian-console/midaz-console/managing-fee-calculations.md): Use the Fee Calculator in the Console to estimate and validate how Fee Packages apply before processing Transactions.
- [Managing Fee Packages](https://docs.lerian.studio/en/platform/lerian-console/midaz-console/managing-fee-packages.md): Create, edit, and delete Fee Packages from the Console to control how charges are applied to Transactions.
- [Managing Ledgers](https://docs.lerian.studio/en/platform/lerian-console/midaz-console/managing-ledgers-via-console.md): Create, edit, and delete the Ledgers in your Organization directly from the Midaz Module.
- [Managing Organizations](https://docs.lerian.studio/en/platform/lerian-console/midaz-console/managing-organizations.md): Create, edit, and delete Organizations in the Midaz Module — the top-level entities that hold your Ledgers.
- [Managing Portfolios](https://docs.lerian.studio/en/platform/lerian-console/midaz-console/managing-portfolios.md): Create, edit, and delete Portfolios from the Lerian Console interface to keep your Account groupings organized.
- [Managing Segments](https://docs.lerian.studio/en/platform/lerian-console/midaz-console/managing-segments.md): Create, edit, and delete Segments from the Console to classify Accounts by characteristics or business rules.
- [Managing Transactions](https://docs.lerian.studio/en/platform/lerian-console/midaz-console/managing-transactions.md): Create and inspect Transactions from the Midaz Module to record movements between Accounts in your Ledger.
- [Accounting rules](https://docs.lerian.studio/en/platform/lerian-console/midaz-console/mc-accounting.md): Set up Account Types and Accounting Routes that govern how Transactions flow through your financial system.
- [Account management](https://docs.lerian.studio/en/platform/lerian-console/midaz-console/mc-accounts.md): Manage Accounts, Holders, Aliases, Segments, and Portfolios in one place to organize your financial structure.
- [Plugin integrations](https://docs.lerian.studio/en/platform/lerian-console/midaz-console/mc-console-plugins.md): Discover the Lerian plugins integrated into the Midaz Module and how they extend Midaz Core functionality.
- [Foundation elements](https://docs.lerian.studio/en/platform/lerian-console/midaz-console/mc-foundation.md): Set up the Organizations, Ledgers, and Assets that form the structural backbone of your financial system.
- [Transaction basics](https://docs.lerian.studio/en/platform/lerian-console/midaz-console/mc-transactions.md): Use the Midaz Module to record Transactions that move Assets between Accounts in your Ledger.
- [Midaz Module onboarding](https://docs.lerian.studio/en/platform/lerian-console/midaz-console/midaz-console-onboarding.md): Follow the guided onboarding to set up your Organization and create your first Ledger in just a few steps.
- [About Midaz module](https://docs.lerian.studio/en/platform/lerian-console/midaz-console/midaz-module.md): Manage Organizations, Ledgers, Accounts, Assets, and Transactions through a visual interface in the Lerian Console.
- [Midaz module settings](https://docs.lerian.studio/en/platform/lerian-console/midaz-console/midaz-settings.md): Manage plugins and product preferences for the Midaz Module to enable or disable features as needed.
- [Adding a Data Source](https://docs.lerian.studio/en/platform/lerian-console/reporter-console/adding-a-data-source.md): Configure a database connection so Reporter can fetch the data needed to generate regulatory reports from your templates.
- [Adding a template](https://docs.lerian.studio/en/platform/lerian-console/reporter-console/adding-template.md): Upload a pre-built .tpl file to the Console to make it available for regulatory report generation in Reporter.
- [Deleting a Data Source](https://docs.lerian.studio/en/platform/lerian-console/reporter-console/deleting-a-data-source.md): Permanently remove a Data Source from Reporter when no active reports depend on its database connection.
- [Deleting a template](https://docs.lerian.studio/en/platform/lerian-console/reporter-console/deleting-a-template.md): Remove a template from Reporter when it is no longer required for any regulatory report generation in your environment.
- [Downloading a report](https://docs.lerian.studio/en/platform/lerian-console/reporter-console/downloading-a-report.md): Download a finished report from the Console once Reporter has completed generation, ready for submission or archiving.
- [Editing a Data Source](https://docs.lerian.studio/en/platform/lerian-console/reporter-console/editing-a-data-source.md): Update an existing Data Source — change credentials, switch the host, or adjust SSL settings without recreating the connection.
- [Editing a report](https://docs.lerian.studio/en/platform/lerian-console/reporter-console/editing-a-report.md): Understand why generated reports cannot be edited and how to update the underlying template before regenerating the report.
- [Generating a report](https://docs.lerian.studio/en/platform/lerian-console/reporter-console/generating-a-report.md): Generate a regulatory report through a 4-step wizard that guides you from template selection to the final compiled output.
- [Data Sources overview](https://docs.lerian.studio/en/platform/lerian-console/reporter-console/managing-data-sources.md): Manage database connections that supply data to Reporter, with reusable connection profiles for every report you generate.
- [Reports overview](https://docs.lerian.studio/en/platform/lerian-console/reporter-console/managing-reports.md): Generate, filter, track status, and download regulatory reports created from your uploaded templates in the Reporter module.
- [Templates overview](https://docs.lerian.studio/en/platform/lerian-console/reporter-console/managing-templates.md): Manage reusable templates that define the structure and format of every regulatory report Reporter generates from your data.
- [Reporter overview](https://docs.lerian.studio/en/platform/lerian-console/reporter-console/reporter-module.md): Manage reusable templates, configure data sources, and generate downloadable regulatory reports tailored to your organization's data.
- [Using the Template Builder](https://docs.lerian.studio/en/platform/lerian-console/reporter-console/template-builder.md): Build report templates visually by assembling blocks instead of writing .tpl code manually, and let the builder generate it for you.
- [Testing a Data Source connection](https://docs.lerian.studio/en/platform/lerian-console/reporter-console/testing-a-data-source.md): Verify that a Data Source's credentials and network settings are correct before relying on it for report generation.
- [Updating a template](https://docs.lerian.studio/en/platform/lerian-console/reporter-console/updating-a-template.md): Update a template's name, output format, or replace the uploaded .tpl file directly from the Lerian Console interface.
- [About settings](https://docs.lerian.studio/en/platform/lerian-console/settings/about-settings.md): Configure your platform environment from a single Settings area covering applications, users, products, and system preferences.
- [Changing a User's Password](https://docs.lerian.studio/en/platform/lerian-console/settings/am-changing-password.md): Update an existing user's password from the Console to maintain account security and meet your access control policies.
- [Creating an Application](https://docs.lerian.studio/en/platform/lerian-console/settings/am-creating-application.md): Create an application in the Console to grant API access to external systems and control how they integrate with your platform.
- [Creating a User](https://docs.lerian.studio/en/platform/lerian-console/settings/am-creating-user.md): Set up a new user in the Console with the credentials and permissions needed to access your Lerian platform.
- [Deleting an application](https://docs.lerian.studio/en/platform/lerian-console/settings/am-deleting-application.md): Permanently revoke an application's credentials and immediately cut off API access for any connected external system.
- [Deleting a User](https://docs.lerian.studio/en/platform/lerian-console/settings/am-deleting-user.md): Permanently remove a user account from the Console and immediately revoke their access to your Lerian platform.
- [Editing a User](https://docs.lerian.studio/en/platform/lerian-console/settings/am-editing-user.md): Update a user's profile information from the Console while preserving their immutable username and account history.
- [Viewing Application details](https://docs.lerian.studio/en/platform/lerian-console/settings/am-viewing-application.md): Inspect an application's read-only configuration to verify credentials, scopes, and integration details from the Console.
- [Managing Applications](https://docs.lerian.studio/en/platform/lerian-console/settings/managing-applications.md): Manage API client applications with unique Client ID and Secret credentials for machine-to-machine authentication with the Console.
- [Managing Users](https://docs.lerian.studio/en/platform/lerian-console/settings/managing-users.md): Manage user accounts, control access permissions, and maintain credentials so each person sees only what their role allows.
- [Products](https://docs.lerian.studio/en/platform/lerian-console/settings/settings-products.md): Enable or disable Lerian product modules in your environment to control which capabilities Console users can access.
- [System](https://docs.lerian.studio/en/platform/lerian-console/settings/settings-system.md): Configure global preferences that affect the entire Lerian Console experience, including language and other system-wide settings.
- [Managing Limits](https://docs.lerian.studio/en/platform/lerian-console/tracer-console/managing-limits.md): Configure transaction spending caps and thresholds — per transaction, daily, or monthly — scoped to accounts, segments, or transaction types.
- [Managing Rules](https://docs.lerian.studio/en/platform/lerian-console/tracer-console/managing-rules.md): Create fraud detection rules with CEL expressions that allow, deny, or flag transactions for review based on your business policies.
- [Managing Validations](https://docs.lerian.studio/en/platform/lerian-console/tracer-console/managing-validations.md): Review the read-only history of every transaction validation decision generated automatically by Tracer rules and limits.
- [Tracer in Lerian Console](https://docs.lerian.studio/en/platform/lerian-console/tracer-console/tracer-module.md): Configure real-time fraud detection rules, set spending limits, and review the audit trail of every transaction validation decision.
- [Overview](https://docs.lerian.studio/en/platform/lifecycle-management.md): Orchestrate the full lifecycle of Lerian applications in customer-owned infrastructure with native Helm Chart and Kubernetes integration.
- [About Observability](https://docs.lerian.studio/en/platform/observability.md): Understand how telemetry — metrics, logs, and traces — flows through Midaz so you can monitor performance and troubleshoot issues.
- [Platform services](https://docs.lerian.studio/en/platform/platform-introduction.md): Discover the cross-product services — access control, lifecycle, console, observability — that power every Lerian product on a unified foundation.
- [Using Lifecycle Management](https://docs.lerian.studio/en/platform/using-lifecycle-management.md): With your application deployed, you can:
- [Key differences](https://docs.lerian.studio/en/products-and-plugins.md): Understand the difference between Lerian products and plugins so you know what to adopt by default and what to add as your needs grow.
- [Access Manager error list](https://docs.lerian.studio/en/reference/access-manager/access-manager-error-list.md): The **Access Manager** returns consistent and structured error responses. This helps you quickly understand what went wrong and how to fix it.
- [Access Manager API Reference](https://docs.lerian.studio/en/reference/access-manager/am-api-introduction.md)
- [Auth APIs](https://docs.lerian.studio/en/reference/access-manager/am-auth-apis.md)
- [Identity APIs](https://docs.lerian.studio/en/reference/access-manager/am-identity-apis.md)
- [Create an Application](https://docs.lerian.studio/en/reference/access-manager/create-an-application.md): Use this endpoint to create the credentials that an external application will use to integrate with Lerian's application. Ideal for registering applications that need to interact with the plugin (M2M).
- [Create a User](https://docs.lerian.studio/en/reference/access-manager/create-user.md): Use this endpoint to create a user access and assign it to a permission group in a single step.
- [Delete an Application](https://docs.lerian.studio/en/reference/access-manager/delete-application.md): Use this endpoint to remove an application and its associated credentials from the system. This action is permanent and cannot be undone.
- [Delete a User](https://docs.lerian.studio/en/reference/access-manager/delete-user.md): Use this endpoint to remove a user's access from the system. This action is irreversible.
- [End User Session](https://docs.lerian.studio/en/reference/access-manager/end-user-session.md): Use this endpoint to end the user session and revoke active tokens, ensuring a secure and complete logout from the application.
- [List Applications](https://docs.lerian.studio/en/reference/access-manager/list-applications.md): Use this endpoint to list all applications that you have created to connect with Lerian's application using M2M credentials—based on the identity provider settings you configured.
- [List Groups](https://docs.lerian.studio/en/reference/access-manager/list-groups.md): Use this endpoint to list all predefined groups available in the system.
- [List Users](https://docs.lerian.studio/en/reference/access-manager/list-users.md): Use this endpoint to list all users registered in the system.
- [Refresh the Access Token](https://docs.lerian.studio/en/reference/access-manager/refresh-token.md): Use this endpoint to renew an expired access token with a valid refresh token.
- [Request an Access Token](https://docs.lerian.studio/en/reference/access-manager/request-access-token.md): Use this endpoint to get an access token for a user or client.
- [Reset a User Password](https://docs.lerian.studio/en/reference/access-manager/reset-user-password.md): Use this endpoint to reset a user's password. Ideal for recovery flows or admin-initiated resets.
- [Retrieve an Application](https://docs.lerian.studio/en/reference/access-manager/retrieve-application-details.md): Retrieves detailed information about an Application using its unique identifier.
- [Retrieve Group details](https://docs.lerian.studio/en/reference/access-manager/retrieve-group-details.md): Use this endpoint to get detailed information about a specific group using its unique identifier.
- [Retrieve User details](https://docs.lerian.studio/en/reference/access-manager/retrieve-user-details.md): Use this endpoint to get detailed information about a specific user using their unique identifier.
- [Retrieve User Information](https://docs.lerian.studio/en/reference/access-manager/retrieve-user-information.md): Use this endpoint to retrieve the user information using the OIDC standard.
- [Retrieve User Permission](https://docs.lerian.studio/en/reference/access-manager/retrieve-user-permissions.md): Use this endpoint to retrieve all the permissions that a user has based on the `access_token`. This endpoint is used by Midaz Console to verify the features that the user has access to.
- [Update a User](https://docs.lerian.studio/en/reference/access-manager/update-user.md): Use this endpoint to update a user's information, such as name, email, or group assignments.
- [Update a User Password](https://docs.lerian.studio/en/reference/access-manager/update-user-password.md): Use this endpoint to change a user's password by providing the current (old) password along with the new one. Ideal for self-service password updates.
- [Validate User Permission](https://docs.lerian.studio/en/reference/access-manager/validate-user-permission.md): Use this endpoint to check if a user is allowed to perform a specific action on a resource. Typically used in M2M authentication with Midaz.
- [Default network ports](https://docs.lerian.studio/en/reference/default-network-ports.md): This page lists the default ports used by **Midaz** and the **plugins**. If you're deploying in a self-hosted environment, we recommend checking if the required ports are available and open in your infrastructure.
- [Error handling](https://docs.lerian.studio/en/reference/error-handling.md): How to interpret, classify, and resolve errors returned by Lerian APIs.
- [Activate a Workflow](https://docs.lerian.studio/en/reference/flowker/activate-workflow.md): Use this endpoint to activate a workflow. Transitions the status from `draft` to `active`.
- [Check Liveness](https://docs.lerian.studio/en/reference/flowker/check-liveness.md): Use this endpoint to verify that the Flowker service process is running. Returns 200 OK when the service is alive.
- [Check Readiness](https://docs.lerian.studio/en/reference/flowker/check-readiness.md): Use this endpoint to verify that the Flowker service is ready to accept traffic. Returns 200 OK when all dependencies are healthy.
- [Check Service Health](https://docs.lerian.studio/en/reference/flowker/check-service-health.md): Use this endpoint to check the overall health of the Flowker service, including uptime and version details.
- [Clone a Workflow](https://docs.lerian.studio/en/reference/flowker/clone-workflow.md): Use this endpoint to create a copy of an existing workflow with a new name. The cloned workflow is created in `draft` status.
- [Create a Provider Configuration](https://docs.lerian.studio/en/reference/flowker/create-provider-configuration.md): Use this endpoint to create a new provider configuration. The configuration is validated against the provider's JSON Schema.
- [Create a Workflow](https://docs.lerian.studio/en/reference/flowker/create-workflow.md): Use this endpoint to create a new workflow definition. New workflows are created in `draft` status.
- [Deactivate a Workflow](https://docs.lerian.studio/en/reference/flowker/deactivate-workflow.md): Use this endpoint to deactivate a workflow. Transitions the status from `active` to `inactive`.
- [Delete an Executor Configuration](https://docs.lerian.studio/en/reference/flowker/delete-executor-configuration.md): Use this endpoint to delete an executor configuration. Only configurations with `unconfigured`, `configured`, or `disabled` status can be deleted.
- [Delete a Provider Configuration](https://docs.lerian.studio/en/reference/flowker/delete-provider-configuration.md): Use this endpoint to delete a provider configuration.
- [Delete a Workflow](https://docs.lerian.studio/en/reference/flowker/delete-workflow.md): Use this endpoint to delete a workflow definition. Only workflows with `draft` or `inactive` status can be deleted.
- [Disable a Provider Configuration](https://docs.lerian.studio/en/reference/flowker/disable-provider-configuration.md): Use this endpoint to disable a provider configuration. Transitions the status from `active` to `disabled`.
- [Enable a Provider Configuration](https://docs.lerian.studio/en/reference/flowker/enable-provider-configuration.md): Use this endpoint to enable a provider configuration. Transitions the status from `disabled` to `active`.
- [Execute a Workflow](https://docs.lerian.studio/en/reference/flowker/execute-workflow.md): Use this endpoint to start a new workflow execution. The request returns immediately with a `pending` status. Use the Idempotency-Key header to ensure safe retries.
- [Getting started with Flowker](https://docs.lerian.studio/en/reference/flowker/flowker-api-quick-start.md)
- [Flowker error list](https://docs.lerian.studio/en/reference/flowker/flowker-error-list.md): Flowker APIs return a structured error object for all errors to simplify issue diagnosis.
- [Implementing observability in Flowker](https://docs.lerian.studio/en/reference/flowker/flowker-implementing-observability.md)
- [Get Application Version](https://docs.lerian.studio/en/reference/flowker/get-application-version.md): Use this endpoint to retrieve the current Flowker service version and request timestamp.
- [Get Audit Event by ID](https://docs.lerian.studio/en/reference/flowker/get-audit-event-by-id.md): Retrieve a single audit event by its unique event ID.
- [Get a Catalog Executor](https://docs.lerian.studio/en/reference/flowker/get-catalog-executor.md): Use this endpoint to retrieve the metadata and JSON Schema of a specific catalog executor.
- [Get a Catalog Provider](https://docs.lerian.studio/en/reference/flowker/get-catalog-provider.md): Use this endpoint to retrieve the metadata and JSON Schema of a specific catalog provider.
- [Get a Catalog Trigger](https://docs.lerian.studio/en/reference/flowker/get-catalog-trigger.md): Use this endpoint to retrieve the metadata and JSON Schema of a specific catalog trigger.
- [Get Execution Results](https://docs.lerian.studio/en/reference/flowker/get-execution-results.md): Use this endpoint to retrieve the results of a completed workflow execution. The execution must be in a terminal state.
- [Get an Execution Status](https://docs.lerian.studio/en/reference/flowker/get-execution-status.md): Use this endpoint to retrieve the current status of a specific workflow execution.
- [Get an Executor Configuration](https://docs.lerian.studio/en/reference/flowker/get-executor-configuration.md): Use this endpoint to retrieve a specific executor configuration by its unique identifier.
- [Get a Provider Configuration](https://docs.lerian.studio/en/reference/flowker/get-provider-configuration.md): Use this endpoint to retrieve a specific provider configuration by its unique identifier.
- [Get a Workflow](https://docs.lerian.studio/en/reference/flowker/get-workflow.md): Use this endpoint to retrieve a specific workflow definition by its unique identifier.
- [List Catalog Executors](https://docs.lerian.studio/en/reference/flowker/list-catalog-executors.md): Use this endpoint to retrieve all built-in executors registered in the catalog.
- [List Catalog Providers](https://docs.lerian.studio/en/reference/flowker/list-catalog-providers.md): Use this endpoint to retrieve all registered providers from the catalog.
- [List Catalog Triggers](https://docs.lerian.studio/en/reference/flowker/list-catalog-triggers.md): Use this endpoint to retrieve all built-in triggers registered in the catalog.
- [List Executions](https://docs.lerian.studio/en/reference/flowker/list-executions.md): Use this endpoint to retrieve a paginated list of workflow executions. You can filter results by workflow ID or status.
- [List Executor Configurations](https://docs.lerian.studio/en/reference/flowker/list-executor-configurations.md): Use this endpoint to retrieve a paginated list of executor configurations. You can filter results by status.
- [List Executors by Provider](https://docs.lerian.studio/en/reference/flowker/list-executors-by-provider.md): Use this endpoint to retrieve all executors that belong to a specific provider.
- [List Provider Configurations](https://docs.lerian.studio/en/reference/flowker/list-provider-configurations.md): Use this endpoint to retrieve a paginated list of provider configurations. You can filter results by status or provider ID.
- [List Workflows](https://docs.lerian.studio/en/reference/flowker/list-workflows.md): Use this endpoint to retrieve a paginated list of workflows. You can filter results by status.
- [Search Audit Events](https://docs.lerian.studio/en/reference/flowker/search-audit-events.md): Retrieve a paginated list of audit events. Supports filtering by event type, action, result, resource, and date range. Results use cursor-based pagination.
- [Test a Provider Configuration](https://docs.lerian.studio/en/reference/flowker/test-provider-configuration.md): Use this endpoint to test connectivity, authentication, and end-to-end communication with the configured provider.
- [Trigger a Webhook](https://docs.lerian.studio/en/reference/flowker/trigger-webhook.md): Receives a webhook callback and triggers the associated workflow execution. The path is dynamically resolved against the webhook registry — each workflow can register its own webhook path. At runtime, GET, PUT, DELETE, and PATCH methods are also accepted, as well as nested paths with multiple segmen…
- [Update an Executor Configuration](https://docs.lerian.studio/en/reference/flowker/update-executor-configuration.md): Use this endpoint to update an existing executor configuration. Only configurations with `unconfigured` or `configured` status can be updated.
- [Update a Provider Configuration](https://docs.lerian.studio/en/reference/flowker/update-provider-configuration.md): Use this endpoint to update an existing provider configuration. If the configuration payload changes, it is re-validated against the provider's JSON Schema.
- [Update a Workflow](https://docs.lerian.studio/en/reference/flowker/update-workflow.md): Use this endpoint to update an existing workflow definition. Only workflows with `draft` status can be updated.
- [Validate an Executor Configuration](https://docs.lerian.studio/en/reference/flowker/validate-executor-config.md): Use this endpoint to validate an executor configuration against its JSON Schema.
- [Verify Audit Hash Chain](https://docs.lerian.studio/en/reference/flowker/verify-audit-hash-chain.md): Verify the integrity of the audit hash chain up to the specified event. Returns whether the chain is intact and, if not, identifies the first broken entry.
- [Before you begin](https://docs.lerian.studio/en/reference/getting-started.md)
- [API patterns and tools](https://docs.lerian.studio/en/reference/integration-essentials.md)
- [Welcome to our API Reference](https://docs.lerian.studio/en/reference/introduction.md)
- [Lerian's License](https://docs.lerian.studio/en/reference/lerians-license.md)
- [Licenses & credits](https://docs.lerian.studio/en/reference/licenses-and-credits.md)
- [Add a comment to an exception](https://docs.lerian.studio/en/reference/matcher/add-exception-comment.md): Use this endpoint to add a comment to a specific exception. Comments help track team discussions, decisions, and investigation notes.
- [Adjust entry for an exception](https://docs.lerian.studio/en/reference/matcher/adjust-entry-exception.md): Use this endpoint to resolve an exception by creating an adjustment entry. This is used when a monetary correction is needed to reconcile the transaction.
- [Bulk assign exceptions](https://docs.lerian.studio/en/reference/matcher/bulk-assign-exceptions.md): Use this endpoint to assign multiple exceptions to a team member in a single operation. You can assign up to 100 exceptions at a time.
- [Bulk dispatch exceptions](https://docs.lerian.studio/en/reference/matcher/bulk-dispatch-exceptions.md): Use this endpoint to dispatch multiple exceptions to an external system in a single operation. You can dispatch up to 100 exceptions at a time.
- [Bulk resolve exceptions](https://docs.lerian.studio/en/reference/matcher/bulk-resolve-exceptions.md): Use this endpoint to resolve multiple exceptions in a single operation. You can resolve up to 100 exceptions at a time with a shared resolution and reason.
- [Cancel an export job](https://docs.lerian.studio/en/reference/matcher/cancel-export-job.md): Use this endpoint to cancel a queued or running export job.
- [Clone a reconciliation context](https://docs.lerian.studio/en/reference/matcher/clone-context.md): Use this endpoint to clone an existing reconciliation context with its associated sources, rules, and fee schedules. You can selectively include or exclude specific components.
- [Close a dispute](https://docs.lerian.studio/en/reference/matcher/close-dispute.md): Use this endpoint to close a dispute with a resolution. The dispute can be marked as won or lost based on the outcome.
- [Count exceptions](https://docs.lerian.studio/en/reference/matcher/count-exceptions.md): Use this endpoint to retrieve the total number of exceptions for a specific context and date range.
- [Count matches](https://docs.lerian.studio/en/reference/matcher/count-matches.md): Use this endpoint to retrieve the total number of matched items for a specific context and date range.
- [Count transactions](https://docs.lerian.studio/en/reference/matcher/count-transactions.md): Use this endpoint to retrieve the total number of transactions for a specific context and date range.
- [Count unmatched items](https://docs.lerian.studio/en/reference/matcher/count-unmatched.md): Use this endpoint to retrieve the total number of unmatched items for a specific context and date range.
- [Create an adjustment](https://docs.lerian.studio/en/reference/matcher/create-adjustment.md): Use this endpoint to create a balancing journal entry (e.g., bank fee, FX difference) to resolve variance between matched transactions or on a single transaction.
- [Create a reconciliation context](https://docs.lerian.studio/en/reference/matcher/create-context.md): Use this endpoint to create a new reconciliation context. Contexts are used to scope matching rules and organize your reconciliation configuration.
- [Create an export job](https://docs.lerian.studio/en/reference/matcher/create-export-job.md): Use this endpoint to create an asynchronous export job for large report exports. Supported formats include CSV, JSON, and XML.
- [Start a connection extraction](https://docs.lerian.studio/en/reference/matcher/create-extraction.md): Use this endpoint to create an extraction request for a discovered connection and submit it to Fetcher for the authenticated tenant.
- [Create a fee rule](https://docs.lerian.studio/en/reference/matcher/create-fee-rule.md): Use this endpoint to create a new fee rule that maps transaction metadata to a fee schedule within a context.
- [Create a fee schedule](https://docs.lerian.studio/en/reference/matcher/create-fee-schedule.md): Use this endpoint to create a new fee schedule. Fee schedules define the fee structure applied to transactions during reconciliation.
- [Create a field map](https://docs.lerian.studio/en/reference/matcher/create-field-map.md): Use this endpoint to create a field map for a specific source within a context. Field maps define how source fields are mapped to reconciliation fields.
- [Create a manual match](https://docs.lerian.studio/en/reference/matcher/create-manual-match.md): Use this endpoint to manually link multiple transactions (at least 2) into a match group with 100% confidence. Transactions must be UNMATCHED and belong to the specified context.
- [Create a match rule](https://docs.lerian.studio/en/reference/matcher/create-match-rule.md): Use this endpoint to create a new match rule within a specific context. Match rules define how transactions are matched during reconciliation.
- [Create a schedule](https://docs.lerian.studio/en/reference/matcher/create-schedule.md): Use this endpoint to create a cron-based reconciliation schedule for automatic matching within a context.
- [Create a reconciliation source](https://docs.lerian.studio/en/reference/matcher/create-source.md): Use this endpoint to create a new reconciliation source under a specific context. Sources define where transaction data comes from for reconciliation.
- [Delete an actor mapping](https://docs.lerian.studio/en/reference/matcher/delete-actor-mapping.md): Use this endpoint to delete an actor mapping by its identifier.
- [Delete a reconciliation context](https://docs.lerian.studio/en/reference/matcher/delete-context.md): Use this endpoint to delete a specific reconciliation context by its identifier.
- [Delete an exception comment](https://docs.lerian.studio/en/reference/matcher/delete-exception-comment.md): Use this endpoint to delete a specific comment from an exception.
- [Delete a fee rule](https://docs.lerian.studio/en/reference/matcher/delete-fee-rule.md): Use this endpoint to permanently remove a fee rule by its identifier.
- [Delete a fee schedule](https://docs.lerian.studio/en/reference/matcher/delete-fee-schedule.md): Use this endpoint to delete a specific fee schedule by its identifier.
- [Delete a field map](https://docs.lerian.studio/en/reference/matcher/delete-field-map.md): Use this endpoint to delete a specific field map by its identifier.
- [Delete a match rule](https://docs.lerian.studio/en/reference/matcher/delete-match-rule.md): Use this endpoint to delete a specific match rule by its identifier.
- [Delete a schedule](https://docs.lerian.studio/en/reference/matcher/delete-schedule.md): Use this endpoint to delete a reconciliation schedule from a context.
- [Delete a reconciliation source](https://docs.lerian.studio/en/reference/matcher/delete-source.md): Use this endpoint to delete a specific reconciliation source by its identifier.
- [Get discovery status](https://docs.lerian.studio/en/reference/matcher/discovery-status.md): Use this endpoint to retrieve the current Fetcher integration status, including whether the Fetcher service is healthy and how many connections have been discovered.
- [Dispatch exception to external system](https://docs.lerian.studio/en/reference/matcher/dispatch-exception.md): Use this endpoint to dispatch an exception to an external ticketing system such as JIRA or ServiceNow for tracking and resolution.
- [Download an audit log archive](https://docs.lerian.studio/en/reference/matcher/download-archive.md): Use this endpoint to download an audit log archive. Returns a pre-signed URL with a time-limited download link and a SHA-256 checksum for integrity verification.
- [Download export file](https://docs.lerian.studio/en/reference/matcher/download-export-job.md): Use this endpoint to download the export file. The response includes a presigned URL for downloading the file.
- [Export matched transactions report](https://docs.lerian.studio/en/reference/matcher/export-matched-report.md): Use this endpoint to export a matched transactions report in CSV or PDF format for the specified date range.
- [Export summary report](https://docs.lerian.studio/en/reference/matcher/export-summary-report.md): Use this endpoint to export a reconciliation summary report in CSV or PDF format for the specified date range.
- [Export unmatched transactions report](https://docs.lerian.studio/en/reference/matcher/export-unmatched-report.md): Use this endpoint to export an unmatched transactions report in CSV or PDF format for the specified date range.
- [Export variance report](https://docs.lerian.studio/en/reference/matcher/export-variance-report.md): Use this endpoint to export a variance analysis report in CSV or PDF format for the specified date range.
- [Force match an exception](https://docs.lerian.studio/en/reference/matcher/force-match-exception.md): Use this endpoint to resolve an exception by forcing a match with an override reason. This is used when manual intervention determines the transaction should be considered matched despite discrepancies.
- [Get an actor mapping](https://docs.lerian.studio/en/reference/matcher/get-actor-mapping.md): Use this endpoint to retrieve the display name and email mapped to a specific actor identifier.
- [Get Fetcher bridge readiness summary](https://docs.lerian.studio/en/reference/matcher/get-bridge-readiness-summary.md): Returns aggregate counts of Fetcher extractions partitioned by bridge readiness state (pending, ready, stale, failed, in_flight) for the requesting tenant. Powers the operational dashboard backlog widget.
- [Get cash impact summary](https://docs.lerian.studio/en/reference/matcher/get-cash-impact.md): Use this endpoint to retrieve a cash impact summary showing the total unmatched financial exposure. Includes breakdowns by currency and by age bucket to help prioritize resolution efforts.
- [Get connection schema](https://docs.lerian.studio/en/reference/matcher/get-connection-schema.md): Use this endpoint to retrieve all discovered table schemas for a specific connection.
- [Get all dashboard aggregates](https://docs.lerian.studio/en/reference/matcher/get-dashboard-aggregates.md): Use this endpoint to retrieve combined dashboard aggregates including volume, match rate, and SLA statistics.
- [Get comprehensive dashboard metrics](https://docs.lerian.studio/en/reference/matcher/get-dashboard-metrics.md): Use this endpoint to retrieve complete dashboard metrics including summary, trends, and breakdowns for the Command Center.
- [Get match rate statistics](https://docs.lerian.studio/en/reference/matcher/get-match-rate-stats.md): Use this endpoint to retrieve match rate percentage and trend data for a reconciliation context within the specified date range.
- [Get SLA statistics](https://docs.lerian.studio/en/reference/matcher/get-sla-stats.md): Use this endpoint to retrieve SLA compliance statistics for a reconciliation context within the specified date range.
- [Get source breakdown](https://docs.lerian.studio/en/reference/matcher/get-source-breakdown.md): Use this endpoint to retrieve a breakdown of reconciliation metrics by source for a specific context and date range. Shows match rates, transaction counts, and unmatched amounts per source.
- [Get reconciliation summary report](https://docs.lerian.studio/en/reference/matcher/get-summary-report.md): Use this endpoint to retrieve an aggregated reconciliation summary for a specific context and date range, including matched and unmatched counts and amounts.
- [Service version](https://docs.lerian.studio/en/reference/matcher/get-version.md): Returns the service version from the VERSION environment variable (defaults to "0.0.0").
- [Get volume statistics](https://docs.lerian.studio/en/reference/matcher/get-volume-stats.md): Use this endpoint to retrieve transaction volume statistics for a reconciliation context within the specified date range.
- [Check Matcher health](https://docs.lerian.studio/en/reference/matcher/health-check.md): Use this endpoint to check whether the Matcher service is running and responsive. This endpoint is used by Kubernetes liveness probes to determine when the service must be restarted.
- [Ignore a transaction](https://docs.lerian.studio/en/reference/matcher/ignore-transaction.md): Use this endpoint to mark a transaction as "Do Not Match" with a required reason. Only UNMATCHED transactions can be ignored.
- [List audit log archives](https://docs.lerian.studio/en/reference/matcher/list-archives.md): Use this endpoint to list all audit log archives. Archives contain historical audit log data that has been compressed and moved to long-term storage. Supports offset-based pagination.
- [List audit logs](https://docs.lerian.studio/en/reference/matcher/list-audit-logs.md): Use this endpoint to retrieve all audit log entries. You can filter the results by actor, date range, action type, and entity type. The response uses cursor-based pagination.
- [List audit logs by entity](https://docs.lerian.studio/en/reference/matcher/list-audit-logs-by-entity.md): Use this endpoint to retrieve all audit log entries for a specific entity. The results are ordered by creation time descending. This allows you to trace the complete change history of any entity in the system.
- [List Fetcher bridge readiness candidates](https://docs.lerian.studio/en/reference/matcher/list-bridge-candidates.md): Returns extractions in the requested readiness state with cursor pagination. Drilldown surface for the operational dashboard summary.
- [List reconciliation contexts](https://docs.lerian.studio/en/reference/matcher/list-contexts.md): Use this endpoint to retrieve all reconciliation contexts.
- [List discovered connections](https://docs.lerian.studio/en/reference/matcher/list-discovery-connections.md): Use this endpoint to retrieve all discovered Fetcher database connections available for the current tenant.
- [List disputes](https://docs.lerian.studio/en/reference/matcher/list-disputes.md): Use this endpoint to retrieve all disputes. Supports filtering by state, category, and date range with cursor-based pagination.
- [List exception comments](https://docs.lerian.studio/en/reference/matcher/list-exception-comments.md): Use this endpoint to retrieve all comments for a specific exception. Comments provide an audit trail of team discussions and decisions.
- [List exceptions](https://docs.lerian.studio/en/reference/matcher/list-exceptions.md): Use this endpoint to retrieve all exceptions. You can filter the results by status, severity, assigned user, external system, and date range. The response uses cursor-based pagination.
- [List export jobs](https://docs.lerian.studio/en/reference/matcher/list-export-jobs.md): Use this endpoint to retrieve all export jobs for the authenticated tenant.
- [List export jobs by context](https://docs.lerian.studio/en/reference/matcher/list-export-jobs-by-context.md): Use this endpoint to list all export jobs for a specific reconciliation context. Supports cursor-based pagination.
- [List fee rules](https://docs.lerian.studio/en/reference/matcher/list-fee-rules.md): Use this endpoint to retrieve all fee rules for a reconciliation context, ordered by priority.
- [List fee schedules](https://docs.lerian.studio/en/reference/matcher/list-fee-schedules.md): Use this endpoint to retrieve all fee schedules for the authenticated tenant.
- [List ingestion jobs for a context](https://docs.lerian.studio/en/reference/matcher/list-ingestion-jobs.md): Use this endpoint to retrieve all ingestion jobs for a specific reconciliation context. You can sort the results by various fields. The response uses cursor-based pagination.
- [List transactions for a job](https://docs.lerian.studio/en/reference/matcher/list-job-transactions.md): Use this endpoint to retrieve all transactions extracted from an ingestion job. You can sort the results by various fields. The response uses cursor-based pagination.
- [List match rules](https://docs.lerian.studio/en/reference/matcher/list-match-rules.md): Use this endpoint to retrieve all match rules under a specific context. You can filter the results by rule type. The response uses cursor-based pagination.
- [Get match run results](https://docs.lerian.studio/en/reference/matcher/list-match-run-groups.md): Use this endpoint to retrieve all match groups from a specific matching run. Each group contains matched transaction pairs and confidence scores. The response uses cursor-based pagination.
- [List match runs](https://docs.lerian.studio/en/reference/matcher/list-match-runs.md): Use this endpoint to retrieve all match runs for a specific reconciliation context. The results are sorted by creation time descending.
- [List matched transactions report](https://docs.lerian.studio/en/reference/matcher/list-matched-report.md): Use this endpoint to retrieve a paginated list of matched transactions for a specific context and date range. The response uses cursor-based pagination.
- [List schedules for a context](https://docs.lerian.studio/en/reference/matcher/list-schedules.md): Use this endpoint to retrieve all reconciliation schedules for a specific context.
- [List reconciliation sources](https://docs.lerian.studio/en/reference/matcher/list-sources.md): Use this endpoint to retrieve all reconciliation sources under a specific context. You can filter the results by source type. The response uses cursor-based pagination.
- [List unmatched transactions report](https://docs.lerian.studio/en/reference/matcher/list-unmatched-report.md): Use this endpoint to retrieve a paginated list of unmatched transactions for a specific context and date range. The response uses cursor-based pagination.
- [List variance report](https://docs.lerian.studio/en/reference/matcher/list-variance-report.md): Use this endpoint to retrieve a paginated variance analysis report for a specific context and date range. The response uses cursor-based pagination.
- [Matcher API quick start](https://docs.lerian.studio/en/reference/matcher/matcher-developer-quick-start.md)
- [Matcher error list](https://docs.lerian.studio/en/reference/matcher/matcher-error-list.md): Matcher APIs return a structured error object for all errors to simplify issue diagnosis.
- [Open a dispute](https://docs.lerian.studio/en/reference/matcher/open-dispute.md): Use this endpoint to open a new dispute for an exception. Disputes are used to formally challenge or investigate discrepancies with external parties.
- [Poll an extraction request](https://docs.lerian.studio/en/reference/matcher/poll-extraction.md): Use this endpoint to check the current status of an extraction request against Fetcher and update it accordingly.
- [Preview a transaction file](https://docs.lerian.studio/en/reference/matcher/preview-upload.md): Use this endpoint to preview a transaction file before importing it. Returns sample rows and detected columns to help verify the file structure and field mapping.
- [Process exception callback](https://docs.lerian.studio/en/reference/matcher/process-exception-callback.md): Use this endpoint to process a callback from an external system for a dispatched exception. This updates the exception status based on the external system resolution.
- [Pseudonymize an actor](https://docs.lerian.studio/en/reference/matcher/pseudonymize-actor.md): Use this endpoint to pseudonymize an actor by replacing their display name and email with "[REDACTED]". This supports GDPR right-to-erasure compliance. This action is irreversible.
- [Check Matcher readiness](https://docs.lerian.studio/en/reference/matcher/readiness-check.md): Use this endpoint to check whether the Matcher service is ready to accept traffic.
- [Refresh discovery](https://docs.lerian.studio/en/reference/matcher/refresh-discovery.md): Use this endpoint to force an immediate sync with the Fetcher service, updating the list of connections and their schemas.
- [Reorder match rules](https://docs.lerian.studio/en/reference/matcher/reorder-match-rules.md): Use this endpoint to reorder the priority of match rules within a specific context. The order determines which rules are evaluated first during reconciliation.
- [Get audit log by ID](https://docs.lerian.studio/en/reference/matcher/retrieve-audit-log.md): Use this endpoint to retrieve the details of a specific audit log entry by its identifier. Audit logs contain immutable records of all system operations for compliance and debugging purposes.
- [Get a reconciliation context](https://docs.lerian.studio/en/reference/matcher/retrieve-context.md): Use this endpoint to retrieve the details of a specific reconciliation context by its identifier.
- [Get a discovered connection](https://docs.lerian.studio/en/reference/matcher/retrieve-discovery-connection.md): Use this endpoint to retrieve a single discovered Fetcher connection by its internal identifier.
- [Get a dispute](https://docs.lerian.studio/en/reference/matcher/retrieve-dispute.md): Use this endpoint to retrieve the details of a specific dispute by its identifier, including its current state, category, and any submitted evidence.
- [Get exception](https://docs.lerian.studio/en/reference/matcher/retrieve-exception.md): Use this endpoint to retrieve the details of a specific exception by its identifier.
- [Get exception history](https://docs.lerian.studio/en/reference/matcher/retrieve-exception-history.md): Use this endpoint to retrieve the audit history for an exception. The history shows all actions taken on the exception.
- [Get export job status](https://docs.lerian.studio/en/reference/matcher/retrieve-export-job.md): Use this endpoint to retrieve the status of a specific export job.
- [Get an extraction request](https://docs.lerian.studio/en/reference/matcher/retrieve-extraction.md): Use this endpoint to retrieve the details of a specific extraction request by its identifier.
- [Get a fee rule](https://docs.lerian.studio/en/reference/matcher/retrieve-fee-rule.md): Use this endpoint to retrieve the details of a specific fee rule by its identifier.
- [Get a fee schedule](https://docs.lerian.studio/en/reference/matcher/retrieve-fee-schedule.md): Use this endpoint to retrieve the details of a specific fee schedule by its identifier.
- [Get a field map by source](https://docs.lerian.studio/en/reference/matcher/retrieve-field-map-by-source.md): Use this endpoint to retrieve the field map for a specific source within a context. Field maps define how source fields are mapped to reconciliation fields.
- [Get ingestion job status](https://docs.lerian.studio/en/reference/matcher/retrieve-ingestion-job.md): Use this endpoint to retrieve the status and details of a specific ingestion job by its identifier. The response includes progress metrics and error information.
- [Get a match rule](https://docs.lerian.studio/en/reference/matcher/retrieve-match-rule.md): Use this endpoint to retrieve the details of a specific match rule by its identifier.
- [Get match run](https://docs.lerian.studio/en/reference/matcher/retrieve-match-run.md): Use this endpoint to retrieve the details of a specific match run by its identifier. The response includes status, timing, and aggregate statistics.
- [Get a schedule](https://docs.lerian.studio/en/reference/matcher/retrieve-schedule.md): Use this endpoint to retrieve a specific reconciliation schedule by its identifier.
- [Get a reconciliation source](https://docs.lerian.studio/en/reference/matcher/retrieve-source.md): Use this endpoint to retrieve the details of a specific reconciliation source by its identifier.
- [Trigger a matching run](https://docs.lerian.studio/en/reference/matcher/run-match.md): Use this endpoint to trigger a matching run for a reconciliation context. You can use DRY_RUN mode to test rules without committing results, or COMMIT mode to persist matches.
- [Search transactions](https://docs.lerian.studio/en/reference/matcher/search-transactions.md): Use this endpoint to search transactions within a reconciliation context. Supports free-text search, amount range filters, date filters, and status filters with offset-based pagination.
- [Simulate fee calculation](https://docs.lerian.studio/en/reference/matcher/simulate-fee-schedule.md): Use this endpoint to simulate fee calculation for a given gross amount using a specific fee schedule. Returns the net amount, total fee, and per-item breakdown.
- [Submit evidence to a dispute](https://docs.lerian.studio/en/reference/matcher/submit-evidence.md): Use this endpoint to add evidence to a dispute. Evidence can include comments and optional file attachments to support the dispute case.
- [Test a connection](https://docs.lerian.studio/en/reference/matcher/test-discovery-connection.md): Use this endpoint to test connectivity for a specific discovered connection owned by the current tenant.
- [Break/Unmatch a match group](https://docs.lerian.studio/en/reference/matcher/unmatch-group.md): Use this endpoint to break an incorrect match group. This rejects the match with a reason and reverts all associated transactions to UNMATCHED status.
- [Update a reconciliation context](https://docs.lerian.studio/en/reference/matcher/update-context.md): Use this endpoint to update the fields of a specific reconciliation context by its identifier.
- [Update a fee rule](https://docs.lerian.studio/en/reference/matcher/update-fee-rule.md): Use this endpoint to update the fields of a specific fee rule by its identifier. If the referenced fee schedule changes, the caller must also be allowed to read that fee schedule.
- [Update a fee schedule](https://docs.lerian.studio/en/reference/matcher/update-fee-schedule.md): Use this endpoint to update the fields of a specific fee schedule by its identifier.
- [Update a field map](https://docs.lerian.studio/en/reference/matcher/update-field-map.md): Use this endpoint to update the fields of a specific field map by its identifier.
- [Update a match rule](https://docs.lerian.studio/en/reference/matcher/update-match-rule.md): Use this endpoint to update the fields of a specific match rule by its identifier.
- [Update a schedule](https://docs.lerian.studio/en/reference/matcher/update-schedule.md): Use this endpoint to update an existing reconciliation schedule. You can modify the cron expression and enabled status.
- [Update a reconciliation source](https://docs.lerian.studio/en/reference/matcher/update-source.md): Use this endpoint to update the fields of a specific reconciliation source by its identifier.
- [Upload transaction file](https://docs.lerian.studio/en/reference/matcher/upload-transaction-file.md): Use this endpoint to upload a transaction file (CSV, JSON, or XML) for ingestion into a reconciliation context. The file is parsed, validated, and transactions are extracted for matching.
- [Upsert an actor mapping](https://docs.lerian.studio/en/reference/matcher/upsert-actor-mapping.md): Use this endpoint to create or update an actor mapping. Actor mappings associate system actor identifiers with human-readable display names and email addresses for audit log readability.
- [Metadata](https://docs.lerian.studio/en/reference/metadata.md)
- [Cancel a Pending Transaction](https://docs.lerian.studio/en/reference/midaz/cancel-a-pending-transaction.md): Use this endpoint to cancel a pending transaction that was previously created and placed on hold.
- [Commit a Pending Transaction](https://docs.lerian.studio/en/reference/midaz/commit-a-pending-transaction.md): Use this endpoint to commit a pending transaction that was previously created and placed on hold.
- [Create a Balance](https://docs.lerian.studio/en/reference/midaz/create-a-balance.md): Use this endpoint to add new balances to an account.
- [Create a Ledger](https://docs.lerian.studio/en/reference/midaz/create-a-ledger.md): Use this endpoint to create a Ledger.
- [Create a Metadata Index](https://docs.lerian.studio/en/reference/midaz/create-a-metadata-index.md): Use this endpoint to create a metadata index for a specific entity type. Metadata indexes improve query performance when filtering or searching by custom metadata fields.
- [Create a Portfolio](https://docs.lerian.studio/en/reference/midaz/create-a-portfolio.md): Use this endpoint to create a Portfolio.
- [Create a Segment](https://docs.lerian.studio/en/reference/midaz/create-a-segment.md): Use this endpoint to create a Segment.
- [Create a Transaction Annotation](https://docs.lerian.studio/en/reference/midaz/create-a-transaction-annotation.md): Use this endpoint to create a transaction with no financial impact, to include operations in the ledger, but without impacting account balances.
- [Create a Transaction using DSL](https://docs.lerian.studio/en/reference/midaz/create-a-transaction-using-dsl.md): Use this endpoint to create a transaction using a DSL file you have previously created.
- [Create a Transaction using JSON](https://docs.lerian.studio/en/reference/midaz/create-a-transaction-using-json.md): Use this endpoint to create a transaction using JSON.
- [Create an Account](https://docs.lerian.studio/en/reference/midaz/create-an-account.md): Use this endpoint to create an Account in Midaz. You can create as many accounts as necessary to structure your ledger, but each request creates only one account at a time.
- [Create an Account Type](https://docs.lerian.studio/en/reference/midaz/create-an-account-type.md): Use this endpoint to create an Account Type. You can create multiple Account Types, but they must be added one at a time.
- [Create an Asset](https://docs.lerian.studio/en/reference/midaz/create-an-asset.md): Use this endpoint to create the Asset that will be used with the transactions. You can create multiple Assets. However, the Assets must be created one at a time, with each Asset requiring specific decimal place settings and other individual parameters to be defined during the creation process.
- [Create an Inflow Transaction](https://docs.lerian.studio/en/reference/midaz/create-an-inflow-transaction.md): Use this endpoint to register incoming funds from external sources into the ledger. You only need to provide the destination accounts—based on the selected asset, the system automatically assigns the appropriate external account as the transaction source, simplifying the inflow process.
- [Create an Operation Route](https://docs.lerian.studio/en/reference/midaz/create-an-operation-route.md): Use this endpoint to create an Operation Route.
- [Create an Organization](https://docs.lerian.studio/en/reference/midaz/create-an-organization.md): Use this endpoint to create an Organization. You can create multiple Organizations, but they must be added one at a time.
- [Create an Outflow Transaction](https://docs.lerian.studio/en/reference/midaz/create-an-outflow-transaction.md): Use this endpoint to initiate an outflow transaction, abstracting the process of moving funds from internal ledger accounts to the external world. <p>Instead of requiring full transaction details, you only need to provide the source accounts. Based on the asset provided, the system automatically inc…
- [Create a Transaction Route](https://docs.lerian.studio/en/reference/midaz/create-transaction-route.md): Use this endpoint to create an Transaction Route.
- [Create an Alias Account](https://docs.lerian.studio/en/reference/midaz/crm/create-alias-account.md): Use this endpoint to create an alias account, a reference to a Midaz Ledger Account tied to a specific business context. Alias Accounts help you manage and abstract account data more efficiently across the system.
- [Create a Holder](https://docs.lerian.studio/en/reference/midaz/crm/create-holder.md): Use this endpoint to create a holder record, representing a person or organization.
- [CRM error list](https://docs.lerian.studio/en/reference/midaz/crm/crm-error-list.md): **CRM** returns consistent and structured error responses. This helps you quickly understand what went wrong and how to fix it.
- [Delete an Alias Account](https://docs.lerian.studio/en/reference/midaz/crm/delete-alias-account.md): Use this endpoint to delete an Account Alias. By default, it performs a soft delete (logical removal). **To permanently delete the record, use the `hard_delete=true` query parameter**.
- [Delete a Holder](https://docs.lerian.studio/en/reference/midaz/crm/delete-holder.md): Use this endpoint to delete a holder. By default, it performs a soft delete (logical removal). **To permanently delete the record, use the `hard_delete=true` query parameter**.
- [Delete a Related Party](https://docs.lerian.studio/en/reference/midaz/crm/delete-related-party.md): Use this endpoint to delete a related party from an Alias Account. This permanently removes the association between the related party and the alias.
- [List Alias Accounts](https://docs.lerian.studio/en/reference/midaz/crm/list-alias-accounts.md): Lists all aliases, with or without filters. This endpoint supports pagination through the `page` and `limit` parameters, and sorting via the `sort` parameter.
- [List Holders](https://docs.lerian.studio/en/reference/midaz/crm/list-holders.md): Use this endpoint to list all holders under your organization, following a paginated listing pattern. Currently, filtering by specific holder attributes is reserved for internal integrations over gRPC.
- [Retrieve Alias Account details](https://docs.lerian.studio/en/reference/midaz/crm/retrieve-alias-account.md): Use this endpoint to retrieve detailed information about a specific Alias Account using its unique identifier.
- [Retrieve a Holder](https://docs.lerian.studio/en/reference/midaz/crm/retrieve-holder.md): Use this endpoint to retrieve the information of a specific Holder.
- [Update an Alias Account](https://docs.lerian.studio/en/reference/midaz/crm/update-alias-account.md): Use this endpoint to update the details of an Alias Account.
- [Update a Holder](https://docs.lerian.studio/en/reference/midaz/crm/update-holder.md): Use this endpoint to update the details of a holder.
- [Delete a Balance](https://docs.lerian.studio/en/reference/midaz/delete-a-balance.md): Use this endpoint to delete a balance.
- [Delete a Ledger](https://docs.lerian.studio/en/reference/midaz/delete-a-ledger.md): Use this endpoint to delete a Ledger. The Ledger will remain in our records and appear in the [List Ledgers](/reference/list-ledgers#/) and [Retrieve a Ledger](/reference/retrieve-a-ledger#/) endpoint responses, with the `deletedAt` field showing the deletion date.
- [Delete a Metadata Index](https://docs.lerian.studio/en/reference/midaz/delete-a-metadata-index.md): Use this endpoint to delete a metadata index by specifying the entity name and the index key. The index will be permanently removed.
- [Delete a Portfolio](https://docs.lerian.studio/en/reference/midaz/delete-a-portfolio.md): Use this endpoint to delete a Portfolio.
- [Delete a Segment](https://docs.lerian.studio/en/reference/midaz/delete-a-segment.md): Use this endpoint to delete a specific Segment.
- [Delete a Transaction Route](https://docs.lerian.studio/en/reference/midaz/delete-a-transaction-route.md): Use this endpoint to delete a specific Transaction Route.
- [Delete an Account](https://docs.lerian.studio/en/reference/midaz/delete-an-account.md): Use this endpoint to delete a specific Account.
- [Delete an Account Type](https://docs.lerian.studio/en/reference/midaz/delete-an-account-type.md): Use this endpoint to delete a specific Account Type.
- [Delete an Asset](https://docs.lerian.studio/en/reference/midaz/delete-an-asset.md): Use this endpoint to delete an Asset.
- [Delete an Operation Route](https://docs.lerian.studio/en/reference/midaz/delete-an-operation-route.md): Use this endpoint to delete a specific Operation Route. **Important:** You cannot delete an operation route that is associated with an active transaction route.
- [Delete an Organization](https://docs.lerian.studio/en/reference/midaz/delete-an-organization.md): Use this endpoint to delete an Organization. The Organization will remain in our records and appear in the [List Organizations](/reference/list-organizations/) and [Retrieve an Organization](/reference/retrieve-an-organization/) endpoint responses, with the deletedAt field showing the deletion date.
- [Midaz error list](https://docs.lerian.studio/en/reference/midaz/error-list.md): Our Midaz APIs return a structured error object for all errors to simplify issue diagnosis.
- [List Account Types](https://docs.lerian.studio/en/reference/midaz/list-account-types.md): Use this endpoint to retrieve the details of all the Account Types you have created.
- [List Accounts](https://docs.lerian.studio/en/reference/midaz/list-accounts.md): Use this endpoint to list all accounts in your Ledger.
- [List Assets](https://docs.lerian.studio/en/reference/midaz/list-assets.md): Use this endpoint to retrieve the details of all Assets in your Ledger.
- [List Balances](https://docs.lerian.studio/en/reference/midaz/list-balances.md): Use this endpoint to list all balances.
- [List Ledgers](https://docs.lerian.studio/en/reference/midaz/list-ledgers.md): Use this endpoint to retrieve the details of all the Ledgers in an Organization.
- [List Metadata Indexes](https://docs.lerian.studio/en/reference/midaz/list-metadata-indexes.md): Use this endpoint to retrieve all metadata indexes. You can optionally filter the results by entity name.
- [List Operation Routes](https://docs.lerian.studio/en/reference/midaz/list-operation-routes.md): Use this endpoint to retrieve the details of all the Operation Routes you have created.
- [List Operations by Account](https://docs.lerian.studio/en/reference/midaz/list-operations-by-account.md): Use this endpoint to retrieve all Operations from a specific Account.
- [List Organizations](https://docs.lerian.studio/en/reference/midaz/list-organizations.md): Use this endpoint to retrieve the details of all the Organizations you have created.
- [List Portfolios](https://docs.lerian.studio/en/reference/midaz/list-portfolios.md): Use this endpoint to retrieve the details of all Portfolios in your Ledger. If the filters in the request do not meet the endpoint's criteria, an empty response will be returned.
- [List Segments](https://docs.lerian.studio/en/reference/midaz/list-segments.md): Use this endpoint to retrieve the details of all Segments in your Ledger.
- [List Transaction Routes](https://docs.lerian.studio/en/reference/midaz/list-transaction-routes.md): Use this endpoint to retrieve the details of all the Transaction Routes you have created.
- [List Transactions](https://docs.lerian.studio/en/reference/midaz/list-transactions.md): Use this endpoint to retrieve the information of all Transactions created.
- [Calculate Billing](https://docs.lerian.studio/en/reference/midaz/plugins/fees-engine/calculate-billing.md): Calculate billing charges for a given period. Evaluates all active billing packages matching the specified type and returns transaction payloads ready for Midaz. All-or-nothing — if any package fails, no results are returned.
- [Calculate Fees for a Package](https://docs.lerian.studio/en/reference/midaz/plugins/fees-engine/calculate-fees.md): Use this endpoint to calculate and retrieve the fees associated with a specific package for a given transaction.
- [Create a Billing Package](https://docs.lerian.studio/en/reference/midaz/plugins/fees-engine/create-billing-package.md): Create a billing package for period-based charges. Supports two types — `volume` (transaction count-based) and `maintenance` (per-account fixed fee).
- [Create a Package](https://docs.lerian.studio/en/reference/midaz/plugins/fees-engine/create-package.md): Use this endpoint to create packages along with their associated fees in a single request.
- [Delete a Billing Package](https://docs.lerian.studio/en/reference/midaz/plugins/fees-engine/delete-billing-package.md): Soft-delete a billing package. Marked with `deletedAt` timestamp and excluded from standard queries.
- [Delete a Package](https://docs.lerian.studio/en/reference/midaz/plugins/fees-engine/delete-package.md): Use this endpoint to delete previously created packages. Once deleted, the package and its associated fees will no longer be available.
- [Fees Engine error list](https://docs.lerian.studio/en/reference/midaz/plugins/fees-engine/fee-engine-error-list.md): The **Fees Engine** returns consistent and structured error responses. This helps you quickly understand what went wrong and how to fix it.
- [List Billing Packages](https://docs.lerian.studio/en/reference/midaz/plugins/fees-engine/list-billing-packages.md): Retrieve all billing packages for the given organization and ledger.
- [List Packages](https://docs.lerian.studio/en/reference/midaz/plugins/fees-engine/list-packages.md): Use this endpoint to retrieve all registered packages along with their associated fees.
- [Retrieve a Billing Package](https://docs.lerian.studio/en/reference/midaz/plugins/fees-engine/retrieve-billing-package.md): Retrieve a specific billing package by its ID.
- [Retrieve a Package](https://docs.lerian.studio/en/reference/midaz/plugins/fees-engine/retrieve-package.md): Use this endpoint to retrieve a specific package and its associated fees.
- [Estimate Transaction Fees](https://docs.lerian.studio/en/reference/midaz/plugins/fees-engine/simulate-fees.md): Use this endpoint to estimate the fees for a transaction. It helps validate expected charges before processing.
- [Update a Billing Package](https://docs.lerian.studio/en/reference/midaz/plugins/fees-engine/update-billing-package.md): Partially update a billing package. Only `label`, `description`, and `enable` can be updated. Send only the fields you want to change.
- [Update a Package](https://docs.lerian.studio/en/reference/midaz/plugins/fees-engine/update-package.md): Use this endpoint to update a specific package. Send only the fields you want to change — any fields not included will remain unchanged. Ideal for partial updates without overwriting the entire configuration.
- [Cancel a Claim](https://docs.lerian.studio/en/reference/midaz/plugins/indirect-pix/cancel-claim.md): Use this endpoint to cancel a portability or ownership claim.
- [Cancel a Fraud Marker](https://docs.lerian.studio/en/reference/midaz/plugins/indirect-pix/cancel-fraud-marker.md): Use this endpoint to cancel a previously registered fraud marker.
- [Cancel an Infraction Report](https://docs.lerian.studio/en/reference/midaz/plugins/indirect-pix/cancel-infraction-report.md): Use this endpoint to cancel an infraction report that is no longer valid. This endpoint is used to cancel infractions reported by your own PSP.
- [Cancel a Refund Request](https://docs.lerian.studio/en/reference/midaz/plugins/indirect-pix/cancel-refund-request.md): Use this endpoint to cancel a refund request before it is processed.
- [Check Keys Existence](https://docs.lerian.studio/en/reference/midaz/plugins/indirect-pix/check-key.md): Use this endpoint to verify if the provided Pix keys exist in the DICT system. This operation allows batch verification of multiple keys in a single request.
- [Close an Infraction Report](https://docs.lerian.studio/en/reference/midaz/plugins/indirect-pix/close-infraction-report.md): Use this endpoint to submit the closure analysis for an infraction report received. This endpoint must be used to respond to infractions reported to your PSP, meaning when the account was the receiver of the transaction reported as fraud, within 7 days with the analysis result.
- [Close a Refund Request](https://docs.lerian.studio/en/reference/midaz/plugins/indirect-pix/close-refund-request.md): Use this endpoint to provide the closure decision and outcome for a refund request.
- [Complete a Claim](https://docs.lerian.studio/en/reference/midaz/plugins/indirect-pix/complete-claim.md): Use this endpoint to complete a claim by the claimer. As a result, the link between the key and the claiming party is created.
- [Confirm a Claim](https://docs.lerian.studio/en/reference/midaz/plugins/indirect-pix/confirm-claim.md): Use this endpoint to confirm a claim operation. As a consequence, the link between the key and the donor participant is removed. Status must be in WAITING_RESOLUTION.
- [Create a Claim](https://docs.lerian.studio/en/reference/midaz/plugins/indirect-pix/create-claim.md): Use this endpoint to create a new key claim for portability or ownership. Not every type of key can be claimed or ported. The table below defines the possibilities:
- [Create an Entry](https://docs.lerian.studio/en/reference/midaz/plugins/indirect-pix/create-entry.md): Use this endpoint to create a new Pix entry associated with an account and its data.
- [Create a Fraud Marker](https://docs.lerian.studio/en/reference/midaz/plugins/indirect-pix/create-fraud-marker.md): Use this endpoint to register a fraud marker for a tax ID or Pix key.
- [Create an Infraction Report](https://docs.lerian.studio/en/reference/midaz/plugins/indirect-pix/create-infraction-report.md): Use this endpoint to report infractions associated to Pix transfers. This endpoint must be used when there is a fraud related to a transaction in scenarios where the client is the payer PSP, meaning the transaction was initiated and sent from an account within your arrangement.
- [Create a Refund Request](https://docs.lerian.studio/en/reference/midaz/plugins/indirect-pix/create-refund-request.md): Use this endpoint to open a refund request for a Pix transaction.
- [Create a Static QR Code](https://docs.lerian.studio/en/reference/midaz/plugins/indirect-pix/create-static-qr-code.md): Use this endpoint to create a static Pix BR Code that can be reused for multiple payments.
- [Refund a Received Pix Transfer](https://docs.lerian.studio/en/reference/midaz/plugins/indirect-pix/create-transfer-refund.md): Use this endpoint to initiate a refund for a previously received Pix transfer. The refund returns funds to the original sender of the transaction.
- [Decode a Pix QR Code](https://docs.lerian.studio/en/reference/midaz/plugins/indirect-pix/decode-qr-code.md): Use this endpoint to decode a Pix BR Code payload and extract the payment data it contains. This service supports all Pix QR Code types: static, immediate collections, and due date collections.
- [Delete an Entry](https://docs.lerian.studio/en/reference/midaz/plugins/indirect-pix/delete-entry.md): Use this endpoint to delete (inactivate) an existing Pix entry associated with an account.
- [Indirect Pix BTG error list](https://docs.lerian.studio/en/reference/midaz/plugins/indirect-pix/indirect-pix-btg-error-list.md): Indirect Pix BTG returns consistent and structured error responses. This helps you quickly understand what went wrong and how to fix it.
- [Initiate a Pix Transfer](https://docs.lerian.studio/en/reference/midaz/plugins/indirect-pix/initiate-transfer.md): Use this endpoint to start a Pix cash-out by creating an initiation record. This endpoint retrieves and validates destination information without moving funds.
- [List Claims](https://docs.lerian.studio/en/reference/midaz/plugins/indirect-pix/list-claims.md): Use this endpoint to list key claims with filters and pagination. Returns empty array [] if no claims match the criteria.
- [List Entries](https://docs.lerian.studio/en/reference/midaz/plugins/indirect-pix/list-entries.md): Use this endpoint to list all Pix entries for an account with optional filters. Returns empty array [] if no entries match the criteria.
- [List Fraud Markers](https://docs.lerian.studio/en/reference/midaz/plugins/indirect-pix/list-fraud-markers.md): Use this endpoint to list fraud markers with filters. Returns empty array [] if no markers match the criteria.
- [List Infraction Reports](https://docs.lerian.studio/en/reference/midaz/plugins/indirect-pix/list-infraction-reports.md): Use this endpoint to list infraction reports with optional filters and pagination.
- [List Refund Requests](https://docs.lerian.studio/en/reference/midaz/plugins/indirect-pix/list-refund-requests.md): Use this endpoint to list refund requests with filters and pagination. Returns empty array [] if no requests match the criteria.
- [List Static QR Codes](https://docs.lerian.studio/en/reference/midaz/plugins/indirect-pix/list-static-qr-codes.md): Use this endpoint to list all static Pix BR Codes for an account with optional filters. Returns empty array [] if no QR codes match the criteria.
- [List Pix Transfers](https://docs.lerian.studio/en/reference/midaz/plugins/indirect-pix/list-transfers.md): Use this endpoint to list Pix Transfers with optional filters and pagination.
- [Process a Pix Transfer](https://docs.lerian.studio/en/reference/midaz/plugins/indirect-pix/process-transfer.md): Use this endpoint to process a previously initiated Pix cash-out and move funds between accounts.
- [Retrieve a Claim](https://docs.lerian.studio/en/reference/midaz/plugins/indirect-pix/retrieve-claim.md): Use this endpoint to retrieve the details of a specific key claim.
- [Retrieve an Entry](https://docs.lerian.studio/en/reference/midaz/plugins/indirect-pix/retrieve-entry.md): Use this endpoint to retrieve a Pix entry by its unique identifier.
- [Retrieve an Infraction Report](https://docs.lerian.studio/en/reference/midaz/plugins/indirect-pix/retrieve-infraction-report.md): Use this endpoint to retrieve the full details of a single infraction report.
- [Retrieve a Key](https://docs.lerian.studio/en/reference/midaz/plugins/indirect-pix/retrieve-key.md): Use this endpoint to retrieve Pix key details for payment purposes. This operation queries the DICT system to get account information associated with a Pix key, enabling you to validate and prepare payment destinations.
- [Retrieve Key Statistics](https://docs.lerian.studio/en/reference/midaz/plugins/indirect-pix/retrieve-key-statistics.md): Use this endpoint to fetch usage and risk statistics for a specific Pix key.
- [Retrieve Person Statistics](https://docs.lerian.studio/en/reference/midaz/plugins/indirect-pix/retrieve-person-statistics.md): Use this endpoint to fetch aggregated Pix statistics for a person identified by their tax ID (CPF or CNPJ).
- [Retrieve a Refund Request](https://docs.lerian.studio/en/reference/midaz/plugins/indirect-pix/retrieve-refund-request.md): Use this endpoint to retrieve the details of a specific refund request.
- [Retrieve a Static QR Code](https://docs.lerian.studio/en/reference/midaz/plugins/indirect-pix/retrieve-static-qr-code.md): Use this endpoint to retrieve detailed information about a specific static Pix BR Code.
- [Retrieve a Pix Transfer](https://docs.lerian.studio/en/reference/midaz/plugins/indirect-pix/retrieve-transfer.md): Use this endpoint to retrieve a Pix transfer by its unique identifier.
- [Update an Entry](https://docs.lerian.studio/en/reference/midaz/plugins/indirect-pix/update-entry.md): Use this endpoint to update an existing Pix entry data associated with an account.
- [Cancel a Transfer](https://docs.lerian.studio/en/reference/midaz/plugins/ted/cancel-transfer.md): Use this endpoint to cancel a transfer that has not yet been submitted for processing. Only transfers in CREATED or PENDING status can be cancelled. Cancelling a transfer releases the held funds in Midaz and sets the status to CANCELLED. Calling cancel on an already-cancelled transfer returns succes…
- [Check service health](https://docs.lerian.studio/en/reference/midaz/plugins/ted/check-health.md): Use this endpoint to check whether the service is alive and responding to requests. This endpoint is designed for Kubernetes liveness probes.
- [Check service readiness](https://docs.lerian.studio/en/reference/midaz/plugins/ted/check-readiness.md): Use this endpoint to check whether the service is ready to accept traffic by verifying all required dependencies (database, cache, MongoDB, and telemetry). This endpoint is designed for Kubernetes readiness probes.
- [Get dashboard summary](https://docs.lerian.studio/en/reference/midaz/plugins/ted/get-dashboard-summary.md): Returns aggregated transfer counters and operational health snapshot for dashboards.
- [Initiate a Transfer](https://docs.lerian.studio/en/reference/midaz/plugins/ted/initiate-transfer.md): Use this endpoint to initiate a transfer by validating sender data, checking operating hours and usage limits, detecting duplicates, and calculating the fee. No funds are held at this step. The returned initiationId is valid for 24 hours and must be confirmed via the Process Transfer endpoint. Use t…
- [List pending reconciliation transfers](https://docs.lerian.studio/en/reference/midaz/plugins/ted/list-pending-reconciliation.md): Lists transfers flagged for manual reconciliation after unknown-state failures.
- [List Transfers](https://docs.lerian.studio/en/reference/midaz/plugins/ted/list-transfers.md): Use this endpoint to retrieve a paginated list of transfers. You can filter by type, status, date range, and amount range. The default limit is 50 items, with a maximum of 200. Only returns transfers belonging to the same organization.
- [Process a Transfer](https://docs.lerian.studio/en/reference/midaz/plugins/ted/process-transfer.md): Use this endpoint to confirm and execute a previously initiated transfer. The system validates the initiationId, checks the sender's balance, holds funds in Midaz, and routes the transfer to JD SPB (for TED OUT) or creates an internal Midaz transaction (for P2P). Submitting the same initiationId ret…
- [Get a Transfer](https://docs.lerian.studio/en/reference/midaz/plugins/ted/retrieve-transfer.md): Use this endpoint to retrieve the current status and details of a transfer, including its type, status history, sender and recipient details, amounts, and timestamps. Only returns transfers belonging to the same organization.
- [Bank Transfer (TED) error list](https://docs.lerian.studio/en/reference/midaz/plugins/ted/ted-error-list.md): **Bank Transfer (TED)** returns consistent and structured error responses. This helps you quickly understand what went wrong and how to fix it.
- [Retrieve a Balance](https://docs.lerian.studio/en/reference/midaz/retrieve-a-balance.md): Use this endpoint to retrieve a specific balance by its identifier.
- [Retrieve a Balance by Account Alias](https://docs.lerian.studio/en/reference/midaz/retrieve-a-balance-by-account-alias.md): Use this endpoint to retrieve a Balance by its Account Alias.
- [Retrieve the Balance of an External Account](https://docs.lerian.studio/en/reference/midaz/retrieve-a-balance-of-an-external-account.md): Use this endpoint to retrieve the Balance of an External Account.
- [Retrieve a Ledger](https://docs.lerian.studio/en/reference/midaz/retrieve-a-ledger.md): Use this endpoint to retrieve the details of a specific Ledger by its identifier. If a ledger has been deleted, the information of the ledger will be displayed, including the date when the deletion occurred in the `deletedAt` field.
- [Retrieve a Portfolio](https://docs.lerian.studio/en/reference/midaz/retrieve-a-portfolio.md): Use this endpoint to retrieve the details of a specific Portfolio by its identifier.
- [Retrieve a Segment](https://docs.lerian.studio/en/reference/midaz/retrieve-a-segment.md): Use this endpoint to retrieve the details of a specific Segment by its identifier.
- [Retrieve a Transaction](https://docs.lerian.studio/en/reference/midaz/retrieve-a-transaction.md): Use this endpoint to retrieve the details of a specific Transaction by its identifier.
- [Retrieve a Transaction Route](https://docs.lerian.studio/en/reference/midaz/retrieve-a-transaction-route.md): Use this endpoint to retrieve the details of a specific Transaction Route by its identifier.
- [Retrieve an Account](https://docs.lerian.studio/en/reference/midaz/retrieve-an-account.md): Use this endpoint to retrieve the details of a specific Account by its identifier.
- [Retrieve an Account by Alias](https://docs.lerian.studio/en/reference/midaz/retrieve-an-account-by-alias.md): Use this endpoint to retrieve the details of a specific Account by its alias.
- [Retrieve an Account Type](https://docs.lerian.studio/en/reference/midaz/retrieve-an-account-type.md): Use this endpoint to retrieve the details of a specific Account Type by its identifier.
- [Retrieve an Asset](https://docs.lerian.studio/en/reference/midaz/retrieve-an-asset.md): Use this endpoint to retrieve the details of a specific Asset by its identifier.
- [Retrieve an External Account](https://docs.lerian.studio/en/reference/midaz/retrieve-an-external-account.md): Use this endpoint to retrieve the details of a specific External Account by its asset code.
- [Retrieve an Operation](https://docs.lerian.studio/en/reference/midaz/retrieve-an-operation-by-account.md): Use this endpoint to retrieve the details of a specific Operation created from an Account by its identifier.
- [Retrieve an Operation Route](https://docs.lerian.studio/en/reference/midaz/retrieve-an-operation-route.md): Use this endpoint to retrieve the details of a specific Operation Route by its identifier.
- [Retrieve an Organization](https://docs.lerian.studio/en/reference/midaz/retrieve-an-organization.md): Use this endpoint to retrieve the details of a specific Organization by its identifier.
- [Retrieve Balance History](https://docs.lerian.studio/en/reference/midaz/retrieve-balance-history.md): Use this endpoint to retrieve the state of a specific balance at a given point in time (point-in-time query).
- [Retrieve Balance History by Account](https://docs.lerian.studio/en/reference/midaz/retrieve-balance-history-by-account.md): Use this endpoint to retrieve the state of all balances for a specific account at a given point in time (point-in-time query).
- [Retrieve Balances by Account](https://docs.lerian.studio/en/reference/midaz/retrieve-balances-by-account.md): Use this endpoint to retrieve all balances from a specific account.
- [Retrieve Ledger Settings](https://docs.lerian.studio/en/reference/midaz/retrieve-ledger-settings.md): Use this endpoint to retrieve the current settings of a specific Ledger. Settings control validation behavior for transactions processed within the Ledger.
- [Revert a Transaction](https://docs.lerian.studio/en/reference/midaz/revert-a-transaction.md): Use this endpoint to reverse an existing transaction by automatically generating a new one in the opposite direction of the original. The new transaction is linked to the original using the `parentTransactionId` field, ensuring full traceability between both operations.
- [Update a Balance](https://docs.lerian.studio/en/reference/midaz/update-a-balance.md): Use this endpoint to update the information of an existing balance.
- [Update a Ledger](https://docs.lerian.studio/en/reference/midaz/update-a-ledger.md): Use this endpoint to update the details of a Ledger.
- [Update a Portfolio](https://docs.lerian.studio/en/reference/midaz/update-a-portfolio.md): Use this endpoint to update the details of a Portfolio.
- [Update a Segment](https://docs.lerian.studio/en/reference/midaz/update-a-segment.md): Use this endpoint to update the details of a Segment.
- [Update a Transaction](https://docs.lerian.studio/en/reference/midaz/update-a-transaction.md): Use this endpoint to update the details of a Transaction.
- [Update a Transaction Route](https://docs.lerian.studio/en/reference/midaz/update-a-transaction-route.md): Use this endpoint to update the details of a Transaction Route.
- [Update an Account](https://docs.lerian.studio/en/reference/midaz/update-an-account.md): Use this endpoint to update the details of an Account.
- [Update an Account Type](https://docs.lerian.studio/en/reference/midaz/update-an-account-type.md): Use this endpoint to update the details of an Account Type.
- [Update an Asset](https://docs.lerian.studio/en/reference/midaz/update-an-asset.md): Use this endpoint to update the details of an Asset.
- [Update an Operation](https://docs.lerian.studio/en/reference/midaz/update-an-operation.md): Use this endpoint to update the details of an Operation.
- [Update an Operation Route](https://docs.lerian.studio/en/reference/midaz/update-an-operation-route.md): Use this endpoint to update the details of an Operation Route.
- [Update an Organization](https://docs.lerian.studio/en/reference/midaz/update-an-organization.md): Use this endpoint to update the details of an Organization.
- [Update Ledger Settings](https://docs.lerian.studio/en/reference/midaz/update-ledger-settings.md): Use this endpoint to partially update the settings of a specific Ledger. Uses deep merge — only the fields you include in the request body are changed.
- [Pagination](https://docs.lerian.studio/en/reference/pagination.md)
- [Postman integration](https://docs.lerian.studio/en/reference/postman-integration.md)
- [Quick start guide](https://docs.lerian.studio/en/reference/quick-start-guide.md)
- [Retrieve a Report](https://docs.lerian.studio/en/reference/reporter/check-report-status.md): Use this endpoint to retrieve the current status of a specific report.
- [Create a connection](https://docs.lerian.studio/en/reference/reporter/connections/create-connection.md): Use this endpoint to create a new database connection for the organization. The `configName` must be unique per organization. The password is encrypted upon creation and a UUID is automatically generated as the connection identifier.
- [Delete a connection](https://docs.lerian.studio/en/reference/reporter/connections/delete-connection.md): Use this endpoint to soft delete a connection. The deletion will fail with `409 Conflict` if there are any active jobs running for this connection.
- [List connections](https://docs.lerian.studio/en/reference/reporter/connections/list-connections.md): Use this endpoint to list all database connections configured for your organization. You can apply filters, pagination, and sorting to narrow down results and find specific connections based on your criteria.
- [Retrieve a connection](https://docs.lerian.studio/en/reference/reporter/connections/retrieve-connection.md): Use this endpoint to retrieve the details of a specific connection by its unique identifier.
- [Test a connection](https://docs.lerian.studio/en/reference/reporter/connections/test-connection.md): Use this endpoint to test the configured connection by establishing and closing a connection to the database. Returns the connection status, latency, and database name.
- [Update a connection](https://docs.lerian.studio/en/reference/reporter/connections/update-connection.md): Use this endpoint to apply a partial update to a connection. Returns `409 Conflict` if there is any active job using this connection.
- [Validate schema](https://docs.lerian.studio/en/reference/reporter/connections/validate-schema.md): Use this endpoint to validate that tables and fields referenced in the request exist in the configured data sources. This is useful for verifying schema mappings before creating data extraction jobs.
- [Create a Report](https://docs.lerian.studio/en/reference/reporter/create-report.md): Use this endpoint to generate reports asynchronously using pre-registered templates. You can apply custom filters to define specific criteria by domain, like account IDs in onboarding.
- [Delete a Template](https://docs.lerian.studio/en/reference/reporter/delete-template.md): Use this endpoint to soft delete a template from the system. The record won't be physically removed from the database. Instead, the data stays stored but is marked inactive and excluded from standard queries. The `deletedAt` field is set with the timestamp when the deletion occurred.
- [Download a Report](https://docs.lerian.studio/en/reference/reporter/download-report.md): Use this endpoint to download a previously generated report (HTML, XML, CSV or TXT) that has finished processing (`status=Finished`).
- [List Data Sources](https://docs.lerian.studio/en/reference/reporter/list-data-sources.md): Use this endpoint to retrieve a complete list of data sources connected to the plugin, including all information stored in the database.
- [List Templates](https://docs.lerian.studio/en/reference/reporter/list-templates.md): Use this endpoint to list all templates available in the system. You can apply filters, pagination, and sorting to narrow down results and find specific templates based on your criteria.
- [Reporter API quick start](https://docs.lerian.studio/en/reference/reporter/reporter-developer-quick-start.md)
- [Reporter error list](https://docs.lerian.studio/en/reference/reporter/reporter-error-list.md): Reporter returns consistent and structured error responses. This helps you quickly understand what went wrong and how to fix it.
- [Retrieve a Data Source by id](https://docs.lerian.studio/en/reference/reporter/retrieve-data-source.md): Use this endpoint to retrieve the schema structure of a specific data source, including tables and fields, to support dynamic filter creation during report generation.
- [Retrieve Reports](https://docs.lerian.studio/en/reference/reporter/retrieve-reports.md): Use this endpoint to retrieve reports that have been created before.
- [Retrieve Template details](https://docs.lerian.studio/en/reference/reporter/retrieve-template-details.md): Use this endpoint to retrieve the information of a specific template.
- [Update a Template](https://docs.lerian.studio/en/reference/reporter/update-templates.md): Use this endpoint to update the template file and its metadata. When the request is sent as `multipart/form-data`, you can replace the `.tpl` file and update the `description` and `outputFormat` fields.
- [Upload a Template](https://docs.lerian.studio/en/reference/reporter/upload-template.md): Use this endpoint to upload a new template to the system. It accepts a `.tpl` file that defines the structure and logic of the report.      The file must be formatted according to the desired output type — HTML, XML, CSV, PDF, or TXT — using [Reporter](/en/reporter) plugin blocks where applicable.…
- [Retries and idempotency](https://docs.lerian.studio/en/reference/retries-idempotency.md)
- [Reliability and support](https://docs.lerian.studio/en/reference/stability-quality.md)
- [Testing and quality assurance](https://docs.lerian.studio/en/reference/testing-quality-assurance.md)
- [Tolerant reader](https://docs.lerian.studio/en/reference/tolerant-reader.md)
- [Activate a Limit](https://docs.lerian.studio/en/reference/tracer/activate-limit.md): Use this endpoint to activate a spending limit. Activates the limit for enforcement in validations.
- [Activate a Rule](https://docs.lerian.studio/en/reference/tracer/activate-rule.md): Use this endpoint to activate a rule. Activates the rule for evaluation in validations. Valid transitions are DRAFT to ACTIVE and INACTIVE to ACTIVE.
- [Health check (liveness probe)](https://docs.lerian.studio/en/reference/tracer/check-health.md): Check if the service is alive. Returns plain text "healthy". This endpoint does not require authentication and is designed for Kubernetes liveness probes.
- [Readiness check](https://docs.lerian.studio/en/reference/tracer/check-readiness.md): Check if the service is ready to accept traffic by verifying all dependencies (database connection). This endpoint does not require authentication and is designed for Kubernetes readiness probes.
- [Get service version](https://docs.lerian.studio/en/reference/tracer/check-version.md): Returns the current version of the service. This endpoint does not require authentication.
- [Create a Limit](https://docs.lerian.studio/en/reference/tracer/create-limit.md): Use this endpoint to create a spending limit with scopes array. Limits are created in DRAFT status. Use the activate endpoint to start enforcement. After creation, limitType and currency cannot be changed.
- [Create a Rule](https://docs.lerian.studio/en/reference/tracer/create-rule.md): Use this endpoint to create a validation rule with a CEL expression and scopes array. Rules are always created in DRAFT status. Use the activate endpoint to start evaluation.
- [Deactivate a Limit](https://docs.lerian.studio/en/reference/tracer/deactivate-limit.md): Use this endpoint to deactivate a spending limit. Pauses the limit from being enforced in validations.
- [Deactivate a Rule](https://docs.lerian.studio/en/reference/tracer/deactivate-rule.md): Use this endpoint to deactivate a rule. Pauses the rule from being evaluated in validations. Valid transitions are ACTIVE to INACTIVE and DRAFT to INACTIVE.
- [Delete a Limit](https://docs.lerian.studio/en/reference/tracer/delete-limit.md): Use this endpoint to soft-delete a spending limit. Only DRAFT and INACTIVE limits can be deleted. ACTIVE limits must be deactivated first. The limit is preserved in the audit trail.
- [Delete a Rule](https://docs.lerian.studio/en/reference/tracer/delete-rule.md): Use this endpoint to soft-delete a rule. Only DRAFT and INACTIVE rules can be deleted. ACTIVE rules must be deactivated first. The rule is preserved in the audit trail.
- [List Audit Events](https://docs.lerian.studio/en/reference/tracer/list-audit-events.md): Use this endpoint to list audit events with filters and cursor-based pagination. Designed for SOX/GLBA compliance reporting.
- [List Limits](https://docs.lerian.studio/en/reference/tracer/list-limits.md): Use this endpoint to list spending limits with cursor-based pagination and optional filters. DELETED limits are not returned in listings.
- [List Rules](https://docs.lerian.studio/en/reference/tracer/list-rules.md): Use this endpoint to list validation rules with cursor-based pagination and optional filters. DELETED rules are not returned in listings.
- [List Transaction Validations](https://docs.lerian.studio/en/reference/tracer/list-validations.md): Use this endpoint to list transaction validation records with cursor-based pagination and filters. Useful for compliance reporting and trend analysis.
- [Retrieve an Audit Event](https://docs.lerian.studio/en/reference/tracer/retrieve-audit-event.md): Use this endpoint to retrieve a single audit event by its unique identifier. Designed for SOX/GLBA compliance.
- [Retrieve a Limit](https://docs.lerian.studio/en/reference/tracer/retrieve-limit.md): Use this endpoint to retrieve a spending limit by its unique identifier.
- [Retrieve Limit Usage](https://docs.lerian.studio/en/reference/tracer/retrieve-limit-usage.md): Use this endpoint to retrieve the current usage snapshot for a spending limit.
- [Retrieve a Rule](https://docs.lerian.studio/en/reference/tracer/retrieve-rule.md): Use this endpoint to retrieve a rule by its unique identifier.
- [Retrieve a Transaction Validation](https://docs.lerian.studio/en/reference/tracer/retrieve-validation.md): Use this endpoint to retrieve a transaction validation record by its unique identifier. Useful for auditing and debugging validation decisions.
- [Tracer API quick start](https://docs.lerian.studio/en/reference/tracer/tracer-api-quick-start.md)
- [Tracer error list](https://docs.lerian.studio/en/reference/tracer/tracer-error-list.md): Tracer APIs return a structured error object for all errors to simplify issue diagnosis.
- [Update a Limit](https://docs.lerian.studio/en/reference/tracer/update-limit.md): Use this endpoint to partially update a spending limit. Only provided fields are updated. limitType and currency are immutable and cannot be changed.
- [Update a Rule](https://docs.lerian.studio/en/reference/tracer/update-rule.md): Use this endpoint to partially update a rule. Only provided fields are updated. Expression can only be modified when rule is in DRAFT status.
- [Validate a Transaction](https://docs.lerian.studio/en/reference/tracer/validate-transaction.md): Use this endpoint to validate a transaction against configured rules and limits in real-time. Returns a decision (ALLOW, DENY, or REVIEW) along with details about which rules matched and limit usage. Performance target is under 80ms (p99).
- [Verify Audit Event Hash Chain](https://docs.lerian.studio/en/reference/tracer/verify-audit-event.md): Use this endpoint to verify the integrity of the audit event hash chain up to a specific event. Detects tampering attempts. Designed for SOX/GLBA compliance.
- [Troubleshooting and support](https://docs.lerian.studio/en/reference/troubleshooting-support.md): Midaz is a mission-critical service, and we are committed to keeping it up-to-date and bug-free. Our mission, along with the community, is to open the doors for improvements and swiftly address bugs.
- [Using our Sandbox](https://docs.lerian.studio/en/reference/using-our-sandbox.md)
- [Using the Try It feature](https://docs.lerian.studio/en/reference/using-try-it.md)
- [CADOC 4010 and 4016](https://docs.lerian.studio/en/reporter/cadoc-4010-and-4016.md): Generate CADOC 4010 and 4016 XML reports for BACEN with Reporter, following the COSIF standard and required regulatory layout.
- [CADOC 4111](https://docs.lerian.studio/en/reporter/cadoc-4111.md): Generate the CADOC 4111 XML report for BACEN with Reporter — daily account balances grouped by COSIF code, in the required regulatory layout.
- [CCS Reports](https://docs.lerian.studio/en/reporter/ccs-reports.md): Build CCS XML files (ACCS001, ACCS005, ACCS010) for BACEN by combining Lerian CRM and Midaz data through Reporter templates.
- [Trial Balance Report with Midaz and Reporter](https://docs.lerian.studio/en/reporter/creating-trial-balance-report.md): Produce a trial balance from your Midaz Ledger using Reporter and export it as XML, TXT, HTML, or PDF — no extra conversion tools needed.
- [BACEN regulatory formats](https://docs.lerian.studio/en/reporter/reporter-bacen-templates.md): Build BACEN-compliant regulatory reports — CADOC and CCS layouts — from Reporter templates that match official validation rules.
- [HTML template](https://docs.lerian.studio/en/reporter/reporter-html-template.md): Build an analytical financial report in HTML with Reporter — organization details, per-account breakdowns, and detailed operations lists.
- [Getting started with Reporter](https://docs.lerian.studio/en/reporter/reporter-quick-start.md): Walk through the four-stage reporting lifecycle in Reporter — from designing a template to downloading a finished regulatory or business report.
- [TXT template](https://docs.lerian.studio/en/reporter/reporter-txt-template.md): Build a transaction receipt template in plain text with Reporter — a simple .tpl file that renders into a printable TXT proof of payment.
- [XML template](https://docs.lerian.studio/en/reporter/reporter-xml-template.md): Build an analytical financial report in XML with Reporter — account-level activity, custom logic like discounts, and per-account summaries.
- [Template formats](https://docs.lerian.studio/en/reporter/template-examples.md): Design Reporter templates for HTML, XML, CSV, PDF, or TXT outputs — practical examples to start building reports that fit your use case.
- [Template reference](https://docs.lerian.studio/en/reporter/template-reference.md): Reference every template tag, filter, and operator available in Reporter — loops, conditionals, placeholders, and built-in formatting helpers.
- [Using Reporter](https://docs.lerian.studio/en/reporter/using-reporter.md): Generate dynamic, data-driven reports from your Midaz Ledger with Reporter — no SQL needed, just templates with simple placeholders.
- [Reporter in Lerian Console](https://docs.lerian.studio/en/reporter/using-reporter-in-lerian-console.md): Manage templates, generate reports, and download results in Reporter through the Lerian Console — no API calls or local tooling required.
- [What is Reporter?](https://docs.lerian.studio/en/reporter/what-is-reporter.md): Automate regulatory and business reporting from your financial data with Reporter — produce CSV, XML, HTML, TXT, or PDF outputs from `.tpl` templates.
- [Audit and compliance](https://docs.lerian.studio/en/tracer/audit-compliance.md): How Tracer maintains audit trails for SOX/GLBA compliance and how to query validation history.
- [Getting started with Tracer](https://docs.lerian.studio/en/tracer/getting-started.md): Quickstart guide to set up and use Tracer, Lerian's real-time transaction validation and spending control platform.
- [Integration guide](https://docs.lerian.studio/en/tracer/integration-guide.md): How to integrate your authorization system with Tracer for real-time transaction validation.
- [Rules engine](https://docs.lerian.studio/en/tracer/rule-engine.md): Guide to using the Tracer rules engine to build dynamic, expression-based validation logic.
- [Spending limits](https://docs.lerian.studio/en/tracer/spending-limits.md): Guide to configuring and managing spending limits in Tracer for transaction control and customer protection.
- [Tracer in Lerian Console](https://docs.lerian.studio/en/tracer/using-tracer-in-lerian-console.md): Manage validation rules, spending limits, and transaction policies in Tracer through the Lerian Console — all from a single interface.
- [What is Tracer?](https://docs.lerian.studio/en/tracer/what-is-tracer.md): Validate transactions in real time with Tracer — enforce spending limits, detect unauthorized activity, and decide allow/deny under 100ms.
- [Welcome to Updates & Versioning](https://docs.lerian.studio/en/updates-and-versioning/about-updates-version.md): Stay up-to-date with everything happening in Lerian’s ecosystem.
- [Our release cycle](https://docs.lerian.studio/en/updates-and-versioning/release-cycle.md): Understand Lerian's 13-week release cycle — planning, development, testing, and release stages — so teams can predict what to expect.
- [2025 release schedule](https://docs.lerian.studio/en/updates-and-versioning/release-cycle-2025.md): Track Lerian's 2025 release cycles with the planned start and end dates for each stage so you can align your delivery and rollouts.
- [2026 release schedule](https://docs.lerian.studio/en/updates-and-versioning/release-cycle-2026.md): Plan ahead with Lerian's 2026 release cycles, including the planned start and end dates for each stage and the new cycle structure.
- [Our release schedule](https://docs.lerian.studio/en/updates-and-versioning/release-schedule.md): Track Lerian's release schedules organized by year, with planned cycles and the start and end dates of every stage.
- [Versioning automation](https://docs.lerian.studio/en/updates-and-versioning/versioning-automation.md): Discover how Lerian automates semantic versioning — analyzing commits, applying rules, and publishing new versions without manual steps.
- [Backward compatibility commitment](https://docs.lerian.studio/en/updates-and-versioning/versioning-backward-compatibility.md): Understand Lerian's backward compatibility commitment — defined support windows that let you adopt upgrades without unexpected disruptions.
- [Breaking changes](https://docs.lerian.studio/en/updates-and-versioning/versioning-breaking-change.md): Learn how Lerian handles breaking changes — only in major versions, announced in advance, with deprecation warnings and migration guides.
- [Communication of changes](https://docs.lerian.studio/en/updates-and-versioning/versioning-communication.md): Learn how Lerian communicates every change — release notes, doc updates, and pre-release announcements — so teams can prepare and adapt.
- [Versioning of dependencies](https://docs.lerian.studio/en/updates-and-versioning/versioning-dependencies.md): Understand how Midaz versions internal and external dependencies to keep them stable and compatible across major version lifecycles.
- [Transparency in versioning](https://docs.lerian.studio/en/updates-and-versioning/versioning-governance.md): Understand Lerian's versioning governance — how changes are communicated, dependencies are managed, and stability is protected long-term.
- [Pre-release designations](https://docs.lerian.studio/en/updates-and-versioning/versioning-pre-releases.md): Reference the alpha, beta, and release candidate designations Lerian uses for pre-release builds and how to interpret them.
- [Versioning in practice](https://docs.lerian.studio/en/updates-and-versioning/versioning-process.md): Explore how Lerian's versioning works in practice — automation, support timelines, and what to expect when moving between versions.
- [Version numbering explained](https://docs.lerian.studio/en/updates-and-versioning/versioning-scheme.md): Understand Lerian's modified semantic versioning — major, minor, patch, and pre-release tags — so you can anticipate the impact of each update.
- [Version support timeline](https://docs.lerian.studio/en/updates-and-versioning/versioning-support-time.md): Review Midaz's support policy — active support, security-only support, and end-of-life — so you know what to expect from each version.
- [Upgrade path recommendations](https://docs.lerian.studio/en/updates-and-versioning/versioning-upgrade-path.md): Plan Midaz upgrades with clear recommendations for minor and major version changes, including upgrade guides for every major release.
- [Our versioning strategy](https://docs.lerian.studio/en/updates-and-versioning/versions.md): Understand Lerian's versioning strategy — increments, pre-release tags, automation, upgrade paths, and how changes are communicated.
- [Welcome to our guides](https://docs.lerian.studio/en/welcome-to-our-guides.md): Navigate Lerian's product guides — practical walkthroughs that turn complex financial infrastructure into real-world solutions.
- [Who we are](https://docs.lerian.studio/en/who-we-are.md): Learn about Lerian's mission, identity, and the principles that guide our approach to modern financial infrastructure.
- [Why Lerian](https://docs.lerian.studio/en/why-lerian.md): Understand how Lerian helps financial institutions modernize core banking — without vendor lock-in.

## OpenAPI Specs

- [matcher](https://docs.lerian.studio/pt/openapi/v3-current/matcher.yaml)
- [ledger](https://docs.lerian.studio/pt/openapi/v3-current/ledger.yaml)
- [flowker](https://docs.lerian.studio/pt/openapi/v3-current/flowker.yaml)
- [CRM](https://docs.lerian.studio/pt/openapi/v3-current/CRM.yaml)
- [connections](https://docs.lerian.studio/pt/openapi/v3-current/connections.yaml)
- [fees-engine](https://docs.lerian.studio/pt/openapi/v3-current/fees-engine.yaml)
- [ted](https://docs.lerian.studio/pt/openapi/v3-current/ted.yaml)
- [AM-identity](https://docs.lerian.studio/pt/openapi/v3-current/AM-identity.yaml)
- [AM-auth](https://docs.lerian.studio/pt/openapi/v3-current/AM-auth.yaml)
- [reporter](https://docs.lerian.studio/es/openapi/v3-current/reporter.yaml)
- [pix](https://docs.lerian.studio/pt/openapi/v3-current/pix.yaml)
- [indirect-pix](https://docs.lerian.studio/pt/openapi/v3-current/indirect-pix.yaml)
- [tracer](https://docs.lerian.studio/pt/openapi/v3-current/tracer.yaml)
- [openapi](https://docs.lerian.studio/api-reference/openapi.json)