> ## 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ção da documentação #3: fim do ciclo de release

> Atualização de fim de ciclo: novo layout dos Guias e da Referência da API, lançamento do Partners Hub, tipos de conta, roteamento de transações, transações em duas fases e sandbox.

28 de julho de 2025Atualizado

Fechamos o último ciclo de release com uma grande rodada de atualizações na documentação da Lerian. Com regras de roteamento flexíveis, workflows de plugin mais inteligentes e uma estrutura de site mais intuitiva, esta versão facilita construir, testar e crescer.

## Nova estrutura, navegação mais clara

***

Reestruturamos os [**Guias**](https://docs.lerian.studio/pt/start-here/welcome-to-our-guides.md) e a [**Referência da API**](https://docs.lerian.studio/pt/reference/introduction.md) para deixar a navegação mais rápida e mais intuitiva.

O novo layout separa conceitos centrais, plugins e SDKs, para você focar no que precisa, dos primeiros passos à implementação avançada.

## Partners Hub

***

Também lançamos o [**Partners Hub**](https://docs.lerian.studio/pt/platform/platform-introduction.md), um espaço centralizado para nossos parceiros de desenvolvimento. Ele reúne padrões técnicos, regras de documentação e boas práticas para ajudar seus plugins a se integrar ao ecossistema Midaz.

## Melhorias gerais

***

### Midaz Core

* Os campos `amount` e `scale` foram substituídos por um campo único `value` do tipo `string` (que deve conter um valor numérico).
* Os campos `chartOfAccountsGroup` e `chartOfAccounts` foram descontinuados.
* O campo type na **Accounts API** agora é condicional:
* Quando o recurso de tipos de conta está **desabilitado**, type é opcional e aceita qualquer string em formato livre.
* Quando **habilitado**, type passa a ser **obrigatório** e deve corresponder a um dos valores registrados na Account Types API.

### Limpeza de headers de requisição

O header `X-Lerian-Id` foi removido dos endpoints de plugin para simplificar a integração.

### Nova flag pending

Agora você pode definir a flag pending no payload de [Criar uma transação usando JSON](https://docs.lerian.studio/pt/reference/products/midaz/v1/create-transaction-json.md), que oferece suporte a fluxos em duas fases com os endpoints commit/cancel.

## Sandbox agora está disponível

Todas as APIs do Midaz e dos plugins agora oferecem suporte ao **Try It** na documentação.

* Também publicamos um [guia do sandbox](https://docs.lerian.studio/pt/start-here/evaluate-and-deploy/using-our-sandbox.md) para ajudar você a testar com segurança e rapidez.

| APIs | URLs do sandbox |
| :- | :- |
| **Midaz - Onboarding** | [https://onboarding.sandbox.lerian.net](https://onboarding.sandbox.lerian.net/) |
| **Midaz - Transaction** | [https://transaction.sandbox.lerian.net](https://transaction.sandbox.lerian.net/) |
| **Access Manager - Authentication** | [https://auth.sandbox.lerian.net](https://auth.sandbox.lerian.net/) |
| **Access Manager - Identity** | [https://identity.sandbox.lerian.net](https://identity.sandbox.lerian.net/) |
| **CRM** | [https://crm.sandbox.lerian.net](https://crm.sandbox.lerian.net/) |
| **Fee Engine** | [https://fees.sandbox.lerian.net](https://fees.sandbox.lerian.net/) |
| **Smart Templates** | [https://smart-templates.sandbox.lerian.net](https://smart-templates.sandbox.lerian.net/) |

## Guias novos e atualizados

***

### Conceitos centrais

Adicionamos novos guias conceituais e de implementação para acompanhar o lançamento de dois novos recursos centrais:

* **Tipos de conta** – defina e gerencie categorias de conta personalizadas (por exemplo, ativo, passivo, receita) usadas em toda a sua organização. Agora são referenciadas na criação de contas.
* **Roteamento de transações** – roteie transações e operações automaticamente com base no tipo e nos metadados, sem precisar fixar aliases ou IDs de conta no código.

Essas atualizações ajudam os times a construir uma lógica financeira mais limpa e escalável entre ledgers.

#### Nova página

* [Entidades de roteamento de transações](https://docs.lerian.studio/pt/products/midaz/transaction-routing-entities.md) – nova página sobre como usar rotas de transação e rotas de operação.

#### Páginas atualizadas

* [Sobre o Midaz](https://docs.lerian.studio/pt/products/midaz/about-midaz.md)
* [Modelo de dados](https://docs.lerian.studio/pt/products/midaz/data-model.md)
* [Entidades centrais](https://docs.lerian.studio/pt/products/midaz/core-entities.md)
* [Contas](https://docs.lerian.studio/pt/products/midaz/accounts.md)
* [Transações](https://docs.lerian.studio/pt/products/midaz/transactions.md)
* [Operações](https://docs.lerian.studio/pt/products/midaz/operations.md)

### Guias de UI dos plugins

Adicionamos orientações práticas para usar os plugins direto do Midaz Console:

* [**Usando o Access Manager com o Midaz Console**](https://docs.lerian.studio/pt/platform/access-manager/using-access-manager-with-midaz-console.md) – gerencie usuários e aplicações com um modelo RBAC centralizado.
* [**Usando o CRM com o Midaz Console**](https://docs.lerian.studio/pt/products/midaz/crm/using-crm-with-midaz-console.md) – crie e atualize Holders e Account Aliases pela UI.
* [**Usando o Fee Engine com o Midaz Console**](https://docs.lerian.studio/pt/products/midaz/fees/using-fee-engine-with-midaz-console.md) – interface visual para criar pacotes e regras.
* [**Usando o Reporter com o Midaz Console**](https://docs.lerian.studio/pt/products/reporter/using-reporter-in-lerian-console.md) – suba arquivos .tpl, filtre dados e gere relatórios.

### Atualizações na referência

* [**Novas tentativas e idempotência**](https://docs.lerian.studio/pt/reference/retries-idempotency.md) – ampliado com exemplos e estratégias.
* [**FAQ**](https://docs.lerian.studio/pt/products/midaz/faq.md) – agora cobre dúvidas comuns sobre idempotência e novas tentativas após erro.
* [**Observabilidade no Midaz**](https://docs.lerian.studio/pt/products/midaz/observability-in-midaz.md) – atualizado com a nova stack de telemetria e o fluxo baseado em OpenTelemetry.

### Licença da Lerian

* [**Página de licença da Lerian**](https://docs.lerian.studio/pt/start-here/evaluate-and-deploy/lerians-license.md) – uma nova página com os termos de licença da Lerian está no ar na Referência.

### Midaz Console

* **Novos rótulos de botões** – atualizamos a terminologia do Console para editar Organizações, Ledgers, Ativos, Segmentos, Portfólios e Contas.

## APIs novas e atualizadas

***

Novas APIs e endpoints ampliados facilitam automatizar a lógica contábil, controlar o fluxo das transações e gerar relatórios dinâmicos.

## Portas de rede padrão

***

Adicionamos uma nova página com as portas padrão usadas pelo Midaz e por seus plugins: [**Portas de rede padrão**](https://docs.lerian.studio/pt/reference/default-network-ports.md).

Se você faz deploy em um ambiente self-hosted, este guia ajuda a garantir que sua infraestrutura esteja configurada corretamente.

### Domínio de Transações

Introduzimos um novo recurso, o roteamento de transações. Essas APIs permitem embutir a lógica contábil diretamente nos seus fluxos financeiros e automatizar como as operações são classificadas e registradas.

* [**Transaction Routes API**](https://docs.lerian.studio/pt/reference/products/midaz/v2/create-transaction-route.md) – defina como transações inteiras devem ser roteadas com base no tipo. Isso permite mapear dinamicamente os fluxos de transação para o seu plano de contas.
* [**Operation Routes API**](https://docs.lerian.studio/pt/reference/products/midaz/v2/create-operation-route.md) – defina regras de como operações individuais de débito e crédito são roteadas para tipos de conta específicos, o que reduz a necessidade de fixar contas no código das transações.

Essas ferramentas ajudam você a ter mais automação, auditabilidade e alinhamento com a estrutura contábil da sua organização.

### Domínio de Onboarding – Tipos de conta

* [**Account Types API**](https://docs.lerian.studio/pt/reference/products/midaz/v2/create-account-type.md) – defina e gerencie categorias de conta personalizadas. Uma vez habilitados, esses tipos passam a ser obrigatórios no processo de criação de contas e mantêm o seu ledger consistente.

### Saldos em tempo real

A seção **Balances** agora inclui endpoints para monitorar posições em tempo real em casos de uso de tesouraria, compliance e conciliação:

* [**Recuperar o saldo pelo alias da conta**](https://docs.lerian.studio/pt/reference/products/midaz/v2/get-balances-by-alias.md) – obtenha o saldo de qualquer conta pelo alias legível por humanos.
* [**Recuperar o saldo de uma conta externa**](https://docs.lerian.studio/pt/reference/products/midaz/v2/get-balances-external-by-code.md) – busque os saldos atuais de contas externas como `@external/BRL`, normalmente usadas para acompanhar entradas e saídas fora do seu ledger interno.

### Transações em duas fases

Também introduzimos as **transações em duas fases**, que dão mais controle sobre a finalização da transação:

* [**Commit de uma transação pendente**](https://docs.lerian.studio/pt/reference/products/midaz/v2/commit-transaction.md) – finalize uma transação que tinha sido marcada como pendente.
* [**Cancelar uma transação pendente**](https://docs.lerian.studio/pt/reference/products/midaz/v2/cancel-transaction.md) – cancele uma transação pendente antes que ela receba commit no ledger.

Isso permite workflows avançados como pré-validação de transação, execução postergada ou aprovações condicionais.

## Melhorias nos plugins

***

### Fee Engine

O Fee Engine foi atualizado para acompanhar as melhorias feitas no Midaz Core e dar mais controle sobre como as tarifas são calculadas e lançadas.

O que há de novo:

* Campos como `transactionRoute`, `routeFrom` e `routeTo` agora permitem um roteamento mais granular por item de tarifa.
* A flag `isDeductibleFrom` ajuda a definir se uma tarifa deve ser deduzida proporcionalmente do total da transação.
* Os débitos e créditos de tarifa agora são separados por conta para mais clareza.
* Os campos antigos `chartOfAccounts` foram removidos.
* Os valores agora usam um campo único `value` do tipo `string`.

Essas mudanças ajudam você a aplicar tarifas com precisão, em vários caminhos contábeis, e a garantir conformidade com a lógica interna de roteamento.

### Smart Templates

O plugin Smart Templates agora inclui novas APIs que permitem gerar filtros dinâmicos com base na estrutura da sua fonte de dados.

* [**Listar fontes de dados**](https://docs.lerian.studio/pt/reference/products/reporter/list-data-sources.md) – retorna todas as fontes disponíveis conectadas ao plugin.
* [**Recuperar uma fonte de dados por id**](https://docs.lerian.studio/pt/reference/products/reporter/retrieve-data-source.md) – retorna tabelas e campos de uma fonte específica.

Esses endpoints ajudam você a construir relatórios mais flexíveis, sem precisar conhecer todo o schema de antemão.

**Todos os endpoints existentes também foram atualizados para se alinhar às melhorias do Midaz Core.**


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.