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.

As Rotas Contábeis são criadas por meio de um assistente guiado de 3 etapas que conduz você pela definição da Rota de Transação, configuração das Rotas de Operação com cenários contábeis e revisão da configuração final.

Antes de começar


Crie os Tipos de Conta e as Contas que a rota irá validar. Se você ainda está decidindo entre cenários Origem, Destino, Bidirecional, validação de Tipo de Conta, validação de alias, Direta, Em Duas Etapas ou Estorno, leia primeiro Entendendo as Rotas Contábeis.
Se Validar Rotas estiver habilitado para o Ledger, as transações precisam corresponder a uma rota existente. Não habilite a validação de rotas até que as Rotas Contábeis necessárias estejam prontas.

Etapa 1: Informações básicas


1
Na página Rotas Contábeis, clique em Nova Rota.
2
O assistente de criação abre na Etapa 1 — Informações básicas.
3
Preencha as informações básicas:
  • Título: um nome descritivo para esta Rota de Transação.
  • Descrição: uma descrição opcional da finalidade da rota.
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 que definem como as contas são validadas e como os lançamentos contábeis são registrados.
1
Clique em Adicionar Rota de Operação para criar seu primeiro card de Rota de Operação.
2
Configure a Rota de Operação:
  • Descrição: a finalidade desta Rota de Operação.
  • Tipo de Operação: Origem, Destino ou Bidirecional.
  • Tipo de Validação: Tipo de Conta, @Alias ou em branco quando nenhuma validação de conta for necessária.
  • Tipo de Conta ou Alias: os valores de Tipo de Conta selecionados ou o alias específico da conta.
3
(Opcional) Configure os Cenários Contábeis para definir como os lançamentos são registrados. Ative os cenários que você precisar:
Transação padrão em uma única etapa. Defina o Código da Conta e a Descrição para:
  • Débito — O código de conta debitado na execução
  • Crédito — O código de conta creditado na execução
Nas Transações Diretas, os lados exibidos dependem do Tipo de Operação. Rotas Origem mostram apenas débito, rotas Destino mostram apenas crédito, e rotas Bidirecionais mostram ambos. Outros cenários podem ser diferentes — consulte a aba Transação em Duas Etapas para mais detalhes.
4
(Opcional) Clique novamente em Adicionar Rota de Operação para adicionar mais Rotas de Operação a esta Rota Contábil.
Você precisa adicionar ao menos uma Rota de Operação de origem e uma de destino, ou ao menos uma rota bidirecional. O assistente não prossegue sem uma configuração de rota válida.
5
Clique em Próximo para avançar para a Etapa 3.

Etapa 3: Revisão


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
  • Cenários Contábeis com lançamentos de débito e crédito por tipo de transação
2
Se algo precisar ser ajustado, clique em Anterior para voltar.
3
Clique em Criar Rota de Transação para criar a Rota Contábil.

Guia de campos


Informações básicas

CampoO que informarExemplo
Título da RotaNome obrigatório da rota. Mantenha curto e específico ao fluxo de negócio.Pix Transfer Route
DescriçãoExplicação opcional do que a rota valida ou registra.Handles Pix transfers between customer accounts.

Rota de Operação

CampoO que informarExemplo
DescriçãoFinalidade deste card de Rota de Operação.Checking account validation for Pix
TipoLado 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çãoComo as contas são validadas. Use Tipo de Conta para classes de conta ou @Alias para uma conta específica. Deixe em branco apenas quando não houver necessidade de validação.Tipo de Conta
Tipo de Conta ou AliasTipos de Conta ou aliases aceitos por esta Rota de Operação.customer
Cenários ContábeisCenários de transação que esta rota deve registrar: Direta, Em Duas Etapas ou Estorno.Transação Direta
Código da ContaCó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çamentoDescrição em nível de lançamento exibida na configuração do cenário.Customer checking - outbound

Exemplo rápido


Rota de Transação
CampoValor
TítuloPix Transfer Route
DescriçãoHandles Pix instant transfers between checking accounts
Rota de Operação 1 — Bidirecional
CampoValor
DescriçãoChecking account validation for Pix
Tipo de OperaçãoBidirecional
Tipo de ValidaçãoTipo de Conta
Tipos de Contachecking
Cenário Transação Direta
LadoCódigo da ContaDescrição
Débito1.1.1.001Customer checking — outbound
Crédito1.1.1.002Customer checking — inbound
Transação em Duas Etapas — Hold
LadoCódigo da ContaDescrição
Débito1.1.1.001Customer checking — reserve
Crédito2.1.1.001Pending settlement — hold
Transação em Duas Etapas — Commit
LadoCódigo da ContaDescrição
Débito2.1.1.001Pending settlement — release
Crédito1.1.1.002Customer checking — settled

O que fazer em seguida


Após criar a rota, crie uma transação que corresponda aos mesmos Tipos de Conta, aliases e cenário em Criando uma Transação.

Criar Rota de Transação

Crie a rota em nível de transação pela API.

Criar Rota de Operação

Crie regras de roteamento em nível de operação pela API.