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.
Esta página é destinada a desenvolvedores e administradores de banco de dados. Ela contém esquemas de banco de dados detalhados e estruturas de tabelas. Se você está procurando uma visão geral de nível de negócio sobre as entidades do Midaz e como elas se relacionam, veja Sobre o Midaz .Explore as tabelas e esquemas principais que alimentam o Midaz. Esta referência ajuda desenvolvedores e administradores de banco de dados a entender como os dados são estruturados e conectados em todo o sistema. Conforme o Midaz evolui, novos campos e tabelas podem ser adicionados.
Tabelas Cada tabela é estruturada para suportar consultas eficientes e integridade de dados, alinhada com o compromisso do Midaz com escalabilidade e flexibilidade.
Tabela: organization Coluna Tipo Descrição id uuidO identificador único da Organização. legalName textA razão social da Organização. parentOrganizationId uuidO identificador único da Organização pai. doingBusinessAs textO nome fantasia da Organização. legalDocument textO documento da Organização. status jsonbInformações sobre o status. address jsonbInformações sobre o endereço da Organização. metadata jsonbPares chave-valor para adicionar como metadata. createdAt timestamptzTimestamp de criação (UTC). updatedAt timestamptzTimestamp da última atualização (UTC). deletedAt timestamptzTimestamp de exclusão lógica, se aplicável (UTC).
Tabela: ledger Coluna Tipo Descrição id uuidO identificador único do Ledger. organizationId uuidO identificador único da Organização. name textO nome do Ledger. status jsonbInformações sobre o status. metadata jsonbPares chave-valor para adicionar como metadata. createdAt timestamptzTimestamp de criação (UTC). updatedAt timestamptzTimestamp da última atualização (UTC). deletedAt timestamptzTimestamp de exclusão lógica, se aplicável (UTC).
Tabela: asset Coluna Tipo Descrição id uuidO identificador único do Ativo. organizationId uuidO identificador único da Organização. ledgerId uuidO identificador único do Ledger. name textO nome do Ativo. type enumO tipo de Ativo (currency, crypto, commodity, others). code textO código usado para se referir ao Ativo. status textInformações sobre o status. metadata jsonbPares chave-valor para adicionar como metadata. createdAt timestamptzTimestamp de criação (UTC). updatedAt timestamptzTimestamp da última atualização (UTC). deletedAt timestamptzTimestamp de exclusão lógica, se aplicável (UTC).
Tabela: account-type Coluna Tipo Descrição id uuidO identificador único do Tipo de Conta. ledgerId uuidO identificador único do Ledger. name textNome do Tipo de Conta. description textDescrição do Tipo de Conta. keyValue textValor personalizado definido pelo usuário para identificar o Tipo de Conta. createdAt timestamptzTimestamp de criação (UTC). updatedAt timestamptzTimestamp da última atualização (UTC). deletedAt timestamptzTimestamp de exclusão lógica, se aplicável (UTC).
Tabela: account Coluna Tipo Descrição id uuidO identificador único da Conta. organizationId uuidO identificador único da Organização. ledgerId uuidO identificador único do Ledger. assetCode textO código usado para se referir ao Ativo. name textO nome da Conta. alias textUm identificador único e amigável para a conta. type textO tipo de conta. parentAccountId uuidO identificador único da Conta Pai. entityId textO identificador único da Entidade responsável pela Conta. portfolioId uuidO identificador único do Portfolio. segmentId uuidO identificador único do Segmento. status jsonbInformações sobre o status. metadata jsonbPares chave-valor para adicionar como metadata. createdAt timestamptzTimestamp de criação (UTC). updatedAt timestamptzTimestamp da última atualização (UTC). deletedAt timestamptzTimestamp de exclusão lógica, se aplicável (UTC).
Tabela: portfolio Coluna Tipo Descrição id uuidO identificador único do Portfolio. organizationId uuidO identificador único da Organização. ledgerId uuidO identificador único do Ledger. entityId textO identificador único do usuário responsável pelo Portfolio. name textO nome do Portfolio. status jsonbInformações sobre o status. metadata jsonbPares chave-valor para adicionar como metadata. createdAt timestamptzTimestamp de criação (UTC). updatedAt timestamptzTimestamp da última atualização (UTC). deletedAt timestamptzTimestamp de exclusão lógica, se aplicável (UTC).
Tabela: segment Coluna Tipo Descrição id uuidO identificador único do Segmento. organizationId uuidO identificador único da Organização. ledgerId uuidO identificador único do Ledger. name textO nome do Segmento. status jsonbInformações sobre o status. created_at timestamptzTimestamp de criação (UTC). updated_at timestamptzTimestamp da última atualização (UTC). deleted_at timestamptzTimestamp de exclusão lógica, se aplicável (UTC).
Tabela: balance Coluna Tipo Descrição id textO identificador único do Saldo. organizationId uuidO identificador único da Organização. ledgerId uuidO identificador único do Ledger. accountId uuidO identificador único da Conta. alias textO alias da conta usado na operação. assetCode textO código usado para se referir ao Ativo. available textSaldo disponível anterior. onHold textValor bloqueado/reservado. version integerVersão do saldo, que é atualizada a cada transação. accountType textO tipo de conta. allowSending booleanSe verdadeiro, indica que o envio de transações é permitido. allowReceiving booleanSe verdadeiro, indica que o recebimento de transações é permitido. createdAt timestamptzTimestamp de criação (UTC). updatedAt timestamptzTimestamp da última atualização (UTC). deletedAt timestamptzTimestamp de exclusão lógica, se aplicável (UTC).
Tabela: operation-route Coluna Tipo Descrição id uuidO identificador único da Rota de Operação. organizationId uuidO identificador único da Organização. ledgerId uuidO identificador único do Ledger. title textTexto curto resumindo o propósito da operação. Usado como nota de lançamento para identificação. description textDescrição detalhada do propósito e uso da Rota de Operação. type textO tipo de operação (débito/crédito). account jsonbDefine a regra para selecionar a conta que participará da operação (débito ou crédito). createdAt timestamptzTimestamp de criação (UTC). updatedAt timestamptzTimestamp da última atualização (UTC). deletedAt timestamptzTimestamp de exclusão lógica, se aplicável (UTC).
Tabela: operation Coluna Tipo Descrição id uuidO identificador único da Rota de Transação. transactionId uuidO identificador único da Transação. organizationId uuidO identificador único da Organização. ledgerId uuidO identificador único do Ledger. accountId uuidO identificador único da conta da qual você deseja recuperar os saldos. balanceId uuidO identificador único do Saldo. accountAlias textO alias da conta usado na operação. description textDescrição da transação. type textO tipo da operação (débito ou crédito). assetCode textO nome do ativo usado na operação. chartOfAccounts text[Descontinuado] O nome do Plano de Contas ao qual a operação pertence.route textO nome do grupo do plano de contas que categoriza a operação sob um grupo específico. amount jsonbUm objeto contendo informações sobre o valor usado na operação. balance jsonbUm objeto contendo informações sobre o saldo antes da operação. balanceAfter jsonbUm objeto contendo informações sobre o saldo após a operação. status jsonbO status da transação (pending, completed, reversed). metadata jsonbPares chave-valor para adicionar como metadata. createdAt timestamptzTimestamp de criação (UTC). updatedAt timestamptzTimestamp da última atualização (UTC). deletedAt timestamptzTimestamp de exclusão lógica, se aplicável (UTC).
Campo descontinuado — Este campo ainda está presente para compatibilidade retroativa, mas não deve mais ser usado.Tabela: transaction-route Coluna Tipo Descrição id uuidO identificador único da Rota de Transação. organizationId uuidO identificador único da Organização. ledgerId uuidO identificador único do Ledger. title textTexto curto resumindo o propósito da transação. Usado como nota de lançamento para identificação. description textUma descrição para a Rota de Transação. operationRoutes arrayUma lista de IDs de Rotas de Operação que definem a lógica de débito e crédito para a transação. metadata objectPares chave-valor para adicionar como metadata. createdAt timestamptzTimestamp de criação (UTC). updatedAt timestamptzTimestamp da última atualização (UTC). deletedAt timestamptzTimestamp de exclusão lógica, se aplicável (UTC).
Tabela: transaction Coluna Tipo Descrição id uuidO identificador único da transação. organizationId uuidO identificador único da Organização. ledgerId uuidO identificador único do Ledger. description textDescrição da transação. route textO nome do grupo do plano de contas que categoriza a operação sob um grupo específico. status jsonbInformações sobre o status. amount textO valor enviado. assetCode textO código usado para se referir ao Ativo. chartOfAccountsGroupName text[Descontinuado] O nome do grupo usado para categorizar as operações de uma transação sob o mesmo grupo.source arrayA lista de contas usadas como origem. destination arrayA lista de contas usadas como destino. operations arrayA lista de operações na transação. metadata jsonbPares chave-valor para adicionar como metadata. createdAt timestamptzTimestamp de criação (UTC). updatedAt timestamptzTimestamp da última atualização (UTC). deletedAt timestamptzTimestamp de exclusão lógica, se aplicável (UTC).
Campo descontinuado — Este campo ainda está presente para compatibilidade retroativa, mas não deve mais ser usado.Modelo de dados Na Figura 1 , você pode encontrar uma representação visual das tabelas principais do Midaz e seus relacionamentos. O diagrama ajuda desenvolvedores e administradores de BD a entender como as diferentes entidades estão interconectadas dentro do sistema, servindo como guia para manipulação e integração eficientes de dados.
