Skip to main content

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.

A Ledger is the accounting workspace where Assets, Accounts, Routes, and Transactions are isolated. Create a new Ledger when you need a separate balance domain, product line, environment, or accounting model.

​
Before you start

You need an existing Organization. If this is the first setup, create the Organization first in Creating an Organization. Decide what the Ledger boundary means before creating it. Avoid using one Ledger for unrelated products if they require different account structures, routes, or operational controls.

​
Create the Ledger

1
From the Ledgers page, click the New Ledger button in the top-right corner.
2
The New Ledger form will appear.
3
In the Ledger Details tab, enter the Ledger name in the Ledger Name field.
4
(Optional) To include metadata, select the Metadata tab. This will display two fields: Key and Value.
  • To add more metadata, click the plus (+) icon next to the first row.
5
(Optional) Select the Settings tab to configure validation rules for this Ledger.
  • Enable Validate Account Type if Accounts must use registered Account Types.
  • Enable Validate Routes if Transactions must follow pre-configured Accounting Routes.
6
After completing the form, click Save.
7
A success message will appear in the top-right corner of the screen, and the new Ledger will be added to the list on the main Ledgers page.

​
Field guide

FieldWhat to enterExample
Ledger NameA clear name for the accounting workspace. Use a name that shows the product, country, environment, or business boundary.Brazil Payments Ledger
Metadata KeyOptional classification or integration field name.environment
Metadata ValueValue for the metadata key.production
Validate Account TypeOptional setting. Turn on when every Account in this Ledger must use a previously registered Account Type. Leave off if you will not classify Accounts by type yet.Enabled
Validate RoutesOptional setting. Turn on only after the Accounting Routes for this Ledger are planned or configured, because Transactions must match a valid route when this is enabled.Disabled
The fields in the Metadata tab are open. There are no predefined keys or values. Use consistent key names across your Organization, such as environment, businessLine, or region, so you can filter and audit Ledgers later.

​
Ledger settings

The Settings tab controls validation rules for the Ledger you are creating.

​
Validate Account Type

When this setting is enabled, every new Account in this Ledger must use an Account Type that was previously registered for the Ledger. Enable it when you want operators to classify Accounts consistently, such as customer, merchant, treasury, or fee.
After Validate Account Type is enabled, Accounts without a valid Account Type will be rejected.

​
Validate Routes

When this setting is enabled, Transactions must match the Accounting Routes configured for this Ledger. Enable it only when your route model is already planned or configured.
If Validate Routes is enabled before routes exist, Transactions that do not match an available route will fail validation.

​
What to do next

After creating the Ledger:
  1. Review whether Validate Account Type and Validate Routes are correct for this Ledger.
  2. Create at least one Asset in Creating an Asset.
  3. If you need to change the validation rules later, use the Settings tab described in Managing Ledgers.

API equivalent

Create a Ledger endpoint