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.

Os Tipos de Conta no Midaz permitem que você classifique sistematicamente as contas de acordo com as necessidades da estrutura financeira da sua organização. Essas classificações definem a natureza e o propósito das contas dentro do design do seu ledger, permitindo o roteamento adequado de transações e a validação operacional entre diferentes categorias de contas. Os Tipos de Conta podem ser customizados via API de Tipos de Conta para atender aos seus requisitos de negócio e fluxos de trabalho financeiros específicos, fornecendo a base para o processamento estruturado de transações enquanto mantém a integridade dos dados.

​
Habilitando a validação de Tipo de Conta

A validação de Tipo de Conta é habilitada por ledger através da API de Configurações do Ledger. Para ativá-la, envie uma requisição PATCH para o endpoint de Configurações do Ledger: 
{
  "accounting": {
    "validateAccountType": true
  }
}
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

Ao criar uma Conta, o comportamento do campo type se adapta com base na ativação do recurso de Validação de Tipo de Conta:
  • Validação de Tipo de Conta Desabilitada (Padrão): O campo type é opcional e aceita qualquer string livre.
  • Validação de Tipo de Conta Habilitada: O campo type se torna obrigatório e deve corresponder a um dos Tipos de Conta previamente registrados via API de Tipos de Conta. Se um tipo inválido ou não registrado for enviado, o sistema retornará um erro de validação.
Se sua organização está habilitando o recurso de Validação de Tipo de Conta, recomendamos revisar as contas existentes. Pode ser necessário recriá-las ou atribuir retroativamente o Tipo de Conta apropriado para alinhar com sua estrutura contábil.
Essa dinâmica garante que cada conta esteja alinhada com as categorias contábeis formais exigidas pelo seu negócio, fortalecendo a governança e os relatórios financeiros.

​
O campo keyValue

O campo keyValue identifica um Tipo de Conta e possui as seguintes restrições:
  • Imutável: O keyValue é definido no momento da criação e não pode ser alterado posteriormente. 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 dado ledger.
  • Usado para validação de tipo: Quando validateAccountType está habilitado nas Configurações do Ledger, o campo type de qualquer Conta deve corresponder exatamente a um dos strings keyValue registrados. Contas criadas com um valor type não registrado serão rejeitadas.

​
Gerenciando Tipos de Conta

Você pode gerenciar seus Tipos de Conta exclusivamente via API.