Esta página é para desenvolvedores e administradores de banco de dados. Ela contém esquemas de banco de dados detalhados e estruturas de tabelas. Para uma visão geral de nível de negócio das entidades do Midaz e seus relacionamentos, veja Sobre o Midaz.
Tabelas
Cada tabela permite consultas eficientes e mantém a integridade dos dados.
Tabela: organization
| Coluna | Tipo | Descrição |
|---|---|---|
| id | uuid | O identificador único da Organização. |
| legalName | text | A razão social da Organização. |
| parentOrganizationId | uuid | O identificador único da Organização pai. |
| doingBusinessAs | text | O nome fantasia da Organização. |
| legalDocument | text | O documento da Organização. |
| status | jsonb | Informações sobre o status. |
| address | jsonb | Informações sobre o endereço da Organização. |
| metadata | jsonb | Pares chave-valor para adicionar como metadata. |
| createdAt | timestamptz | Timestamp de criação (UTC). |
| updatedAt | timestamptz | Timestamp da última atualização (UTC). |
| deletedAt | timestamptz | Timestamp de exclusão lógica, se aplicável (UTC). |
Tabela: ledger
| Coluna | Tipo | Descrição |
|---|---|---|
| id | uuid | O identificador único do Ledger. |
| organizationId | uuid | O identificador único da Organização. |
| name | text | O nome do Ledger. |
| status | jsonb | Informações sobre o status. |
| metadata | jsonb | Pares chave-valor para adicionar como metadata. |
| createdAt | timestamptz | Timestamp de criação (UTC). |
| updatedAt | timestamptz | Timestamp da última atualização (UTC). |
| deletedAt | timestamptz | Timestamp de exclusão lógica, se aplicável (UTC). |
Tabela: asset
| Coluna | Tipo | Descrição |
|---|---|---|
| id | uuid | O identificador único do Ativo. |
| organizationId | uuid | O identificador único da Organização. |
| ledgerId | uuid | O identificador único do Ledger. |
| name | text | O nome do Ativo. |
| type | enum | O tipo de Ativo (currency, fiat, crypto, commodity, others). |
| code | text | O código usado para se referir ao Ativo. |
| status | text | Informações sobre o status. |
| metadata | jsonb | Pares chave-valor para adicionar como metadata. |
| createdAt | timestamptz | Timestamp de criação (UTC). |
| updatedAt | timestamptz | Timestamp da última atualização (UTC). |
| deletedAt | timestamptz | Timestamp de exclusão lógica, se aplicável (UTC). |
Tabela: account-type
| Coluna | Tipo | Descrição |
|---|---|---|
| id | uuid | O identificador único do Tipo de Conta. |
| ledgerId | uuid | O identificador único do Ledger. |
| name | text | Nome do Tipo de Conta. |
| description | text | Descrição do Tipo de Conta. |
| keyValue | text | Valor personalizado definido pelo usuário para identificar o Tipo de Conta. |
| createdAt | timestamptz | Timestamp de criação (UTC). |
| updatedAt | timestamptz | Timestamp da última atualização (UTC). |
| deletedAt | timestamptz | Timestamp de exclusão lógica, se aplicável (UTC). |
Tabela: account
| Coluna | Tipo | Descrição |
|---|---|---|
| id | uuid | O identificador único da Conta. |
| organizationId | uuid | O identificador único da Organização. |
| ledgerId | uuid | O identificador único do Ledger. |
| assetCode | text | O código usado para se referir ao Ativo. |
| name | text | O nome da Conta. |
| alias | text | Um identificador único e amigável para a conta. |
| type | text | O tipo de conta. |
| parentAccountId | uuid | O identificador único da Conta Pai. |
| entityId | text | O identificador único da Entidade responsável pela Conta. |
| portfolioId | uuid | O identificador único do Portfolio. |
| segmentId | uuid | O identificador único do Segmento. |
| status | jsonb | Informações sobre o status. |
| metadata | jsonb | Pares chave-valor para adicionar como metadata. |
| createdAt | timestamptz | Timestamp de criação (UTC). |
| updatedAt | timestamptz | Timestamp da última atualização (UTC). |
| deletedAt | timestamptz | Timestamp de exclusão lógica, se aplicável (UTC). |
Tabela: portfolio
| Coluna | Tipo | Descrição |
|---|---|---|
| id | uuid | O identificador único do Portfolio. |
| organizationId | uuid | O identificador único da Organização. |
| ledgerId | uuid | O identificador único do Ledger. |
| entityId | text | O identificador único do usuário responsável pelo Portfolio. |
| name | text | O nome do Portfolio. |
| status | jsonb | Informações sobre o status. |
| metadata | jsonb | Pares chave-valor para adicionar como metadata. |
| createdAt | timestamptz | Timestamp de criação (UTC). |
| updatedAt | timestamptz | Timestamp da última atualização (UTC). |
| deletedAt | timestamptz | Timestamp de exclusão lógica, se aplicável (UTC). |
Tabela: segment
| Coluna | Tipo | Descrição |
|---|---|---|
| id | uuid | O identificador único do Segmento. |
| organizationId | uuid | O identificador único da Organização. |
| ledgerId | uuid | O identificador único do Ledger. |
| name | text | O nome do Segmento. |
| status | jsonb | Informações sobre o status. |
| metadata | jsonb | Pares chave-valor para adicionar como metadata. |
| created_at | timestamptz | Timestamp de criação (UTC). |
| updated_at | timestamptz | Timestamp da última atualização (UTC). |
| deleted_at | timestamptz | Timestamp de exclusão lógica, se aplicável (UTC). |
Tabela: balance
| Coluna | Tipo | Descrição |
|---|---|---|
| id | text | O identificador único do Saldo. |
| organizationId | uuid | O identificador único da Organização. |
| ledgerId | uuid | O identificador único do Ledger. |
| accountId | uuid | O identificador único da Conta. |
| alias | text | O alias da conta usado na operação. |
| assetCode | text | O código usado para se referir ao Ativo. |
| available | text | Saldo disponível anterior. |
| onHold | text | Valor bloqueado/reservado. |
| version | integer | Versão do saldo, que é atualizada a cada transação. |
| accountType | text | O tipo de conta. |
| allowSending | boolean | Se verdadeiro, indica que o envio de transações é permitido. |
| allowReceiving | boolean | Se verdadeiro, indica que o recebimento de transações é permitido. |
| createdAt | timestamptz | Timestamp de criação (UTC). |
| updatedAt | timestamptz | Timestamp da última atualização (UTC). |
| deletedAt | timestamptz | Timestamp de exclusão lógica, se aplicável (UTC). |
Tabela: operation-route
| Coluna | Tipo | Descrição |
|---|---|---|
| id | uuid | O identificador único da Rota de Operação. |
| organizationId | uuid | O identificador único da Organização. |
| ledgerId | uuid | O identificador único do Ledger. |
| title | text | Texto curto resumindo o propósito da operação. Usado como nota de lançamento para identificação. |
| description | text | Descrição detalhada do propósito e uso da Rota de Operação. |
| operationType | text | operationType — a aplicabilidade da entrada: source, destination ou bidirectional. |
| account | jsonb | Define a regra para selecionar a conta que participará da operação (débito ou crédito). |
| createdAt | timestamptz | Timestamp de criação (UTC). |
| updatedAt | timestamptz | Timestamp da última atualização (UTC). |
| deletedAt | timestamptz | Timestamp de exclusão lógica, se aplicável (UTC). |
Tabela: operation
| Coluna | Tipo | Descrição |
|---|---|---|
| id | uuid | O identificador único da Operação. |
| transactionId | uuid | O identificador único da Transação. |
| organizationId | uuid | O identificador único da Organização. |
| ledgerId | uuid | O identificador único do Ledger. |
| accountId | uuid | O identificador único da conta da qual você deseja recuperar os saldos. |
| balanceId | uuid | O identificador único do Saldo. |
| accountAlias | text | O alias da conta usado na operação. |
| description | text | Descrição da transação. |
| type | text | O tipo da operação (débito ou crédito). |
| assetCode | text | O nome do ativo usado na operação. |
| chartOfAccounts | text | O nome do Plano de Contas ao qual a operação pertence. |
| route | text | [Descontinuado] Identificador de rota legado, mantido para compatibilidade retroativa. Use routeId. |
| routeId | uuid | Identificador da rota usada pela operação (o campo de rota atual). |
| amount | jsonb | Um objeto contendo informações sobre o valor usado na operação. |
| balance | jsonb | Um objeto contendo informações sobre o saldo antes da operação. |
| balanceAfter | jsonb | Um objeto contendo informações sobre o saldo após a operação. |
| status | jsonb | O status da transação (pending, completed, reversed). |
| metadata | jsonb | Pares chave-valor para adicionar como metadata. |
| createdAt | timestamptz | Timestamp de criação (UTC). |
| updatedAt | timestamptz | Timestamp da última atualização (UTC). |
| deletedAt | timestamptz | Timestamp de exclusão lógica, se aplicável (UTC). |
Tabela: transaction-route
| Coluna | Tipo | Descrição |
|---|---|---|
| id | uuid | O identificador único da Rota de Transação. |
| organizationId | uuid | O identificador único da Organização. |
| ledgerId | uuid | O identificador único do Ledger. |
| title | text | Texto curto resumindo o propósito da transação. Usado como nota de lançamento para identificação. |
| description | text | Uma descrição para a Rota de Transação. |
| operationRoutes | array | Uma lista de IDs de Rotas de Operação que definem a lógica de débito e crédito para a transação. |
| metadata | object | Pares chave-valor para adicionar como metadata. |
| createdAt | timestamptz | Timestamp de criação (UTC). |
| updatedAt | timestamptz | Timestamp da última atualização (UTC). |
| deletedAt | timestamptz | Timestamp de exclusão lógica, se aplicável (UTC). |
Tabela: transaction
| Coluna | Tipo | Descrição |
|---|---|---|
| id | uuid | O identificador único da transação. |
| organizationId | uuid | O identificador único da Organização. |
| ledgerId | uuid | O identificador único do Ledger. |
| description | text | Descrição da transação. |
| route | text | [Descontinuado] Identificador de rota legado, mantido para compatibilidade retroativa. Use routeId. |
| routeId | uuid | Identificador da rota usada pela transação (o campo de rota atual). |
| status | jsonb | Informações sobre o status. |
| amount | text | O valor enviado. |
| assetCode | text | O código usado para se referir ao Ativo. |
| chartOfAccountsGroupName | text | O nome do grupo do plano de contas usado para categorizar as operações de uma transação. |
| source | array | A lista de contas usadas como origem. |
| destination | array | A lista de contas usadas como destino. |
| operations | array | A lista de operações na transação. |
| metadata | jsonb | Pares chave-valor para adicionar como metadata. |
| createdAt | timestamptz | Timestamp de criação (UTC). |
| updatedAt | timestamptz | Timestamp da última atualização (UTC). |
| deletedAt | timestamptz | Timestamp de exclusão lógica, se aplicável (UTC). |
Modelo de dados
A Figura 1 mostra as principais tabelas do Midaz e seus relacionamentos. O diagrama ajuda desenvolvedores e administradores de banco de dados a ver como as entidades se conectam dentro do sistema. Use-o como guia para o tratamento e a integração de dados.
Figura 1. Tabelas do Midaz e seus relacionamentos.