Pular para o conteúdo principal

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.

Use o Módulo Midaz para gerenciar Rotas Contábeis, a configuração para roteamento de transações no Midaz. Um assistente guiado de 3 etapas conduz você pela definição da Rota Contábil, adição das Rotas de Operação e revisão da configuração final.

Entendendo as Rotas Contábeis

Comece por aqui se precisar decidir entre usar cenários de Origem, Destino, Bidirecional, validação por Tipo de Conta, validação por alias, Direta, Duas Etapas ou Estorno.
Uma Rota Contábil define a lógica completa de roteamento de uma transação: os metadados no nível da transação (título e descrição), as Rotas de Operação que especificam quais contas participam e em qual direção, e os Cenários Contábeis que controlam como os lançamentos são registrados em diferentes tipos de transação. Para detalhes técnicos sobre as entidades subjacentes, consulte a página Entidades de Roteamento de Transações.

​
Conceitos-chave

​
Tipos de Rota de Operação

Cada Rota de Operação dentro de uma Rota Contábil recebe um dos três tipos:
  • Origem — Define regras de validação para contas de onde os fundos se originam (lado de débito)
  • Destino — Define regras de validação para contas para onde os fundos são enviados (lado de crédito)
  • Bidirecional — Aplica-se a ambos os lados da transação, atuando como origem e destino
Uma Rota Contábil válida requer pelo menos uma Rota de Operação de origem e uma de destino, ou pelo menos uma Rota de Operação bidirecional.

​
Tipos de Validação

Cada Rota de Operação valida contas usando um dos dois métodos:
  • Tipo de Conta — Valida contra uma ou mais categorias de Tipo de Conta (ex.: checking, savings). Use quando qualquer conta de um determinado tipo for válida.
  • @Alias — Valida contra um alias específico de conta (ex.: @treasury_main). Use quando precisar direcionar uma conta exata.

​
Cenários Contábeis

Os Cenários Contábeis definem como os lançamentos de débito e crédito são registrados para cada Rota de Operação. Você pode configurar lançamentos para três tipos de transação:
  • Transação Direta — Transação padrão de uma etapa. Defina os códigos de conta e descrições de débito e crédito para liquidação imediata.
  • Transação em Duas Etapas — Transações que passam por um ciclo de reserva e confirmação. Configure lançamentos para:
    • Reserva de Valor — Lançamentos registrados quando os fundos são reservados
    • Confirmação da Reserva — Lançamentos registrados quando a reserva é confirmada
    • Cancelamento da Reserva — Lançamentos registrados caso a reserva seja cancelada
  • Estorno — Lançamentos registrados quando uma transação concluída é revertida
Cada lançamento de cenário inclui um Código da Conta e uma Descrição para ambos os lados de débito e crédito.
Quais lados de lançamento estão disponíveis depende do tipo da Rota de Operação e da fase do cenário. A regra geral é:
  • Origem — Lançamentos de débito em todas as fases. Lançamentos de crédito apenas na Reserva de Valor e no Cancelamento (não na Transação Direta nem na Confirmação).
  • Destino — Apenas lançamentos de crédito, exibidos na Transação Direta e na Confirmação. As fases de Reserva de Valor e Cancelamento não estão disponíveis.
  • Bidirecional — Lançamentos de débito e crédito em todas as fases, incluindo Estorno.

​
Acessando a página de Rotas Contábeis

O menu de Rotas Contábeis só é visível quando a configuração Validar Rotas está habilitada para o Ledger atual. Para habilitá-la, abra os detalhes do Ledger, vá até a aba Configurações e ative o interruptor Validar Rotas.
Para abrir a página de Rotas Contábeis, selecione Rotas Contábeis na seção Contábil do menu lateral esquerdo. A página de Rotas Contábeis exibe uma lista de todas as Rotas Contábeis que você criou para o Ledger atual. Você pode expandir cada linha para visualizar as Rotas de Operação associadas, incluindo seu ID, título, descrição e Tipo de Operação.

​
Ações disponíveis

Na página de Rotas Contábeis, você pode:

Criar uma Rota Contábil

Definir uma nova Rota Contábil com Rotas de Operação e Cenários Contábeis.

Editar uma Rota Contábil

Modificar uma Rota Contábil existente e suas Rotas de Operação.

​
Casos de uso comuns

Crie uma Rota Contábil com uma Rota de Operação bidirecional que valide Tipos de Conta checking e savings. Habilite cenários de Transação Direta com os códigos apropriados do plano de contas para lançamentos de liquidação Pix.
Crie uma Rota Contábil com Rotas de Operação separadas de origem e destino. Habilite cenários de Transação em Duas Etapas para registrar os lançamentos de Reserva de Valor, Confirmação da Reserva e Cancelamento da Reserva opcional de forma independente.
Crie uma Rota Contábil com uma Rota de Operação de origem usando validação por alias (@treasury_main) e uma Rota de Operação de destino para Tipos de Conta department_budget. Habilite os cenários de Transação Direta e Estorno para lidar com movimentações padrão e seus estornos.

​
Boas práticas

1

Use títulos descritivos

Nomeie suas Rotas Contábeis de forma clara para indicar o tipo de transação que elas processam (ex.: Pix Transfer Route em vez de Route 1).
2

Escolha o Tipo de Operação correto

Use Bidirecional quando as mesmas regras de validação se aplicarem a ambos os lados. Use Rotas de Operação separadas de Origem e Destino quando cada lado tiver requisitos diferentes de conta.
3

Configure os Cenários Contábeis cedo

Defina os lançamentos do plano de contas durante a criação da rota. Isso garante que as transações processadas pela rota produzam registros contábeis corretos desde o início.
4

Revise antes de confirmar

O assistente inclui uma etapa de Revisão — use-a para verificar todas as Rotas de Operação, regras de validação e lançamentos contábeis antes de criar a rota.