Ledger balances

Create new balance

Create a new ledger balance with the TypeScript SDK.

POST/balances

Use blnk.LedgerBalances.create to create a balance on an existing ledger.

Call the method

const response = await blnk.LedgerBalances.create({
  ledger_id: 'ldg_049495c6-356e-4ebc-a45e-60d1e1e16afb',
  currency: 'USD',
});

Field	Type	Description
`ledger_id`	`string`	Ledger the balance belongs to.
`currency`	`string`	Currency or asset class for the balance.
`identity_id`	`string`	Identity to link to the balance. Required when `track_fund_lineage` is `true`.
`track_fund_lineage`	`boolean`	Enable fund lineage tracking on this balance.
`allocation_strategy`	`string`	How tagged provider funds are allocated on spend: `FIFO`, `LIFO`, or `PROPORTIONAL`.
`meta_data`	`Record<string, unknown>`	Optional metadata for extra context.

Create an internal balance yourself instead of waiting for the first @ reference on a transaction. See Internal balances.

const response = await blnk.LedgerBalances.create({
  ledger_id: 'general_ledger_id',
  currency: 'USD',
  indicator: '@Revenue',
});

Field	Type	Description
`ledger_id`	`"general_ledger_id"`	Must be the General Ledger. `indicator` is only allowed on this ledger.
`indicator`	`string`	Must start with `@` and contain no whitespace. The same indicator and currency pair can only exist once.

Needs Core 0.15.3. A duplicate returns 409.

Save the balance ID

Use response.data.balance_id as the source or destination on transactions, or when creating balance monitors.

Response

{
  "balance": 0,
  "inflight_balance": 0,
  "credit_balance": 0,
  "inflight_credit_balance": 0,
  "debit_balance": 0,
  "inflight_debit_balance": 0,
  "ledger_id": "ldg_049495c6-356e-4ebc-a45e-60d1e1e16afb",
  "identity_id": "",
  "balance_id": "bln_5ce86029-3c2e-4e2a-aae2-7fb931ca4c4f",
  "currency": "USD",
  "created_at": "2024-11-26T08:36:36.238244338Z",
  "meta_data": null
}

{
  "balance": 0,
  "inflight_balance": 0,
  "credit_balance": 0,
  "inflight_credit_balance": 0,
  "debit_balance": 0,
  "inflight_debit_balance": 0,
  "ledger_id": "general_ledger_id",
  "indicator": "@Revenue",
  "identity_id": "",
  "balance_id": "bln_a7c3e91f-2d48-4b1a-9e6c-5f8d2a1b4c70",
  "currency": "USD",
  "created_at": "2024-11-26T08:36:36.238244338Z",
  "meta_data": null
}

You can now use @Revenue as source or destination.

Field	Type	Description
`balance_id`	`string`	Unique ID for the balance. Use as `source` or `destination` on transactions.
`ledger_id`	`string`	Ledger ID you passed in the request.
`indicator`	`string`	Set when you created a General Ledger balance with `indicator`.
`currency`	`string`	Currency you passed in the request.
`balance`	`number`	Current net amount in the balance.
`created_at`	`string`	Date and time the balance was created.