> ## 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.

# Operações de ledger

> Consulte os campos de operações do Ledger do Midaz: saldos, rotas de transação, rotas de operação e índices de metadados usados em lançamentos.

Esta página cobre os campos específicos das operações de ledger do Midaz, incluindo saldos, rotas de transação, rotas de operação e índices de metadados.

## 1. Saldos

***

| Campo | Descrição | Usado em |
| - | - | - |
| key | Identificador único do saldo no contexto da conta | Midaz |
| available | Valor disponível para transações | Midaz |
| onHold | Valor atualmente reservado ou retido | Midaz |
| version | Versão do saldo, atualizada a cada transação (para concorrência otimista) | Midaz |
| accountType | Tipo de conta que mantém esse saldo | Midaz |
| allowSending | Indica se o saldo pode ser usado para enviar transações | Midaz |
| allowReceiving | Indica se o saldo pode ser usado para receber transações | Midaz |
| assetCode | Código do ativo ou da moeda (por exemplo, BRL, USD) | Midaz |
| alias | Alias da conta para identificação rápida | Midaz |

## 2. Rotas de transação

***

| Campo | Descrição | Usado em |
| - | - | - |
| title | Texto curto que resume o propósito da rota (máximo de 255 caracteres) | Midaz |
| description | Descrição detalhada da rota de transação (máximo de 250 caracteres) | Midaz |
| operationRoutes | Em requisições, array de IDs de rotas de operação que definem a lógica de origem e destino; em respostas, array de objetos `OperationRoute` | Midaz |

## 3. Rotas de operação

***

| Campo | Descrição | Usado em |
| - | - | - |
| operationType | Direção da rota: origem, destino ou bidirecional | Midaz |
| code | Código de referência externa da rota de operação | Midaz |
| account | Regra de seleção de conta para a operação | Midaz |
| ruleType | Método de seleção de conta: alias ou account\_type | Midaz |
| validIf | Condição que deve ser satisfeita para que a regra corresponda | Midaz |

## 4. Índices de metadados

***

| Campo | Descrição | Usado em |
| - | - | - |
| metadataKey | Chave de metadado a ser indexada (máximo de 100 caracteres, deve corresponder ao nome do campo nas entidades) | Midaz |
| unique | Indica se o índice impõe exclusividade (valores duplicados são rejeitados quando verdadeiro) | Midaz |
| sparse | Indica se o índice é esparso (indexa apenas entidades que contêm o campo) | Midaz |
| indexName | Nome do índice criado | Midaz |
| entityName | Nome da coleção de entidades à qual o índice se aplica | Midaz |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.