Skip to main content
POST
/
v1
/
organizations
/
{organization_id}
/
ledgers
Create a Ledger
curl --request POST \
  --url https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Primary Ledger",
  "status": {
    "code": "ACTIVE",
    "description": "Default production ledger for financial operations"
  },
  "metadata": {
    "environment": "production",
    "region": "us-east-1",
    "businessDomain": "retail_banking",
    "supportedInstruments": [
      "deposit_accounts",
      "pix_transfers",
      "internal_transfers"
    ],
    "multiCurrency": false,
    "createdBy": "system",
    "notes": "Primary ledger used for customer accounts and daily settlement"
  }
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "status": "<unknown>",
  "metadata": {},
  "settings": {
    "accounting": {
      "validateAccountType": true,
      "validateRoutes": true
    }
  },
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "deletedAt": "2023-11-07T05:31:56Z"
}

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.

Body

application/json
​
name
string
required

The name of the Ledger.

Maximum string length: 256
​
status
object

An object containing information about the status. Important: If not provided, the default status will be 'ACTIVE'.

​
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'.

​
settings
object

Optional dynamic configuration settings for the Ledger. When omitted, default values are applied (all validation flags disabled).

Response

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

​
id
string<uuid>

The unique identifier of the Ledger.

​
organizationId
string<uuid>

The unique identifier of the Organization.

​
name
string

The name of the Ledger.

Maximum string length: 256
​
status
any
​
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'.

​
settings
object

The current settings of a Ledger.

​
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).