Skip to main content
Um Ledger isola Ativos, Contas, Rotas e Transações em um espaço de trabalho contábil. Crie um novo Ledger quando precisar de um domínio de saldo separado, uma linha de produto, um ambiente ou um modelo contábil distintos.

​
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. Decida o que o limite do Ledger significa antes de criá-lo. Não use um único Ledger para produtos não relacionados que precisem de estruturas de conta, rotas ou controles operacionais diferentes.

​
Criar o Ledger

1
Na página Ledgers, clique no botão Novo Ledger no canto superior direito.
2
O formulário Novo Ledger aparece.
3
Na aba Detalhes do Ledger, informe o nome do Ledger no campo Nome do Ledger.
4
(Opcional) Para incluir metadados, selecione a aba Metadados. Essa aba mostra dois campos: Chave e Valor.
  • Para adicionar mais metadados, clique no ícone de mais (+) ao lado da primeira linha.
5
(Opcional) Selecione a aba Configurações para configurar as regras de validação deste Ledger.
  • Habilite Validar Tipo de Conta se as Contas precisarem usar Tipos de Conta registrados.
  • Habilite Validar Rotas se as Transações precisarem seguir Rotas Contábeis pré-configuradas.
6
Depois de preencher o formulário, clique em Salvar.
7
Uma mensagem de sucesso aparece no canto superior direito. A página principal Ledgers agora lista o novo Ledger.

​
Guia de campos

Os campos na aba Metadados são abertos. A aba não tem 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 deste Ledger.

​
Validar Tipo de Conta

Quando você habilita essa configuração, toda nova Conta não externa precisa usar um Tipo de Conta registrado para este Ledger. Habilite-a quando quiser que os operadores classifiquem Contas de forma consistente, como customer, merchant, treasury ou fee.
Depois que você habilitar Validar Tipo de Conta, o Ledger rejeita qualquer Conta não externa sem um Tipo de Conta válido.

​
Validar Rotas

Quando você habilita essa configuração, as Transações precisam corresponder às Rotas Contábeis configuradas para este Ledger. Habilite-a somente depois de planejar ou configurar seu modelo de rotas.
Se você habilitar Validar Rotas antes de as rotas existirem, qualquer Transação sem uma rota correspondente falha na validação.

​
Próximos passos

Depois de criar o Ledger:
  1. Revise 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 de API

Endpoint para criar um Ledger