Structuring Data

Customize and extend ledger records with schemas, labels, and layouts

The ledger supports flexible data structures beyond the built-in record types. This section covers how to attach custom data, enforce schemas, organize records with labels, and manage configurations with layouts.

Basics

Custom Fields

Attach arbitrary JSON data to any ledger record.

Schemas

Enforce data types and validation rules on record fields.

Statuses

Manage record lifecycle states and transitions.

Labels

Group and categorize records with key-value labels.

Referenced Records

Link records to each other using handle references.

Data Policies

Status Policies

Define rules that govern record status transitions.

Labels Policies

Control which labels can be applied to records.

Custom Policies

Create custom validation logic for record operations.

Layouts

Layouts define reusable configurations of ledger records that can be applied, exported, and synced across environments.

About Layouts

Overview of the layout system and how it works.

Read Layout

Inspect the current layout configuration.

Apply Layout

Apply a layout configuration to a ledger.

Export Layout

Export a ledger's current state as a layout file.

Sync Layout

Synchronize a layout definition with a running ledger.

Display Differences

Compare a layout file against the current ledger state.

Tutorials

Working with Layouts

Step-by-step tutorial: connect to a sandbox, configure a ledger, and make transactions using layouts.

Prerequisites

  • Start Here — Understand ledger basics and record types
  • Moving Money — Familiarity with wallets and intents

On this page