Saltar al contenido principal
GET
/
v1
/
organizations
/
{organization_id}
/
ledgers
/
{ledger_id}
/
balances
/
{balance_id}
/
history
Consultar historial de saldo
curl --request GET \
  --url https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/balances/{balance_id}/history \
  --header 'Authorization: Bearer <token>'
{ "id": "019c96a0-0c0d-7915-84b9-e497bfee9916", "organizationId": "019c96a0-0a98-7287-9a31-786e0809c769", "ledgerId": "019c96a0-0ac0-7de9-9f53-9cf842a2ee5a", "accountId": "019c96a0-0c0c-7221-8cf3-13313fb60081", "alias": "@conta_corrente", "key": "default", "assetCode": "BRL", "available": "150000", "onHold": "25000", "version": 42, "accountType": "deposit", "direction": "credit", "overdraftUsed": "0", "settings": null, "position": { "available": "150000", "onHold": "25000", "overdraftLimitAvailable": "0" }, "createdAt": "2025-06-01T10:00:00Z", "updatedAt": "2026-01-15T10:30:00Z" }

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.

Autorizaciones

Authorization
string
header
requerido

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Encabezados

Authorization
string

El token de autorización. Este encabezado es requerido si su entorno tiene Access Manager habilitado.

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.

Parámetros de ruta

organization_id
string
requerido

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

ledger_id
string
requerido

El identificador único del Ledger asociado.

balance_id
string
requerido

El identificador único del saldo que desea recuperar.

Parámetros de consulta

date
string
requerido

La fecha y hora para consultar el estado del saldo. Formato: yyyy-mm-dd hh:mm:ss (ej.: 2026-01-15 10:30:00).

Pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$

Respuesta

Indica que la solicitud fue exitosa y la respuesta contiene el estado del saldo en el momento especificado.

El estado de un saldo en un momento específico del pasado. No incluye los campos allowSending y allowReceiving.

id
string<uuid>

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 (ej., @conta_corrente).

key
string

La clave única del saldo en el contexto de la cuenta (ej., default, asset-freeze).

assetCode
string

El código del activo (ej., BRL, USD).

available
string

El saldo disponible en el momento consultado. Representado como una cadena decimal con precisión arbitraria (ej., "1500.75").

onHold
string

El saldo retenido (reservado) en el momento consultado. Representado como una cadena decimal con precisión arbitraria (ej., "1500.75").

version
integer

La versión del saldo en el momento consultado.

accountType
string

El tipo de la cuenta (ej., deposit, creditCard).

direction
enum<string>

La dirección contable del saldo en el momento consultado.

Opciones disponibles:
credit,
debit
overdraftUsed
string

La cantidad de overdraft consumida en el momento consultado, como string decimal. Siempre no negativa.

settings
object

Snapshot de la configuración por saldo en el momento consultado. null para saldos legados sin configuraciones personalizadas.

position
object
read-only

Vista computada del estado del saldo en el momento consultado. Siempre presente; nunca persistida. Refleja la misma forma que la posición del saldo en vivo, así que las respuestas históricas llevan la misma estructura de wire que las lecturas en vivo.

createdAt
string<date-time>

Timestamp de creación del saldo (UTC).

updatedAt
string<date-time>

Timestamp de última actualización en el momento consultado (UTC).