Estrutura da Conta
- Conta > Ledger: As Contas são criadas dentro de um Ledger, que rastreia e consolida todos os saldos e operações.
- Conta > Portfolio: As Contas podem ser agrupadas em Portfólios para representar grupos de clientes, linhas de produtos ou unidades de negócios.
- Conta > Ativo: Cada Conta está vinculada a um único Ativo, definindo o tipo de valor que ela mantém — como BRL, USD, BTC ou pontos de fidelidade.
- Conta > Tipo de Conta: Com a validação de Tipo de Conta habilitada, cada Conta deve ser categorizada por um Tipo de Conta que pode ser criado de acordo com necessidades específicas do usuário ou classificação do negócio.
Características principais
- Cada Conta está vinculada a exatamente um tipo de Ativo.
- As Contas são identificadas de forma única dentro de um Ledger.
- Todas as transações envolvem débitos e créditos entre Contas.
Conta Externa
Contas Externas no Midaz representam contas fora da estrutura da sua organização. Elas são usadas para rastrear dinheiro que está entrando ou saindo, normalmente vinculadas a usuários, parceiros ou provedores financeiros fora do seu ledger interno. Mas elas são mais do que simples marcadores. Contas externas:
- Gerenciam saldos temporários durante operações envolvendo partes externas.
- São as únicas contas que podem ficar negativas, o que sinaliza que os fundos estão em trânsito.
- São criadas automaticamente pelo Ledger sempre que você cria um Ativo.
- Seguem um padrão de nomenclatura claro:
@external/<asset-code>, como@external/BRL.
Para manter o Ledger preciso e confiável, contas externas não podem ser excluídas ou alteradas.
ID da Conta Pai
O ID da Conta Pai vincula duas contas dentro do Midaz, dando a você a flexibilidade de definir o relacionamento com base na sua lógica de negócio. Seja para representar uma estrutura pai-filho tradicional ou algo completamente diferente, a escolha é sua. O Midaz fornece a base — você decide como construir sobre ela.
Aliases de Conta
Aliases facilitam a identificação de contas substituindo IDs complexos por rótulos legíveis e amigáveis.
- Por exemplo: Em vez de referenciar uma conta como
3172933b-50d2-4b17-96aa-9b378d6a6eac, você pode simplesmente usar@username_1.
Use o Alias da Conta em Transações
Ao criar uma transação, sempre use o alias da conta no campoaccount — não o ID da conta.
Atribuir um alias ao criar uma conta é opcional. Se você não fizer isso, sem problemas — o sistema usará automaticamente o ID da conta como alias. De qualquer forma, toda conta acaba com um alias único.
Então, quando for referenciar uma conta em uma transação, basta usar o alias. Limpo, consistente e pronto para uso.
Gerenciando Contas
Você pode gerenciar suas Contas via API ou através do Lerian Console.
Via API
- Criar uma Conta — Abra uma nova Conta vinculada a um Ativo.
- Listar Contas — Visualize todas as Contas no seu workspace.
- Recuperar uma Conta — Obtenha detalhes de uma Conta específica.
- Recuperar uma Conta por Alias — Obtenha detalhes de uma Conta específica pelo seu alias.
- Recuperar uma Conta Externa — Obtenha detalhes de uma Conta Externa específica pelo código do ativo.
- Atualizar uma Conta — Edite os metadados ou configurações de uma Conta existente.
- Excluir uma Conta — Exclua uma Conta específica.

