Criar um Saldo
Use este endpoint para adicionar novos saldos a uma conta.
Cabeçalhos
O tipo de mídia do recurso. O valor recomendado é application/json.
Um identificador único utilizado para rastrear e acompanhar cada requisição.
Token JWT bearer para autenticação.
Obrigatório quando PLUGIN_AUTH_ENABLED=true (exigido em implantações multi-tenant).
Opcional no modo OSS single-tenant padrão.
Formato: Bearer <token>
Parâmetros de caminho
O identificador único da Organização associada ao Ledger.
O identificador único do Ledger associado.
O identificador único da conta.
Corpo
O identificador único do saldo no contexto da conta. Não deve conter espaços em branco. O valor "overdraft" é reservado para saldos companion gerenciados pelo sistema e não pode ser usado aqui.
100Se 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. credit (padrão) para saldos que crescem em crédito; debit para saldos que crescem em débito. Definida na criação e imutável.
credit, debit Configuração opcional por saldo. Use isto para habilitar overdraft e definir seu limite.
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.
Saldo disponível anterior.
Valor retido/reservado.
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; saldos debit crescem em débito e diminuem em crédito. 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'.
Restrições: as chaves devem ter no máximo 100 caracteres; valores de string no máximo 2000 caracteres. Objetos aninhados não são permitidos (os valores devem ser string, número ou booleano), a estrutura não pode exceder uma profundidade máxima de 10, e é permitido um máximo de 100 chaves.