Saltar al contenido principal
PATCH

Encabezados

Content-Type
string

El tipo de medio del recurso. El valor recomendado es application/json.

X-Request-Id
string<uuid>

Un identificador único utilizado para rastrear y seguir cada solicitud.

Authorization
string

Token JWT bearer para autenticación. Requerido cuando PLUGIN_AUTH_ENABLED=true (obligatorio en despliegues multiinquilino). Opcional en el modo OSS de inquilino único predeterminado. Formato: Bearer <token>

Parámetros de ruta

organization_id
string<uuid>
requerido

El identificador único de la Organización asociada al Ledger.

ledger_id
string<uuid>
requerido

El identificador único del Ledger asociado.

balance_id
string<uuid>
requerido

El identificador único del saldo que desea recuperar.

Cuerpo

application/json
allowSending
boolean

Si es verdadero, indica que el saldo puede ser utilizado para enviar transacciones.

allowReceiving
boolean

Si es verdadero, indica que el saldo puede ser utilizado para recibir transacciones.

settings
object

Cuando se proporciona, reemplaza las configuraciones existentes en su totalidad. Use esto para alternar allowOverdraft o ajustar overdraftLimit. La dirección no puede cambiarse vía update — es inmutable después de la creación.

Respuesta

Indica que la solicitud fue exitosa y la respuesta contiene los datos esperados.

id
string

El identificador único del Saldo.

organizationId
string<uuid>

El identificador único de la Organización.

ledgerId
string<uuid>

El identificador único del Ledger.

accountId
string<uuid>

El identificador único de la Cuenta.

alias
string

El alias de la cuenta utilizada en la operación.

key
string

El identificador único del saldo en el contexto de la cuenta.

assetCode
string

El nombre del activo utilizado en la operación.

available
string

Saldo disponible anterior.

onHold
string

Monto retenido/reservado.

version
integer

Versión del saldo, que se actualiza con cada transacción.

accountType
string

El tipo de cuenta.

allowSending
boolean

Si es verdadero, indica que el saldo puede ser utilizado para enviar transacciones.

allowReceiving
boolean

Si es verdadero, indica que el saldo puede ser utilizado para recibir transacciones.

direction
enum<string>

La dirección contable del saldo. Saldos credit crecen en crédito y disminuyen en débito; saldos debit crecen en débito y disminuyen en crédito. Definida en la creación e inmutable.

Opciones disponibles:
credit,
debit
overdraftUsed
string

La cantidad de overdraft actualmente consumida por este saldo, como string decimal. Siempre no negativa; "0" cuando el saldo no tiene overdraft activo.

settings
object

Configuración opcional por saldo (overdraft, alcance). null para saldos legados sin configuraciones personalizadas.

position
object
read-only

Vista computada del estado del saldo en el momento de la respuesta. Siempre presente; nunca persistida. Recalculada a partir de available, onHold, overdraftUsed y settings en cada lectura.

createdAt
string<date-time>

Fecha y hora de creación (UTC).

updatedAt
string<date-time>

Fecha y hora de la última actualización (UTC).

deletedAt
string<date-time> | null

Fecha y hora de la eliminación lógica, si aplica (UTC).

metadata
object

Un objeto que contiene pares clave-valor para agregar como metadatos, donde el campo name es la clave y el campo value es el valor. Por ejemplo, para agregar un Centro de Costo, use 'costCenter': 'BR_11101997'.

Restricciones: las claves deben tener como máximo 100 caracteres; los valores de cadena de texto, como máximo 2000 caracteres. No se permiten objetos anidados (los valores deben ser cadena de texto, número o booleano), la estructura no puede exceder una profundidad máxima de 10, y se permite un máximo de 100 claves.