30 de março de 2026 Atualização de documentação Ação necessáriaDocumentation Index
Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt
Use this file to discover all available pages before exploring further.
Afeta
Times usando APIs Midaz afetadas ou planejando mudanças de integração para o Ciclo 6. Esta atualização se aplica ao portal de documentação pública. Não altera o comportamento da API em runtime, a menos que a documentação do produto vinculada indique o contrário.
O que mudou
A documentação da API do Midaz foi atualizada para refletir todas as mudanças entregues no Ciclo 6. Isso inclui novos endpoints, schemas atualizados, filtros de query adicionais e novos códigos de erro — todos localizados em inglês, português e espanhol.
Novos endpoints
Ledger Settings
Dois novos endpoints permitem gerenciar regras de validação por Ledger via API:- Retrieve Ledger Settings —
GET /organizations/{id}/ledgers/{id}/settings - Update Ledger Settings —
PATCH /organizations/{id}/ledgers/{id}/settings
Balance History
Dois novos endpoints suportam consultas de saldo point-in-time para auditoria, reconciliação e relatórios históricos:- Retrieve Balance History — Obtém o estado de um saldo específico em um determinado timestamp.
- Retrieve Balance History by Account — Obtém o estado de todos os saldos de uma conta em um determinado timestamp.
Schemas atualizados
Transaction Routing
- Operation Routes agora incluem
accountingEntriese suportam um tipo de rotabidirectional - Transaction Routes usam um novo formato de objeto
operationRoutes - Operations incluem novos campos:
direction,routeIderouteCode
Novos filtros de query
| Endpoint | Novos filtros |
|---|---|
| List Organizations | legal_name, doing_business_as |
| List Ledgers | name |
| List Operations | direction, route_id |
Novos códigos de erro
Os códigos de erro 0140–0158 foram adicionados à referência de erros, cobrindo falhas de validação para as novas funcionalidades de Ledger Settings e routing.
Alinhamento da spec OpenAPI
Todas as specs OpenAPI publicadas foram alinhadas com as versões reais do codebase:
| Spec | Atualizada para |
|---|---|
| Ledger | v3.5.0 |
| CRM | latest stable |
| Fees Engine | latest stable |
| Access Manager | latest stable |
Impacto
Esta atualização de documentação inclui informações que os times devem revisar antes de alterar a integração ou deploy afetados.