Ledger balances

Create new balance

Create a new ledger balance with the Go SDK.

POST/balances

Use client.LedgerBalance.Create to create a balance on an existing ledger.

Call the method

balance, _, _ := client.LedgerBalance.Create(blnkgo.CreateLedgerBalanceRequest{
	LedgerID: "ldg_049495c6-356e-4ebc-a45e-60d1e1e16afb",
	Currency: "USD",
})

Field	Type	Description
`LedgerID`	`string`	Ledger the balance belongs to.
`Currency`	`string`	Currency or asset class for the balance.
`IdentityID`	`string`	Identity to link to the balance. Required when `TrackFundLineage` is `true`.
`TrackFundLineage`	`bool`	Enable fund lineage tracking on this balance.
`AllocationStrategy`	`AllocationStrategy`	How tagged provider funds are allocated on spend: `FIFO`, `LIFO`, or `PROPORTIONAL`.
`MetaData`	`MetaData`	Optional metadata for extra context.

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

balance, _, _ := client.LedgerBalance.Create(blnkgo.CreateLedgerBalanceRequest{
	LedgerID:  "general_ledger_id",
	Currency:  "USD",
	Indicator: "@Revenue",
})

Field	Type	Description
`LedgerID`	`string`	Must be `general_ledger_id`. `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.

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.

Go response (`*blnkgo.LedgerBalance`)

Field	Type	Description
`BalanceID`	`string`	Unique ID for the balance. Use as `source` or `destination` on transactions.
`LedgerID`	`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`	`*big.Int`	Current net amount in the balance.
`CreatedAt`	`time.Time`	Date and time the balance was created.
`MetaData`	`MetaData`	Optional metadata object.

Create new balance

Go response (*blnkgo.LedgerBalance)

Go response (`*blnkgo.LedgerBalance`)