> ## Documentation Index
> Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt
> Use this file to discover all available pages before exploring further.

# Atualizações da API do Midaz no Ciclo 6

> Novos endpoints do Midaz no Ciclo 6 para Ledger Settings, Balance History e Transaction Routes bidirecionais, com códigos de erro atualizados e alinhamento OpenAPI.

<Badge stroke icon="calendar-days" iconType="regular">30 de março de 2026</Badge> <Badge stroke icon="file-code" iconType="regular">Atualização de documentação</Badge> <Badge color="red" size="lg" stroke icon="triangle-exclamation" iconType="regular">Ação necessária</Badge>

## 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**](/pt/reference/midaz/retrieve-ledger-settings) — `GET /organizations/{id}/ledgers/{id}/settings`
* [**Update Ledger Settings**](/pt/reference/midaz/update-ledger-settings) — `PATCH /organizations/{id}/ledgers/{id}/settings`

Esses endpoints controlam se a validação de **Account Type** e a validação de **Route** são aplicadas para um Ledger específico.

### Balance History

Dois novos endpoints suportam **consultas de saldo point-in-time** para auditoria, reconciliação e relatórios históricos:

* [**Retrieve Balance History**](/pt/reference/midaz/retrieve-balance-history) — Obtém o estado de um saldo específico em um determinado timestamp.
* [**Retrieve Balance History by Account**](/pt/reference/midaz/retrieve-balance-history-by-account) — Obtém o estado de todos os saldos de uma conta em um determinado timestamp.

<Warning>
  O parâmetro `date` é obrigatório e deve seguir o formato `yyyy-mm-dd hh:mm:ss`. Se não houver dados de saldo para o timestamp especificado, um erro `404` é retornado.
</Warning>

### Schemas atualizados

***

### Transaction Routing

* **Operation Routes** agora incluem `accountingEntries` e suportam um tipo de rota `bidirectional`
* **Transaction Routes** usam um novo formato de objeto `operationRoutes`
* **Operations** incluem novos campos: `direction`, `routeId` e `routeCode`

O guia [Transaction Routing](/pt/midaz/transaction-routing-entities) foi atualizado para refletir a nova estrutura e comportamento.

### 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](/pt/reference/midaz/error-list), 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.

## O que você precisa fazer

***

<Steps>
  <Step>
    Revise a documentação de Ledger Settings, Balance History, Transaction Routing, filtros e erros antes da sua próxima mudança de integração com Midaz.
  </Step>
</Steps>

### Prazo

Antes da sua próxima mudança relacionada de integração, deploy ou upgrade.

### Por quê

A documentação pública foi atualizada para refletir o comportamento da API e a cobertura de endpoints do Ciclo 6.