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.

Um Ledger é o espaço de trabalho contábil onde Ativos, Contas, Rotas e Transações ficam isolados. Crie um novo Ledger quando precisar de um domínio de saldos, linha de produto, ambiente ou modelo contábil separado.

​
Antes de começar

Você precisa de uma Organização existente. Se esta for a primeira configuração, crie a Organização primeiro em Criando uma Organização. Defina o que o limite do Ledger representa antes de criá-lo. Evite usar um mesmo Ledger para produtos não relacionados se eles exigirem estruturas de Contas, Rotas ou controles operacionais diferentes.

​
Crie o Ledger

1
Na página Ledgers, clique no botão Novo Ledger no canto superior direito.
2
O formulário Novo Ledger será exibido.
3
Na aba Detalhes do Ledger, digite o nome do Ledger no campo Nome do Ledger.
4
(Opcional) Para incluir metadados, selecione a aba Metadata. Isso exibirá dois campos: Key e Value.
  • Para adicionar mais metadados, clique no ícone de mais (+) ao lado da primeira linha.
5
(Opcional) Selecione a aba Configurações para configurar regras de validação deste Ledger.
  • Ative Validar Tipo de Conta se as Contas precisarem usar Tipos de Conta registrados.
  • Ative Validar Rotas se as Transações precisarem seguir Rotas Contábeis pré-configuradas.
6
Após preencher o formulário, clique em Salvar.
7
Uma mensagem de sucesso aparecerá no canto superior direito da tela, e o novo Ledger será adicionado à lista na página principal de Ledgers.

​
Guia de campos

CampoO que informarExemplo
Nome do LedgerUm nome claro para o espaço de trabalho contábil. Use um nome que reflita o produto, país, ambiente ou limite de negócio.Brazil Payments Ledger
Metadata KeyNome opcional do campo de classificação ou integração.environment
Metadata ValueValor da chave de metadado.production
Validar Tipo de ContaConfiguração opcional. Ative quando cada Conta neste Ledger precisar usar um Tipo de Conta previamente registrado. Deixe desativado se ainda não for classificar Contas por tipo.Habilitado
Validar RotasConfiguração opcional. Ative apenas após planejar ou configurar as Rotas Contábeis deste Ledger, porque, quando habilitado, as Transações precisam corresponder a uma Rota válida.Desabilitado
Os campos da aba Metadata são abertos. Não existem chaves ou valores predefinidos. Use nomes de chave consistentes em toda a sua Organização, como environment, businessLine ou region, para que você possa filtrar e auditar Ledgers depois.

​
Configurações do Ledger

A aba Configurações controla as regras de validação do Ledger que você está criando.

​
Validar Tipo de Conta

Quando esta configuração está habilitada, cada nova Conta neste Ledger precisa usar um Tipo de Conta previamente registrado para o Ledger. Ative quando quiser que os operadores classifiquem as Contas de forma consistente, como customer, merchant, treasury ou fee.
Após habilitar Validar Tipo de Conta, Contas sem um Tipo de Conta válido serão rejeitadas.

​
Validar Rotas

Quando esta configuração está habilitada, as Transações precisam corresponder às Rotas Contábeis configuradas para este Ledger. Ative apenas quando o seu modelo de Rotas já estiver planejado ou configurado.
Se Validar Rotas for habilitado antes que existam Rotas, as Transações que não corresponderem a uma Rota disponível falharão na validação.

​
Próximos passos

Após criar o Ledger:
  1. Verifique se Validar Tipo de Conta e Validar Rotas estão corretos para este Ledger.
  2. Crie pelo menos um Ativo em Criando um Ativo.
  3. Se precisar alterar as regras de validação depois, use a aba Configurações descrita em Gerenciando Ledgers.

Equivalente na API

Endpoint Criar um Ledger