Como funciona a validação de Tipo de Conta
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çãoPATCH para o endpoint de Configurações do Ledger:
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
typese 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.
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
keyValuedeve ser único dentro de um dado ledger. - Usado para validação de tipo: Quando
validateAccountTypeestá habilitado nas Configurações do Ledger, o campotypede qualquer Conta deve corresponder exatamente a um dos stringskeyValueregistrados. Contas criadas com um valortypenão registrado serão rejeitadas.
Gerenciando Tipos de Conta
Você pode gerenciar seus Tipos de Conta exclusivamente via API.
- Criar um Tipo de Conta — Registre um novo Tipo de Conta para o seu Ledger.
- Listar Tipos de Conta — Recupere todos os Tipos de Conta configurados no seu Ledger.
- Recuperar um Tipo de Conta — Obtenha informações detalhadas sobre um Tipo de Conta específico.
- Atualizar um Tipo de Conta — Modifique a definição de um Tipo de Conta existente.
- Excluir um Tipo de Conta — Remova um Tipo de Conta que não está mais em uso.
Veja também
- Roteamento de Transações — As Operation Routes usam
ruleType: account_typepara validar contas contra os Tipos de Conta definidos aqui. - Lançamentos Contábeis — Como as rubricas de débito e crédito são resolvidas para as contas que esses tipos classificam.

