Skip to main content
PATCH
/
v1
/
organizations
/
{organization_id}
/
ledgers
/
{ledger_id}
/
balances
/
{balance_id}
curl --request PATCH \
  --url https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/balances/{balance_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "allowSending": true,
  "allowReceiving": true
}
'
{
  "id": "019c96a0-0c0d-7915-84b9-e497bfee9916",
  "organizationId": "019c96a0-0a98-7287-9a31-786e0809c769",
  "ledgerId": "019c96a0-0ac0-7de9-9f53-9cf842a2ee5a",
  "accountId": "019c96a0-0c0c-7221-8cf3-13313fb60081",
  "alias": "customer-brl-1",
  "key": "default",
  "assetCode": "BRL",
  "available": "1000",
  "onHold": "0",
  "version": 1,
  "accountType": "deposit",
  "allowSending": true,
  "allowReceiving": true,
  "direction": "credit",
  "overdraftUsed": "0",
  "settings": {
    "allowOverdraft": true,
    "overdraftLimitEnabled": true,
    "overdraftLimit": "5000.00",
    "balanceScope": "transactional"
  },
  "position": {
    "available": "1000",
    "onHold": "0",
    "overdraftLimitAvailable": "5000.00"
  },
  "createdAt": "2026-02-25T21:06:37.197596Z",
  "updatedAt": "2026-02-25T21:06:38.420934Z",
  "deletedAt": null
}

Documentation Index

Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

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

Headers

​
Authorization
string

The authorization token. This header is required if your environment has Access Manager enabled.

​
Content-Type
string

The type of media of the resource. Recommended value is application/json.

​
X-Request-Id
string<uuid>

A unique identifier used to trace and track each request.

Path Parameters

​
organization_id
string
required

The unique identifier of the Organization associated with the Ledger.

​
ledger_id
string
required

The unique identifier of the associated Ledger.

​
balance_id
string
required

The unique identifier of the balance that you want to retrieve.

Body

application/json
​
allowSending
boolean

If true, indicates that the balance can be used to send transactions.

​
allowReceiving
boolean

If true, indicates that the balance can be used to receive transactions.

​
settings
object

When provided, replaces the existing settings in full. Use this to toggle allowOverdraft or adjust overdraftLimit. Direction cannot be changed via update — it is immutable after creation.

Response

Indicates that the request was successful and the response contains the expected data.

​
id
string

The unique identifier of the Balance.

​
organizationId
string<uuid>

The unique identifier of the Organization.

​
ledgerId
string<uuid>

The unique identifier of the Ledger.

​
accountId
string<uuid>

The unique identifier of the Account.

​
alias
string

The alias for the account used in the operation.

​
key
string

The unique identifier for the balance in the context of the account.

​
assetCode
string

The name of the asset used in the operation.

​
available
string

Previous available balance.

​
onHold
string

Amount on hold/reserved.

​
version
integer

Balance version, which is updated with each transaction.

​
accountType
string

The type of account.

​
allowSending
boolean

If true, indicates that the balance can be used to send transactions.

​
allowReceiving
boolean

If true, indicates that the balance can be used to receive transactions.

​
direction
enum<string>

The accounting direction of the balance. credit balances grow on credit and shrink on debit (asset-like); debit balances grow on debit and shrink on credit (liability-like). Set at creation and immutable.

Available options:
credit,
debit
​
overdraftUsed
string

The amount of overdraft currently consumed by this balance, as a decimal string. Always non-negative; "0" when the balance has no overdraft active.

​
settings
object

Optional per-balance configuration (overdraft, scope). null for legacy balances without custom settings.

​
position
object
read-only

Computed view of the balance state at response time. Always present; never persisted. Re-derived from available, onHold, overdraftUsed, and settings on every read.

​
createdAt
string<date-time>

Timestamp of creation (UTC).

​
updatedAt
string<date-time>

Timestamp of last update (UTC).

​
deletedAt
string<date-time> | null

Timestamp of soft deletion, if applicable (UTC).

​
metadata
object

An object containing key-value pairs to add as metadata, where the field name is the key and the field value is the value. For example, to add a Cost Center, use 'costCenter': 'BR_11101997'.