Consultar um Saldo
Use este endpoint para consultar um saldo específico pelo seu identificador.
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.
Autorizações
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Cabeçalhos
O token de autorização. Este cabeçalho é obrigatório se o seu ambiente tiver Access Manager habilitado.
O tipo de mídia do recurso. O valor recomendado é application/json.
Um identificador único utilizado para rastrear e acompanhar cada requisição.
Parâmetros de caminho
O identificador único da Organização associada ao Ledger.
O identificador único do Ledger associado.
O identificador único do saldo que você deseja consultar.
Resposta
Indica que a requisição foi bem-sucedida e a resposta contém os dados esperados.
O identificador único do Saldo.
O identificador único da Organização.
O identificador único do Ledger.
O identificador único da Conta.
O alias da conta utilizada na operação.
O identificador único do saldo no contexto da conta.
O nome do ativo utilizado na operação.
Previous available balance.
Amount on hold/reserved.
Versão do saldo, que é atualizada a cada transação.
O tipo da conta.
Se verdadeiro, indica que o saldo pode ser usado para enviar transações.
Se verdadeiro, indica que o saldo pode ser usado para receber transações.
A direção contábil do saldo. Saldos credit crescem em crédito e diminuem em débito (tipo ativo); saldos debit crescem em débito e diminuem em crédito (tipo passivo). Definida na criação e imutável.
credit, debit O valor de overdraft atualmente consumido por este saldo, como string decimal. Sempre não negativo; "0" quando o saldo não tem overdraft ativo.
Configuração opcional por saldo (overdraft, escopo). null para saldos legados sem configurações personalizadas.
Visão computada do estado do saldo no momento da resposta. Sempre presente; nunca persistida. Recalculada a partir de available, onHold, overdraftUsed e settings em cada leitura.
Data e hora de criação (UTC).
Data e hora da última atualização (UTC).
Data e hora da exclusão lógica, se aplicável (UTC).
Um objeto contendo pares de chave-valor para adicionar como metadata, onde o campo name é a chave e o campo value é o valor. Por exemplo, para adicionar um Centro de Custo, use 'costCenter': 'BR_11101997'.