> ## 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 de documentação #3 — Fim do ciclo de release

> Encerramento do ciclo de release com a nova estrutura de Guides e API Reference, o lançamento do Partners Hub, Account Types, Transaction Routing, transações em duas fases e disponibilidade de sandbox.

<Badge color="gray" size="lg">28 de julho de 2025</Badge> <Badge color="purple">Atualizado</Badge>

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

## Nova estrutura, navegação mais clara

***

Reestruturamos tanto os [**Guias**](/pt/welcome-to-our-guides) quanto a [**Referência de API**](/pt/reference/introduction) para tornar a navegação mais rápida e intuitiva.

O novo layout separa conceitos principais, plugins e SDKs, ajudando você a focar no que mais importa, seja você iniciante ou já avançado na implementação.

## Partner's Hub

***

Também lançamos o [**Partners Hub**](/pt/partners-hub/introduction): um espaço centralizado para nossos parceiros de desenvolvimento. Ele inclui padrões técnicos, regras de documentação e melhores práticas para ajudar seus plugins a se integrar perfeitamente ao ecossistema Midaz.

## Melhorias gerais

***

### Midaz Core

* Os campos `amount` e `scale` foram substituídos por um campo unificado `value` do tipo `string` (que deve conter um valor numérico).
* Os campos `chartOfAccountsGroup` e `chartOfAccounts` foram depreciados.
* O campo type na **Accounts API** agora é condicional:
* Quando a funcionalidade Account Types está **desabilitada**, type é opcional e aceita qualquer string livre.
* Quando **habilitada**, type se torna **obrigatório** e deve corresponder a um dos valores registrados na Account Types API.

### Limpeza de header de requisição

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

### Nova flag pending

Agora você pode definir a flag pending no payload de [Criar transação usando JSON](/pt/reference/midaz/create-a-transaction-using-json), que suporta fluxos de duas fases usando endpoints commit/cancel.

## Sandbox agora disponível

Todas as APIs do Midaz e plugins agora suportam **Try It** na documentação.

* Também publicamos um [guia do Sandbox](/pt/reference/using-our-sandbox) para ajudá-lo a testar de forma segura e rápida.

| APIs                                | URLs 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 principais

Adicionamos novos guias conceituais e de implementação para suportar o lançamento de duas novas funcionalidades principais:

* **Account Types** – Defina e gerencie categorias personalizadas de conta (ex.: ativo, passivo, receita) usadas em toda a sua organização. Agora referenciados ao criar contas.
* **Transaction Routing** – Roteie transações e operações automaticamente com base no tipo e metadados — sem necessidade de hardcode de aliases ou IDs de conta.

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

#### Nova página

* [Entidades de roteamento de transação](/pt/midaz/transaction-routing-entities) – Nova página sobre como usar Transaction e Operation Routes.

#### Páginas atualizadas

* [Sobre o Midaz](/pt/midaz/about-midaz)
* [Modelo de dados](/pt/midaz/data-model)
* [Entidades principais](/pt/midaz/core-entities)
* [Accounts](/pt/midaz/accounts)
* [Transactions](/pt/midaz/transactions)
* [Operations](/pt/midaz/operations)

### Guias de UI de plugins

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

* [**Usando Access Manager com Midaz Console**](/pt/platform/access-manager/using-access-manager-with-midaz-console) – Gerencie usuários e aplicações usando um modelo RBAC centralizado.
* [**Usando CRM com Midaz Console**](/pt/midaz/crm/using-crm-with-midaz-console.mdx) – Crie e atualize Holders e Alias de contas pela UI.
* [**Usando Fee Engine com Midaz Console**](/pt/midaz/plugins/fees-engine/using-fee-engine-with-midaz-console.mdx) – Interface visual para criar pacotes e regras.
* [**Usando Reporter com Midaz Console**](/pt/reporter/using-reporter-in-lerian-console) – Faça upload de arquivos .tpl, filtre dados e gere relatórios.

### Atualizações de referência

* [**Retries e Idempotência**](/pt/reference/retries-idempotency) – Expandido com exemplos e estratégias.
* [**FAQ**](/pt/midaz/faq) – Agora cobre perguntas comuns sobre idempotência e retries de erro.
* [**Observabilidade no Midaz**](/pt/midaz/observability-in-midaz) – Atualizado com a nova stack de telemetria e fluxo baseado em OpenTelemetry.

### Licença da Lerian

* [**Página de licença da Lerian**](/pt/reference/lerians-license) – Uma nova página descrevendo os termos de licença da Lerian está agora disponível na Referência.

### Midaz Console

* **Novos rótulos de botão** – Atualizamos a terminologia no Console para edição de Organizations, Ledgers, Assets, Segments, Portfolios e Accounts.

## APIs novas e atualizadas

***

Novas APIs e endpoints expandidos facilitam a automação da lógica contábil, controle do fluxo de transações e geração de relatórios dinâmicos.

## Portas de rede padrão

***

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

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

### Domínio de transações

– Transaction Routing Introduzimos uma poderosa nova funcionalidade: Transaction Routing. Essas APIs permitem que você incorpore lógica contábil diretamente nos seus fluxos financeiros, automatizando como operações são classificadas e registradas.

* [**Transaction Routes API**](/pt/reference/midaz/create-transaction-route) – Defina como transações inteiras devem ser roteadas com base no tipo. Isso permite mapeamento dinâmico de fluxos de transação para seu plano de contas.
* [**Operation Routes API**](/pt/reference/midaz/create-an-operation-route) – Defina regras de como operações individuais de débito e crédito são roteadas para tipos específicos de conta, reduzindo a necessidade de hardcode de contas em transações.

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

### Domínio de onboarding – Account Types

* [**Account Types API**](/pt/reference/midaz/create-an-account-type) – Defina e gerencie categorias personalizadas de conta. Uma vez habilitados, esses tipos se tornam obrigatórios no processo de criação de conta, garantindo consistência em todo o seu ledger.

### Saldos em tempo real

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

* [**Recuperar saldo por alias de conta**](/pt/reference/midaz/retrieve-a-balance-by-account-alias) – Obtenha o saldo de qualquer conta usando seu alias legível.
* [**Recuperar saldo de uma conta externa**](/pt/reference/midaz/retrieve-a-balance-of-an-external-account) – Busque saldos atuais de contas externas como `@external/BRL`, tipicamente usadas para rastrear entradas e saídas fora do seu ledger interno.

### Transações de duas fases

Também introduzimos **Transações de duas fases**, dando maior controle sobre a finalização de transações:

* [**Confirmar uma transação pendente**](/pt/reference/midaz/commit-a-pending-transaction) – Finalize uma transação que foi previamente marcada como pendente.
* [**Cancelar uma transação pendente**](/pt/reference/midaz/cancel-a-pending-transaction) – Cancele uma transação pendente antes de ser confirmada no ledger.

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

## Melhorias em plugins

***

### Fee Engine

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

O que há de novo:

* Campos como `transactionRoute`, `routeFrom` e `routeTo` agora permitem 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.
* Débitos e créditos de tarifas agora são separados por conta, melhorando a clareza.
* Campos antigos `chartOfAccounts` foram removidos.
* Valores agora usam um campo unificado `value` do tipo `string`.

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

### 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**](/pt/reference/reporter/list-data-sources) – Retorna todas as fontes disponíveis conectadas ao plugin.
* [**Recuperar uma fonte de dados por ID**](/pt/reference/reporter/retrieve-data-source) – Retorna tabelas e campos de uma fonte específica.

Esses endpoints ajudam você a construir relatórios mais flexíveis, sem precisar conhecer o schema completo antecipadamente.

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