> ## 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](/pt/products/midaz/console/mc-accounting) 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.
</Warning>

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

***

<Steps>
  <Step>
    Na página **Rotas Contábeis**, clique em **Nova Rota**.
  </Step>

  <Step>
    O assistente de criação abre na **Etapa 1 — Informações básicas**.
  </Step>

  <Step>
    Preencha as informações básicas:

    * **Título** (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>

  <Step>
    Clique em **Próximo** para avançar para a Etapa 2.
  </Step>
</Steps>

## 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** atua tanto como origem quanto como 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.
</Note>

<Steps>
  <Step>
    Clique em **Adicionar Rota de Operação** para criar o primeiro card de rota de operação.
  </Step>

  <Step>
    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 de Operação**: `Source`, `Destination` ou `Bidirectional`.
    * **Tipo de Validação**: Configure opcionalmente `Account Type` ou `@Alias` para validar contas. Uma Rota de Operação pode omitir a regra de validação de conta.
    * **Tipo de Conta ou Alias**: os valores de Tipo de Conta selecionados ou o alias de conta específico.
  </Step>

  <Step>
    *(Opcional)* Configure **Cenários Contábeis** para definir como o ledger registra os lançamentos. Ative os cenários que você precisa:

    <Tabs>
      <Tab title="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. Outros cenários podem variar. Veja a aba Transação em Duas Etapas para mais detalhes.
        </Tip>
      </Tab>

      <Tab title="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>

      <Tab title="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**.
        </Note>
      </Tab>

      <Tab title="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 a utilização do overdraft e o pagamento posterior.

        <Note>
          Overdraft está disponível para rotas de operação **Origem**, **Destino** e **Bidirecional**. Quando você habilita o Overdraft, o assistente também habilita o cenário Direto, porque a utilização do overdraft se liquida por meio de um lançamento direto.
        </Note>
      </Tab>

      <Tab title="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.
        </Note>
      </Tab>
    </Tabs>
  </Step>

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

    <Warning>
      Você deve adicionar pelo menos uma rota de operação de origem e uma de destino, ou pelo menos uma rota bidirecional. O assistente não avança sem uma configuração de rota válida.
    </Warning>
  </Step>

  <Step>
    Clique em **Próximo** para avançar para a Etapa 3.
  </Step>
</Steps>

## Etapa 3: Revisão

***

<Steps>
  <Step>
    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
    * Cenários contábeis com lançamentos de débito e crédito por tipo de transação
  </Step>

  <Step>
    Para ajustar qualquer coisa, clique em **Anterior** para voltar.
  </Step>

  <Step>
    Clique em **Criar Rota de Transação** para criar a Rota Contábil.
  </Step>
</Steps>

## 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: `Source`, `Destination` ou `Bidirectional`. Não pode ser alterado após a criação.                           | `Bidirectional`                       |
| Tipo de Validação       | Regra de validação de conta opcional. Use `Account Type` para classes de conta ou `@Alias` para uma conta específica. Uma Rota de Operação pode omitir esta regra. | `Account Type`                        |
| Tipo de Conta ou Alias  | Tipos de Conta ou aliases aceitos por esta rota de operação.                                                                                                       | `customer`                            |
| 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 title="Transferência Pix com cenários Direto e Duas Etapas">
  **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 de Operação  | `Bidirectional`                       |
  | Tipo de Validação | `Account Type`                        |
  | 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`  |

  **Transação em Duas Etapas: Retenção**

  | Lado    | Código da Conta | Descrição                     |
  | ------- | --------------- | ----------------------------- |
  | Débito  | `1.1.1.001`     | `Customer checking — reserve` |
  | Crédito | `2.1.1.001`     | `Pending settlement — hold`   |

  **Transação em Duas Etapas: Efetivação**

  | Lado    | Código da Conta | Descrição                      |
  | ------- | --------------- | ------------------------------ |
  | Débito  | `2.1.1.001`     | `Pending settlement — release` |
  | Crédito | `1.1.1.002`     | `Customer checking — settled`  |
</Accordion>

## 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](/pt/products/midaz/console/creating-a-transaction).

<CardGroup cols={2}>
  <Card title="Criar Rota de Transação" icon="code" href="/pt/reference/products/midaz/v2/create-transaction-route">
    Crie a rota em nível de transação via API.
  </Card>

  <Card title="Criar Rota de Operação" icon="code" href="/pt/reference/products/midaz/v2/create-operation-route">
    Crie regras de roteamento em nível de operação via API.
  </Card>
</CardGroup>
