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.

Accounting Routes are created through a guided 3-step wizard that walks you through defining the transaction route, configuring operation routes with accounting scenarios, and reviewing the final configuration.

Before you start


Create the Account Types and Accounts that the route will validate. If you are still deciding between Source, Destination, Bidirectional, Account Type validation, alias validation, Direct, Two-Step, or Reversal scenarios, read Understanding Accounting Routes first.
If Validate Routes is enabled for the Ledger, transactions must match an existing route. Do not enable route validation until the required Accounting Routes are ready.

Step 1: Basic information


1
From the Accounting Routes page, click New Route.
2
The creation wizard opens on Step 1 — Basic information.
3
Fill in the basic information:
  • Title: a descriptive name for this transaction route.
  • Description: an optional description of the route’s purpose.
4
Click Next to proceed to Step 2.

Step 2: Operation Routes


In this step, you add and configure the operation routes that define how accounts are validated and how accounting entries are recorded.
1
Click Add Operation Route to create your first operation route card.
2
Configure the operation route:
  • Description: the purpose of this operation route.
  • Operation Type: Source, Destination, or Bidirectional.
  • Validation Type: Account Type, @Alias, or empty when no account validation is needed.
  • Account Type or Alias: the selected Account Type values or the specific account alias.
3
(Optional) Configure Accounting Scenarios to define how entries are recorded. Toggle on the scenarios you need:
Standard one-step transaction. Define the Account Code and Description for:
  • Debit — The account code debited on execution
  • Credit — The account code credited on execution
For Direct Transactions, which sides appear depends on the operation type. Source routes show debit only, destination routes show credit only, and bidirectional routes show both. Other scenarios may differ — see the Two-Step Transaction tab for details.
4
(Optional) Click Add Operation Route again to add more operation routes to this Accounting Route.
You must add at least one source and one destination operation route, or at least one bidirectional route. The wizard will not proceed without a valid route configuration.
5
Click Next to proceed to Step 3.

Step 3: Review


1
Review the complete configuration:
  • Transaction route title and description
  • Each operation route with its type, validation rules, and accounting entries
  • Accounting scenarios with debit and credit entries per transaction type
2
If anything needs to be adjusted, click Previous to go back.
3
Click Create Transaction Route to create the Accounting Route.

Field guide


Basic information

FieldWhat to enterExample
Route TitleRequired route name. Keep it short and specific to the business flow.Pix Transfer Route
DescriptionOptional explanation of what the route validates or records.Handles Pix transfers between customer accounts.

Operation route

FieldWhat to enterExample
DescriptionPurpose of this operation route card.Checking account validation for Pix
TypeAccounting side this operation route applies to: Source, Destination, or Bidirectional. This cannot be changed after creation.Bidirectional
Validation TypeHow accounts are validated. Use Account Type for account classes or @Alias for a specific account. Leave empty only when no validation is needed.Account Type
Account Type or AliasAccount Types or aliases accepted by this operation route.customer
Accounting ScenariosTransaction scenarios this route should record: Direct, Two-Step, or Reversal.Direct Transaction
Account CodeAccounting code used in the debit or credit entry for the selected scenario.1.1.1.001
Entry DescriptionEntry-level description shown in the scenario configuration.Customer checking - outbound

Quick example


Transaction Route
FieldValue
TitlePix Transfer Route
DescriptionHandles Pix instant transfers between checking accounts
Operation Route 1 — Bidirectional
FieldValue
DescriptionChecking account validation for Pix
Operation TypeBidirectional
Validation TypeAccount Type
Account Typeschecking
Direct Transaction scenario
SideAccount CodeDescription
Debit1.1.1.001Customer checking — outbound
Credit1.1.1.002Customer checking — inbound
Two-Step Transaction — Hold
SideAccount CodeDescription
Debit1.1.1.001Customer checking — reserve
Credit2.1.1.001Pending settlement — hold
Two-Step Transaction — Commit
SideAccount CodeDescription
Debit2.1.1.001Pending settlement — release
Credit1.1.1.002Customer checking — settled

What to do next


After creating the route, create a transaction that matches the same account types, aliases, and scenario in Creating a Transaction.

Create Transaction Route

Create the transaction-level route via API.

Create Operation Route

Create operation-level routing rules via API.