Register

Table of Contents

• Description
• Examples
• Cookbook
• F.A.Q.
• API Documentation

Description

Financial meaning

A register is a structured and organized record used in finance and accounting to track specific types of financial data over time. It acts like a detailed ledger where all movements or events related to a particular category (such as cash, securities, or transactions) are documented.

Platform abstraction

A Register in the Finmars platform is a structured container that stores valuation-related information about a portfolio. Each register is associated with a specific portfolio and reflects a distinct layer of financial data, such as positions, valuations, and links to financial instruments. Registers help structure and organize the way portfolio data is calculated, grouped, and displayed.

Registers are used in:

• Each register defines the currency and pricing method for asset valuation within the platform.

• Registers store snapshots of position and value changes that are then used to compute return metrics.

• Registers help distinguish between cash and position data, creating a cleaner view of asset structure.

• Registers may reference specific instruments tied to the valuation of positions.

Examples

• User code: Unique identifier of the register, often includes portfolio and register type.

• Valuation CCY: The currency in which the register's values are stored and calculated.

• Pricing policy: The pricing rule (e.g. Standard) used for valuation.

• Portfolio: The portfolio to which the register belongs.

• Linked Instrument: Reference to a financial instrument connected with the register.

• Notes: Optional field for additional comments or context.

Cookbook

CRUD

• Create: A new register can be created by navigating to a portfolio and selecting the Registers section. Click the plus (+) button in the top-right corner to open the “Add Portfolio Register” form.

• Read: All existing registers are visible under the “Registers” tab. Users can review summary information (such as name, valuation currency, pricing policy, etc.)

• Update:  To edit a register, select it from the register list of the corresponding portfolio. All fields except the portfolio linkage can typically be edited. Users may update pricing policy, currency, instrument linkage, names, and default price to reflect changing valuation or reporting needs.

• Delete: Registers can be deleted directly from the management page.

Use Cases

• A register can be associated with a specific financial instrument, making it useful for focused tracking, reporting, or pricing logic on a particular asset or security.
• With separate fields for Short Name, Public Name, and Name, users can maintain clear internal identifiers while presenting clean labels externally.
• Using the Valuation Currency field, users ensure that position values are recorded consistently for performance tracking, aggregation, and risk exposure reporting.

F.A.Q.

Frequently asked questions.

API documentation

Link to API documentation.