Skip to main content
Os Tipos de Conta classificam as contas do seu ledger. Cada Tipo de Conta tem um nome, uma descrição e um valor de chave único. Registre os Tipos de Conta que correspondem à sua estrutura contábil. Quando você habilita a validação de Tipo de Conta, o ledger verifica o campo type de cada Conta nova não externa contra esses tipos registrados.

​
Como funciona a validação de Tipo de Conta

​
Habilitando a validação de Tipo de Conta

Você habilita a validação de Tipo de Conta por ledger através da API de Configurações do Ledger. Envie uma requisição PATCH para o endpoint de Configurações do Ledger:
As alterações de configuração entram em vigor imediatamente — não é necessário redesplegar. Você pode atualizá-las a qualquer momento via API.

​
Comportamento do campo type na API de Contas

Quando você cria uma Conta, o comportamento do campo type depende da configuração de validação:
  • Validação desabilitada (padrão): Você deve fornecer um type. Ele aceita qualquer string com até 256 caracteres. O ledger não o compara com os Tipos de Conta registrados.
  • Validação habilitada: O campo type deve corresponder ao keyValue de um Tipo de Conta registrado. O Midaz armazena novos valores de keyValue em letras minúsculas e compara o valor sem diferenciar maiúsculas de minúsculas. Use valores em letras minúsculas nas requisições e na configuração. Se não corresponder, o ledger rejeita a conta com um erro de validação. Contas externas ignoram essa verificação.
Antes de habilitar a validação de Tipo de Conta, revise suas contas existentes. O campo type de uma Conta existente não pode ser alterado; crie um Tipo de Conta registrado correspondente ou recrie a Conta cujo type precisa mudar.

​
O campo keyValue

O campo keyValue identifica um Tipo de Conta. Ele tem estas restrições:
  • Imutável: Você define o keyValue quando cria o Tipo de Conta. Você não pode alterá-lo depois. O endpoint de Atualização de Tipo de Conta não aceita esse campo.
  • Único por ledger: Cada keyValue deve ser único dentro de um ledger.
  • Usado para validação: Quando você habilita validateAccountType nas Configurações do Ledger, o ledger compara o campo type de cada Conta não externa sem diferenciar maiúsculas de minúsculas com um keyValue registrado. O ledger rejeita qualquer Conta não externa com um type não registrado.

​
Gerenciando Tipos de Conta

Você gerencia seus Tipos de Conta via API ou pelo Lerian Console.
Veja também
  • Roteamento de Transações — As Operation Routes usam ruleType: account_type para validar o campo type de uma conta em relação aos valores account.validIf configurados na rota.
  • Lançamentos Contábeis — Como o Midaz resolve as rubricas de débito e crédito para as contas que esses tipos classificam.