Skip to main content
An Account must be linked to an existing Asset. Make sure to create the Asset first before creating the Account.
To create an Account, follow these steps:
1
From the Accounts page, click the New Account button.
2
The New Account form will open on the right side of the screen with three tabs: Account Details, Portfolio, and Metadata.
3
Fill in the required information in the Account Details tab:

​
Account Details

​
name
string
required
Account Name - A descriptive name for the account (3-255 characters).Example: John Doe Checking Account, Operations Treasury
​
alias
string
Account Alias - A unique, human-readable identifier starting with @ (max 255 characters). This alias will be used to reference the account in transactions.Example: @customer_john_checking, @treasury_main
The alias cannot be changed after account creation.
​
type
string
required
Type - The account type classification. This field is required if Account Type validation is enabled for your ledger.
  • If validation is enabled and account types exist, select from the dropdown list
  • If validation is enabled but no account types exist, you must create account types first
  • If validation is disabled, enter a custom type value
Examples: checking, savings, treasury, revenue, expense
The type cannot be changed after account creation.
​
entityId
string
Entity ID - Identification number of the account holder (customer ID, business unit ID, etc.).Example: customer_123, dept_engineering, partner_acme
​
assetCode
string
required
Asset - The currency or commodity that will be operated in this account. Select from your existing assets.Examples: USD, EUR, BRL, BTC
The asset cannot be changed after account creation.
​
segmentId
string
Segment - Optional category for grouping accounts with specific characteristics (e.g., geographic region, customer tier, department).Only available if you have created segments.
​
allowSending
boolean
default:"true"
Allow Sending - Controls whether this account can send funds (debit operations).
This field is always enabled at creation time and can only be modified when editing an existing account.
​
allowReceiving
boolean
default:"true"
Allow Receiving - Controls whether this account can receive funds (credit operations).
This field is always enabled at creation time and can only be modified when editing an existing account.
4
(Optional) Switch to the Portfolio tab to link this account to a portfolio for reporting and management purposes.
  • Select a portfolio from the dropdown list
  • If no portfolios exist, you can create one first
  • Accounts can be linked or unlinked from portfolios at any time
5
(Optional) Switch to the Metadata tab to add custom key-value pairs for additional context or integration purposes.
6
Click the Save button to create the Account.

​
Quick Examples

Scenario: Create a checking account for a customer.
FieldValue
Account NameJohn Doe Checking
Account Alias@customer_123_checking
Typechecking
Entity IDcustomer_123
AssetUSD
Allow Sendingtrue
Allow Receivingtrue

​
Important Notes

The following fields are immutable after account creation:
  • Account Alias - Choose carefully as it will be used in transactions
  • Type - Cannot be reclassified once set
  • Asset Code - The account’s currency/commodity is fixed
If you need to change any of these fields, you must create a new account.
If Account Type validation is enabled for your ledger:
  • The Type field becomes required
  • You must select from predefined account types or create them first
  • This ensures consistency across your organization’s chart of accounts
See Managing Accounts for more information.
These flags control transaction permissions:
  • Allow Sending = false: Account cannot be used as a source (debit side) in transactions
  • Allow Receiving = false: Account cannot be used as a destination (credit side) in transactions
Both flags are enabled by default and can only be modified after account creation. This is useful for:
  • Freezing accounts temporarily
  • Creating receive-only accounts (e.g., escrow)
  • Creating send-only accounts (rare use case)
After creating an account, it will immediately be available for use in transactions. Make sure all the information is correct before saving, especially the immutable fields.