Creating a Segment

Create a new Segment in the Console to classify Accounts by shared characteristics, business rules, or reporting needs across your Ledger.

A Segment classifies Accounts by shared characteristics or business rules.

Before you start

---

You need an existing Organization and Ledger. Create a Segment when a group of Accounts needs a shared classification for reporting, filtering, or fee rules.

Create the Segment

---

To create a Segment, follow these steps:

1. From the Segments page, click the New Segment button.

2. The New Segment form opens on the right side of the screen.

3. In the Segment Details tab, enter the Segment Name.

4. (Optional) Select the Metadata tab to add metadata.

5. When the details are complete, click the Save button.

6. The Segment appears in the list of Segments for your Ledger.

Field guide

---

Field	What to enter	Example
Segment Name	Required name for a group of Accounts with shared characteristics or rules.	Retail Customers
Metadata Key	Optional classification or integration field name.	region
Metadata Value	Value for the metadata key.	BR-SP

The Metadata fields have no predefined keys or values. Use consistent key names across your Organization, such as region, businessLine, or channel. Consistent keys keep Segments useful for filtering and reporting.

What to do next

---

After you create the Segment, link it to Accounts from Adding Segment to Account. You can also create Accounts that belong to it in Creating an Account.

API equivalent

Create a Segment endpoint