Ledger balances

Historical balances

Retrieve accurate historical balance information with the TypeScript SDK.

GET/balances/{balance_id}/at

Use blnk.LedgerBalances.getAt to retrieve a balance at a specific point in time.

Call the method

const response = await blnk.LedgerBalances.getAt(
  'bln_5ce86029-3c2e-4e2a-aae2-7fb931ca4c4f',
  {
    timestamp: '2025-02-24T08:55:26Z',
  },
);

Field	Type	Description
`balanceId`	`string`	Balance ID to query.
`timestamp`	`string`	Specifies the exact date and time for which a historical balance is requested. Use ISO 8601 format (for example `2025-02-24T08:55:26Z`).
`from_source`	`boolean`	When `true`, reconstruct from transactions instead of snapshots.

Use the historical amounts

Read response.data.balance for net, credit, and debit totals at the requested timestamp. Compare with current balance if you are auditing or reconciling.

Response

{
  "timestamp": "2025-02-24T08:55:26Z",
  "from_source": false,
  "balance": {
    "balance_id": "bln_5ce86029-3c2e-4e2a-aae2-7fb931ca4c4f",
    "balance": 5000,
    "credit_balance": 5000,
    "debit_balance": 0,
    "currency": "USD"
  }
}

Field	Type	Description
`timestamp`	`string`	Point in time you queried (ISO 8601).
`from_source`	`boolean`	Whether the balance was reconstructed from transactions.
`balance.balance_id`	`string`	Balance you queried.
`balance.balance`	`number`	Net amount at that timestamp.
`balance.credit_balance`	`number`	Total credits at that timestamp.
`balance.debit_balance`	`number`	Total debits at that timestamp.
`balance.currency`	`string`	Currency of the balance.