Skip to main content

Account Configuration

This guide covers Allowed Accounts within a product: defining account slugs, asset groups, reporting heads, account classes, asset type selection, and transaction controls.


Allowed Accounts Overview

Each product defines one or more allowed accounts — the sub-account structures available when a product account is created. For example, the customer product may define primary and processing_fee accounts, while user_holdings defines a main account.

The List of Accounts table appears in the main panel of the product editor, below Product Name.


Account Row Fields

FieldDescription
SlugUnique account identifier within the product (for example, main, primary, processing_fee, test).
Asset GroupAsset category for the account (for example, Currency). Selected from a dropdown.
Default Reporting HeadReporting hierarchy path, typically auto-generated as <product>.<slug> (for example, user_holdings.main, customer.primary). Use the sync icon to refresh the value.
Account ClassAccounting classification for the account.
Cash EquivalentToggle indicating whether the account is treated as a cash equivalent for reporting.
ConfigurationSummary of linked assets and parameters (for example, 1 Assets, 0 Params).
ActionsRow-level icons for sync, duplicate, settings, and delete.

Account Classes

The Account Class dropdown supports the following values:

ClassDescription
EQUITYEquity accounts
LIABILITIESLiability accounts
ASSETSAsset accounts
EXPENDITUREExpense accounts
INCOMEIncome accounts
CONTRAContra accounts
OFF_BALANCE_SHEETOff-balance-sheet accounts

Select the class that matches the accounting treatment for the account slug. For example, user_holdings.main uses EQUITY, while customer.primary uses LIABILITIES.


Adding an Allowed Account

  1. Open the product editor for the target product.
  2. In Allowed Accounts, click + New.
  3. Enter a Slug (for example, main or test).
  4. Select an Asset Group from the dropdown.
  5. Verify or edit the Default Reporting Head.
  6. Select the Account Class.
  7. Toggle Cash Equivalent if applicable.
  8. Configure asset types using the settings flow below.
  9. Save the row.

Selecting Asset Types

After defining an account row, configure which asset types are permitted for that account.

Configuration Procedure

  1. In the account row Actions column, click the Settings (gear) icon, or click the Configuration summary link.
  2. The Select Asset Type dialog opens.
  3. Under Choose Applicable Asset Groups, select the asset group (for example, Currency).
  4. Under Select Applicable Asset Type, check the asset types to allow:
    • For example, defaultNpr (Currency) or rewardPoint (Currency).
  5. Optionally enable Allow create ledgers in products to permit ledger creation under this product account.
  6. Click Confirm Selection.
  7. The Configuration column updates to reflect the number of assets linked (for example, 1 Assets, 0 Params).

Important Notes

  • At least one asset type must be selected for accounts that will hold balances.
  • Asset groups and types are maintained under Configurations → Asset Groups.
  • The Allow create ledgers in products option controls whether new ledgers can be provisioned automatically for this account.

Account Row Actions

IconDescription
SyncRefreshes the default reporting head or re-syncs configuration.
DuplicateCreates a copy of the account row for quick setup of similar accounts.
Settings (gear)Opens asset type selection and account-level configuration.
DeleteRemoves the account row from the product.

Transaction Controls

Transaction controls define debit/credit limits, balance bounds, and time-based transaction counters for a specific account ledger. Access them from the account settings flow or navigate directly when configuring ledger behavior.

Opening Transaction Control Configuration

  1. From an allowed account row, open account settings.
  2. Navigate to New Transaction Control (URL pattern: /products/transaction/add?productId=<product>&modelId=<product>.<slug>&modelType=LEDGER).

Transaction Control Fields

FieldDescription
Is ActiveEnables or disables the control (YES / NO).
Transaction TypeApplies the control to Debit or Credit transactions.
Max Dr AmountMaximum single debit transaction amount.
Min Dr AmountMinimum single debit transaction amount.
Max Dr BalanceMaximum allowed debit balance.
Min Dr BalanceMinimum allowed debit balance.
Select Transaction ControlsTime intervals for counter-based limits: Year, Month, Week, Day, Hour, Minute. Multiple intervals can be selected.

Transaction Control Counter

When a time interval is selected, configure counters for that period:

FieldDescription
Dr CountMaximum number of debit transactions in the interval.
Cr CountMaximum number of credit transactions in the interval.
All CountMaximum total transactions in the interval.
Dr All AmountMaximum total debit amount in the interval.
Cr All AmountMaximum total credit amount in the interval.

Creating a Transaction Control

  1. Set Is Active to YES.
  2. Select Transaction Type (Debit or Credit).
  3. Enter amount and balance limits as required.
  4. Select one or more intervals under Select Transaction Controls.
  5. Enter counter values for each applicable interval.
  6. Click + Create Transaction Control.

Important Notes

  • Transaction controls are enforced at the ledger level for the specific product account slug.
  • Configure separate controls for debit and credit if both directions need limits.
  • Test controls in a non-production environment before applying to live products.

Example Configurations

user_holdings Product

SlugAsset GroupReporting HeadAccount ClassCash Equivalent
mainCurrencyuser_holdings.mainEQUITYNo
testCurrencyuser_holdings.testEQUITYYes

Asset type: defaultNpr (Currency) selected for the main account.

customer Product

SlugAsset GroupReporting HeadAccount Class
primarycustomer.primaryLIABILITIES
processing_feecustomer.processing_feeLIABILITIES

The customer product also defines 15 free-text mappings for KYC and contact fields (see Configuring Products).


Integration with Process Workflows

Product accounts configured here are referenced throughout process execution:

Process SettingUsage
Account Stage → Product IDSelects which product template to use when creating accounts.
Journal Stage → Product SlugRoutes journal entries to product-specific GL accounts.
Stage → Product Configuration → ProductsRestricts a process stage to specific products.
Update Account Stage → Product AccountTargets an existing account within the product configuration.

For process stage details, see Building a New Process.