> ## 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.

# Criando uma Rota Contábil

> Crie uma nova Rota Contábil no Console usando o assistente de 3 etapas para definir rotas de transação, rotas de operação e cenários contábeis.

Você cria uma Rota Contábil por meio de um assistente guiado de 3 etapas. O assistente conduz você pela rota de transação, pelas rotas de operação com seus cenários contábeis, e por uma revisão final.

## Antes de começar

***

Crie os Tipos de Conta e as Contas que a rota vai validar. Se você ainda não escolheu o tipo de operação, o tipo de validação e os cenários contábeis, leia [Regras contábeis](https://docs.lerian.studio/pt/products/midaz/console/mc-accounting.md) primeiro.

> [!WARNING]
>
> Se você habilitar **Validar Rotas** para o Ledger, cada transação deve corresponder a uma rota existente. Não habilite a validação de rotas até que as Rotas Contábeis necessárias estejam prontas.

A barra lateral mostra **Rotas Contábeis** somente quando **Validar Rotas** está ativo para o Ledger. Quando está desativado, abra a página pela busca de páginas do Console (**Pesquisar páginas...**).

## Etapa 1: Informações básicas

***

**Step 1**

Na página **Rotas Contábeis**, clique em **Nova Rota**.

**Step 2**

O assistente de criação abre na etapa **Rota de Transação**.

**Step 3**

Preencha as informações básicas:

* **Título da Rota** (obrigatório): um nome descritivo para esta rota de transação. Você deve preencher este campo para continuar.
* **Descrição** (opcional): uma descrição da finalidade da rota. Se você deixá-la vazia, o assistente envia e armazena uma descrição vazia.

**Step 4**

Clique em **Próximo** para avançar para a Etapa 2.

## Etapa 2: Rotas de Operação

***

Nesta etapa, você adiciona e configura as rotas de operação. As rotas de operação definem como o ledger valida contas e registra lançamentos contábeis.

> [!NOTE]
>
> Uma rota de operação **Bidirecional** é ao mesmo tempo origem e destino. Quando você cria uma transação depois, o ledger corresponde uma rota bidirecional tanto no lado de origem quanto no lado de destino. Uma única rota pode então validar as duas pontas do fluxo.

**Step 1**

Clique em **Adicionar Rota de Operação** para criar o primeiro card de rota de operação.

**Step 2**

Configure a rota de operação:

* **Título** (obrigatório): um nome para esta rota de operação. A rota de operação tem um único campo de texto obrigatório e nenhum campo de descrição separado. Você não pode avançar para a próxima etapa até preenchê-lo.
* **Tipo**: **Origem**, **Destino** ou **Bidirecional**.
* **Tipo de Validação**: **Tipo de Conta** ou **@Alias**. O assistente exige pelo menos um Tipo de Conta ou um alias para cada rota de operação.
* **Tipo de Conta ou Alias**: os valores de Tipo de Conta selecionados ou o alias de conta específico.
* **Rota opcional**: desativada por padrão. Ative quando uma transação puder deixar esta rota de operação sem uso. Quando a transação usa a rota, o Ledger a valida como as demais.

**Step 3**

Configure **Cenários Contábeis** para definir como o ledger registra os lançamentos. **Transação Direta** fica sempre ativa, e você deve preencher os lançamentos dela. Ative os outros cenários que você precisa:

> [tab] Transação Direta
>
> Transação padrão de uma etapa. Defina o **Código da Conta** e a **Descrição** para:
>
> * **Débito**: O código da conta debitada na execução
>
> * **Crédito**: O código da conta creditada na execução
>
> > [!TIP]
> >
> > Para Transações Diretas, quais lados aparecem depende do tipo de operação. Rotas de origem mostram apenas débito, rotas de destino mostram apenas crédito, e rotas bidirecionais mostram os dois.

> [tab] Transação em Duas Etapas
>
> Transações com um ciclo de retenção seguida de efetivação. Configure lançamentos para cada fase:
>
> * **Retenção (Reserva de Valor)**: Lançamentos que registram fundos reservados
> * **Efetivação (Confirmação da Reserva)**: Lançamentos que confirmam a reserva
> * **Cancelamento (Cancelamento da Reserva)**: Lançamentos que cancelam a reserva. Preencha também estes campos: o ledger valida Retenção, Efetivação e Cancelamento como um grupo atômico e rejeita a rota quando o mapeamento de Cancelamento está ausente.
>
> Os campos de lançamento disponíveis variam de acordo com o tipo de operação:
>
> * **Origem**: Retenção e Cancelamento mostram os campos de débito e crédito. Efetivação mostra apenas débito.
> * **Destino**: Apenas a fase de Efetivação aparece, apenas com crédito. Retenção e Cancelamento não estão disponíveis.
> * **Bidirecional**: Todas as fases mostram os campos de débito e crédito.

> [tab] Estorno
>
> Lançamentos que registram o estorno de uma transação concluída. Defina os códigos de conta e as descrições de débito e crédito para os lançamentos de estorno.
>
> > [!NOTE]
> >
> > O cenário de Estorno está disponível apenas para rotas de operação **Bidirecional**.

> [tab] Overdraft
>
> Lançamentos que se aplicam quando um débito excede os fundos disponíveis da conta e recorre a uma linha de overdraft. Defina os códigos de conta e as descrições de débito e crédito para o uso do overdraft e o pagamento posterior.
>
> > [!NOTE]
> >
> > Overdraft está disponível para rotas de operação **Origem** e **Bidirecional**.

> [tab] Bloqueio
>
> Lançamentos que registram o bloqueio e o desbloqueio de fundos em uma conta. Configure duas seções independentes, **Bloqueio** e **Desbloqueio**. Cada seção é tudo ou nada: deixe-a vazia para usar os lançamentos padrão, ou preencha o código da conta e a descrição para cada lado visível.
>
> > [!NOTE]
> >
> > Bloqueio está disponível para todos os tipos de operação. Rotas de origem mostram apenas lançamentos de débito, rotas de destino mostram apenas lançamentos de crédito, e rotas bidirecionais mostram os dois.

**Step 4**

*(Opcional)* Clique em **Adicionar Rota de Operação** novamente para adicionar mais rotas de operação a esta Rota Contábil.

> [!WARNING]
>
> Adicione pelo menos uma rota de operação de origem obrigatória e uma de destino obrigatória, ou uma rota bidirecional obrigatória. Rotas opcionais não contam. O assistente não avança sem uma configuração de rota válida.

**Step 5**

Clique em **Próximo** para avançar para a Etapa 3.

## Etapa 3: Revisão

***

**Step 1**

Revise a configuração completa:

* Título e descrição da rota de transação
* Cada rota de operação com seu tipo, regras de validação e lançamentos contábeis. Um selo **Opcional** marca cada rota opcional
* Cenários contábeis com lançamentos de débito e crédito por tipo de transação

**Step 2**

Para ajustar qualquer coisa, clique em **Anterior** para voltar.

**Step 3**

Clique em **Criar Rota de Transação** para criar a Rota Contábil.

O Ledger pode recusar o salvamento e indicar uma rota de operação. Nesse caso, o assistente volta à Etapa 2 e mostra a recusa nesse card.

## Guia de campos

***

### Informações básicas

| Campo | O que informar | Exemplo |
| - | - | - |
| Título da Rota | Nome obrigatório da rota. Mantenha-o curto e específico para o fluxo de negócio. | `Pix Transfer Route` |
| Descrição | Explicação opcional do que a rota valida ou registra. | `Handles Pix transfers between customer accounts.` |

### Rota de operação

| Campo | O que informar | Exemplo |
| - | - | - |
| Título | Nome obrigatório para este card de rota de operação. Deve ser preenchido antes de avançar; não há campo de descrição separado. | `Checking account validation for Pix` |
| Tipo | Lado contábil ao qual esta rota de operação se aplica: **Origem**, **Destino** ou **Bidirecional**. Não pode ser alterado após a criação. | **Bidirecional** |
| Tipo de Validação | Regra de validação de conta obrigatória. Use **Tipo de Conta** para classes de conta ou **@Alias** para uma conta específica. | **Tipo de Conta** |
| Tipo de Conta ou Alias | Tipos de Conta ou aliases aceitos por esta rota de operação. | `customer` |
| Rota opcional | Interruptor, desativado por padrão. Ative quando uma transação puder deixar esta rota de operação sem uso. | Desativado |
| Cenários Contábeis | Cenários de transação que esta rota deve registrar: Direto, Duas Etapas, Estorno, Overdraft ou Bloqueio. | `Direct Transaction` |
| Código da Conta | Código contábil usado no lançamento de débito ou crédito do cenário selecionado. | `1.1.1.001` |
| Descrição do Lançamento | Descrição em nível de lançamento mostrada na configuração do cenário. | `Customer checking - outbound` |

## Exemplo rápido

***

> [accordion] Transferência Pix com cenário Direto
>
> **Rota de Transação**
>
> | Campo | Valor |
> | - | - |
> | Título | `Pix Transfer Route` |
> | Descrição | `Handles Pix instant transfers between checking accounts` |
>
> **Rota de Operação 1: Bidirecional**
>
> | Campo | Valor |
> | - | - |
> | Título | `Checking account validation for Pix` |
> | Tipo | **Bidirecional** |
> | Tipo de Validação | **Tipo de Conta** |
> | Tipos de Conta | `checking` |
>
> **Cenário Transação Direta**
>
> | Lado | Código da Conta | Descrição |
> | - | - | - |
> | Débito | `1.1.1.001` | `Customer checking — outbound` |
> | Crédito | `1.1.1.002` | `Customer checking — inbound` |

## Próximos passos

***

Depois de criar a rota, crie uma transação que corresponda aos mesmos tipos de conta, aliases e cenário em [Criando uma Transação](https://docs.lerian.studio/pt/products/midaz/console/creating-a-transaction.md).

> [card] [Criar Rota de Transação](https://docs.lerian.studio/pt/reference/products/midaz/v2/create-transaction-route.md)
>
> Crie a rota em nível de transação via API.

> [card] [Criar Rota de Operação](https://docs.lerian.studio/pt/reference/products/midaz/v2/create-operation-route.md)
>
> Crie regras de roteamento em nível de operação via API.


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