Skip to main content
PUT
Set the Opening Balance for a Ledger

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

business_id
string<biz_string>
required

The id of the business

Example:

"biz_GA6EG2qFxA97NZHtxeLPUy"

ledger_id
string<ldg_string>
required

The id of the ledger

Example:

"ldg_WQMDNUHpBThYSNh4AprDBo"

Body

application/json
amount
required

The opening balance for this ledger as of the business entries start date. Positive values represent the normal balance side of the ledger, negative values represent the opposite side.

Example:

"1000.00"

currency
string | null

For a foreign-currency account, the ISO 4217 currency of original_currency_amount. Set together with original_currency_amount; omit both for a home-currency opening balance.

Required string length: 3
Example:

"CAD"

original_currency_amount

For a foreign-currency account, the opening balance in the account currency, given as a magnitude -- its balance side follows the sign of amount. Set together with currency.

Required range: x >= 0
Example:

"1000.00"

Response

Successful Response

data
LedgerOpeningBalancePublic · object
required