Skip to main content
GET
Retrieve a Subledger Balance

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

Return Subledger Balance associated with this id.

Pattern: ^subledger_balance_\w+$

Response

An individual Subledger Balance object

account_id
string

Unique identifier for the account that the Subledger Balance belongs to.

Example:

"account_v9K4p2M7nL1wQ8xR5zB6tY3jH0gA"

id
string

Lead-generated unique identifier for the Subledger Balance. This ID should subsequently be used when reporting on this object in the Balance file.

Example:

"subledger_balance_k8L2n9QpW3xR5vT7mZ4jS1bA6cG"

client_subledger_balance_name
string

A name for the product or Subledger Balance being offered to the end-user (e.g., Rainy Day Fund, BNPL loan).

Example:

"Personal Loan - Home Improvement"

client_settlement_bank_account_id
string

ID of the underlying settlement bank account where funds for the Subledger Balance are held. Only applicable for certain use cases.

Example:

"12345"

currency_code
enum<string>

A three-letter currency code as defined in ISO 4217.

Available options:
USD
Example:

"USD"

created_at
string<date-time>

An ISO-8601 timestamp at which the Subledger Balance was created in Lead's system.

Example:

"2025-09-02T11:01:36Z"

updated_at
string<date-time>

An ISO-8601 timestamp at which the Subledger Balance was last updated in Lead's system.

Example:

"2025-09-02T11:05:00Z"

status
enum<string>

Status of the Subledger Balance.

Available options:
active,
inactive,
closed
Example:

"active"

status_reason
string

Reason associated with the status of the Subledger Balance.

Example:

"active"

type
enum<string>

The type of Subledger Balance.

Available options:
credit,
deposit
Example:

"credit"

metadata
object

A set of key-value pairs that can be used to store additional information related to this object.

details
Non-Revolving · object