# Register

This entity is associated with a portfolio. It is used for calculating performance, helping track and analyze the portfolio's overall returns and efficiency over time.

# Register

#### **Table of Contents**

- [Description](#bkmrk-description)
- [Examples](#bkmrk-examples)
- [Cookbook](#bkmrk-cookbook)
- [F.A.Q.](#bkmrk-api-documentation)
- [API Documentation](#bkmrk-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 ](https://docs.finmars.com/books/entities/page/currency "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 ](https://docs.finmars.com/books/entities/page/instrument "Instrument")tied to the valuation of positions.

#### **Examples**

<table border="1" id="bkmrk-user-code-valuation-" style="border-collapse: collapse; width: 100%;"><colgroup><col style="width: 16.6667%;"></col><col style="width: 16.6667%;"></col><col style="width: 16.6667%;"></col><col style="width: 16.6667%;"></col><col style="width: 16.6667%;"></col><col style="width: 16.6667%;"></col></colgroup><tbody><tr><td>**User code**</td><td>**Valuation CCY**</td><td>**Pricing policy**</td><td>**Portfolio**</td><td>**Linked Instrument**</td><td>**Notes** </td></tr><tr><td>CH-BND-20394857</td><td>USD</td><td>Standard</td><td>CH-BND-20394857</td><td>CH-BND-20394857</td><td>  
</td></tr></tbody></table>

- `<strong data-end="1247" data-start="1234">User code</strong>`: Unique identifier of the register, often includes portfolio and register type.
- `<strong data-end="1349" data-start="1332">Valuation CCY</strong>`: The currency in which the register's values are stored and calculated.
- `<strong data-end="1444" data-start="1426">Pricing policy</strong>`: The pricing rule (e.g. Standard) used for valuation.
- `<strong data-end="1516" data-start="1503">Portfolio</strong>`: The portfolio to which the register belongs.
- `<strong data-end="1588" data-start="1567">Linked Instrument</strong>`: Reference to a financial instrument connected with the register.
- `<strong data-end="1668" data-start="1659">Notes</strong>`: 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.

# How to Create a Register Entity

## Prerequisites

We assume you have all prerequisites you may need, including:

1. If needed: the VPN is configured to access the Finmars resources
2. If needed: access to the Virtual Machine to work with the sensitive information
3. Must have: registered in Finmars in the needed region environment (self-registered or registered by Finmars)
4. Must have: having permissions set to allow continue with the Action in the Guide

## Creation of Register Entity

1. <span style="color: rgb(170, 170, 170); background-color: rgb(34, 34, 34);">Open the</span> ****“Data”**** <span style="color: rgb(170, 170, 170); background-color: rgb(34, 34, 34);">section in the left-hand side menu. Select the</span> ****“Registers”**** <span style="color: rgb(170, 170, 170); background-color: rgb(34, 34, 34); white-space: pre-wrap;">entity from the list under </span>****Data****<span style="color: rgb(170, 170, 170); background-color: rgb(34, 34, 34);">.</span>  
    [![Снимок экрана 2025-05-06 034551.png](https://docs.finmars.com/uploads/images/gallery/2025-05/scaled-1680-/snimok-ekrana-2025-05-06-034551.png)](https://docs.finmars.com/uploads/images/gallery/2025-05/scaled-1680-/snimok-ekrana-2025-05-06-034551.png)
2. ****Click the “+ Add” button****<span style="color: rgb(170, 170, 170); background-color: rgb(34, 34, 34); white-space: pre-wrap;"> located in the top-left corner of the portfolio list view.</span>  
    [![Снимок экрана 2025-05-06 034558.png](https://docs.finmars.com/uploads/images/gallery/2025-05/scaled-1680-/snimok-ekrana-2025-05-06-034558.png)](https://docs.finmars.com/uploads/images/gallery/2025-05/scaled-1680-/snimok-ekrana-2025-05-06-034558.png)
3. <span style="color: rgb(170, 170, 170); background-color: rgb(34, 34, 34); white-space: pre-wrap;">This action opens the </span>****Add****<span style="white-space: pre-wrap;"> </span>****Portfolio register**** <span style="color: rgb(170, 170, 170); background-color: rgb(34, 34, 34);">form.</span>  
    [![Снимок экрана 2025-05-06 034612.png](https://docs.finmars.com/uploads/images/gallery/2025-05/scaled-1680-/snimok-ekrana-2025-05-06-034612.png)](https://docs.finmars.com/uploads/images/gallery/2025-05/scaled-1680-/snimok-ekrana-2025-05-06-034612.png)
4. ****Fill in the required fields in the creation panel:****
    1. ****User code**** <span style="white-space: pre-wrap;">– unique identifier for the register record. Often reflects the instrument or portfolio logic (e.g., </span>`<span class="editor-theme-code">CH-XYZ-Portfolio_POS</span>`).
    2. ****Name****<span style="white-space: pre-wrap;"> – descriptive name of the register, used in views and reports.</span>
    3. ****Short name****<span style="white-space: pre-wrap;"> – abbreviated version of the name, useful in condensed views or exports.</span>
    4. ****Public name**** – optional field for external-facing labels, if different from internal naming.
    5. ****Portfolio**** – select the portfolio to which this register belongs. This links the register to a specific investment structure.
    6. ****Linked Instrument –**** associate a financial instrument (e.g., bond, equity) to track valuation and performance.****Pricing Policy****<span style="white-space: pre-wrap;"> – define how prices and FX rates will be sourced for this register (e.g., Standard, Rolled Master).</span>
    7. ****Valuation Currency –**** the currency in which the register will be valued. Used in NAV calculations and reporting.
    8. ****Default Price –**** optional value to preload a fallback price when no market price is available.  
        [![копия.png](https://docs.finmars.com/uploads/images/gallery/2025-05/scaled-1680-/kopiia.png)](https://docs.finmars.com/uploads/images/gallery/2025-05/scaled-1680-/kopiia.png)
5. <span style="color: rgb(170, 170, 170); background-color: rgb(34, 34, 34);">Click</span> ****“Create and Exit”****<span style="color: rgb(170, 170, 170); background-color: rgb(34, 34, 34); white-space: pre-wrap;"> to save the portfolio and return to the list view. Alternatively, use </span>****“Create”****<span style="color: rgb(170, 170, 170); background-color: rgb(34, 34, 34); white-space: pre-wrap;"> to save and continue editing.</span>