Retrieve Ledger Settings

Use this endpoint to retrieve the current settings of a specific Ledger. Settings control validation behavior for transactions processed within the Ledger.

GET /v1/organizations/{organization_id}/ledgers/{ledger_id}/settings

Retrieve Ledger Settings

cURL

curl --request GET \
  --url https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/settings

200

Example

{
  "accounting": {
    "validateAccountType": false,
    "validateRoutes": false
  }
}

Headers

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.

Authorization · string

Bearer JWT token for authentication. Required when PLUGIN_AUTH_ENABLED=true (enforced in multi-tenant deployments). Optional in default OSS single-tenant mode. Format: Bearer <token>

Path Parameters

organization_id · string<uuid> · required

The unique identifier of the Organization associated with the Ledger.

ledger_id · string<uuid> · required

The unique identifier of the associated Ledger.

Response

200

application/json

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

The current settings of a Ledger.

accounting · object

Accounting-related settings for the Ledger.

Show child attributes