Skip to main content
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. Você registra os Tipos de Conta que correspondem à sua estrutura contábil. Quando você habilita a validação de Tipo de Conta, o ledger confere o campo type de cada nova Conta não externa contra esses tipos registrados.

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

​
Habilitar a validação de Tipo de Conta

Você habilita a validação de Tipo de Conta por ledger pela API de Configurações do Ledger. Envie uma requisição PATCH ao endpoint de Configurações do Ledger:
Mudanças de configuração valem de imediato e não precisam de um novo deploy. Você pode atualizá-las a qualquer momento pela 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 informar um type. Ele aceita qualquer valor de string com até 256 caracteres. O ledger não o compara aos Tipos de Conta registrados.
  • Validação habilitada: o campo type deve corresponder ao keyValue de um Tipo de Conta registrado. O Midaz guarda os novos valores de keyValue em minúsculas e compara o valor sem diferenciar maiúsculas de minúsculas. Use valores em 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 pulam essa checagem.
Antes de habilitar a validação de Tipo de Conta, revise as suas contas existentes. O campo type de uma Conta existente não pode ser alterado, então crie um Tipo de Conta registrado correspondente ou recrie uma Conta cujo type deve 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 na validação: quando você habilita validateAccountType nas Configurações do Ledger, o ledger compara o campo type de cada Conta não externa com um keyValue registrado, sem diferenciar maiúsculas de minúsculas. O ledger rejeita qualquer Conta não externa com um type não registrado.

​
Gerenciar Tipos de Conta

Você gerencia Tipos de Conta pela API ou pelo Lerian Console.
Veja também
  • Roteamento de Transações: as Rotas de Operação usam ruleType: account_type para validar o type de uma conta contra os valores account.validIf configurados na rota.
  • Lançamentos contábeis: como o Midaz resolve as rubricas de débito e de crédito para as contas que esses tipos classificam.