# Entities

- For understanding core platform components and their role.
- For users who need to know the structure, examples, and purposes of each entity.
- Helpful as a quick reference to the main building blocks of the system.

# Portfolio

A collection of your investments, like stocks, bonds, or funds, all in one place.

# Portfolio

#### **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*

**Portfolio** refers to a collection of financial assets. Portfolios are held directly by investors and/or managed by financial professionals. Effective portfolio management involves diversification, asset allocation, and regular performance monitoring to optimize returns and manage risks.

##### *Platform abstraction*

**Portfolio** in Finmars platform is a container for financial assets (cash ([currency](https://docs.finmars.com/books/entities/page/currency "Currency")) & [instruments](https://docs.finmars.com/books/entities/page/instrument "Instrument")) allocation.

**Portfolio also is used in:**

- [performance](https://docs.finmars.com/books/reports/chapter/performance "Performance") calculation with its [registers](https://docs.finmars.com/books/entities/chapter/register "Register") grouped in [bundles](https://docs.finmars.com/books/entities/chapter/bundle "Bundle")
- [reconciliation](https://docs.finmars.com/books/reports/chapter/reconciliation "Reconciliation") using special [portfolio type](https://docs.finmars.com/books/entities/page/portfolio-type "Portfolio Type") and [portfolio reconcile group](https://docs.finmars.com/books/entities/page/portfolio-reconcile-group "Portfolio Reconcile Group").

#### **Examples**

<table border="1" id="bkmrk-" style="border-collapse: collapse; width: 107.5%;"><colgroup><col style="width: 6.67461%;"></col><col style="width: 8.70083%;"></col><col style="width: 6.7938%;"></col><col style="width: 6.67461%;"></col><col style="width: 6.91299%;"></col><col style="width: 6.91299%;"></col><col style="width: 10.7271%;"></col><col style="width: 10.7271%;"></col><col style="width: 9.29621%;"></col><col style="width: 10.7276%;"></col><col style="width: 8.10489%;"></col><col style="width: 7.86651%;"></col></colgroup><thead><tr><td class="align-center">User code</td><td class="align-center">Portfolio Type</td><td class="align-center">Name</td><td class="align-center">Short name</td><td class="align-center">Public name</td><td class="align-center">Notes</td><td class="align-center">First Transaction Date</td><td class="align-center">First Cash Flow Date</td><td class="align-center">Accounts</td><td class="align-center">Transaction types</td><td>Responsibles</td><td>Counterparties</td></tr></thead><tbody><tr><td>obl01  
</td><td>Manual</td><td>Bonds</td><td>Bonds</td><td>Bonds</td><td>-</td><td>2022-12-01</td><td>2022-12-01</td><td>  
</td><td>  
</td><td>  
</td><td>  
</td></tr></tbody></table>

- `User code`: workspace unique identifier of the portfolio with source prefix as it's multi-source entity
- `Portfolio Type`: configuration-defined criterion for reconciliation
- `Name`: full name
- `Short name`: short name, showed in other relations
- `Public name`: public view name for users without access
- `Notes`: custom description for portfolio
- `First Transaction Date`: date of the first transaction in the portfolio (changes by the logic described below)
- `First Cash Flow Date`: date of the first transaction in the portfolio for base transaction class == <span class="code" spellcheck="false">Cash-Inflow</span> or <span class="code" spellcheck="false">Cash-Outflow</span> (changes by the logic described below)
- `Accounts`: (not strict, informative) selected accounts that can be used for this portfolio
- `Transaction types`: (not strict, informative)selected transaction types that can be used for this portfolio
- `Responsibles`: (not strict, informative)selected responsibles that can be used for this portfolio
- `Counterparties`: (not strict, informative)selected counterparties that can be used for this portfolio

Portfolio has 2 attributes `First Transaction Date` and `First Cash Flow Date` which are used for performance calculations with workflow and performance report and the logic for them is defined below:

**Logic for defining First Transaction Date &amp; First Cash Flow Date based on complex transactions:**

1. Portfolio entity has 2 properties:
    
    
    1. <span class="code" spellcheck="false">first\_transcation\_date</span> (name = <span class="code" spellcheck="false">First transaction date</span>, value = <span class="code" spellcheck="false">null</span>)
    2. <span class="code" spellcheck="false">first\_cash\_flow\_date </span>(name = <span class="code" spellcheck="false">First cash flow date</span>, value = <span class="code" spellcheck="false">null</span>)
2. **For complex transaction CRUD** operations **For each base transaction** in the complex transaction:
    
    
    1. if **Book**
        
        
        1. if base transaction class == <span class="code" spellcheck="false">Cash-Inflow</span> or <span class="code" spellcheck="false">Cash-Outflow</span>
            
            
            1. if <span class="code" spellcheck="false">trade\_date</span> &lt; <span class="code" spellcheck="false">first\_cash\_flow\_date</span>
                
                
                1. <span class="code" spellcheck="false">first\_cash\_flow\_date</span> = <span class="code" spellcheck="false">trade\_date</span>
        2. if <span class="code" spellcheck="false">trade\_date</span> &lt; <span class="code" spellcheck="false">first\_transcation\_date</span>
            
            
            1. <span class="code" spellcheck="false">first\_transcation\_date</span> = <span class="code" spellcheck="false">trade\_date</span>
    2. if **Rebook !!!**
        
        
        1. if base transaction class == <span class="code" spellcheck="false">Cash-Inflow</span> or <span class="code" spellcheck="false">Cash-Outflow</span>
            
            
            1. if **<u>new </u>**<span class="code" spellcheck="false">trade\_date</span> &lt; <span class="code" spellcheck="false">first\_cash\_flow\_date</span>
                
                
                1. <span class="code" spellcheck="false">first\_cash\_flow\_date</span> = <span class="code" spellcheck="false">trade\_date</span>
            2. else
                
                
                1. if **<u>old </u>**<span class="code" spellcheck="false">trade\_date</span> == <span class="code" spellcheck="false">first\_cash\_flow\_date</span>
                    
                    
                    1. <span class="code" spellcheck="false">first\_cash\_flow\_date</span> = find new <span class="code" spellcheck="false">first\_cash\_flow\_date</span>
        2. if **<u>new </u>**<span class="code" spellcheck="false">trade\_date</span> &lt; <span class="code" spellcheck="false">first\_transcation\_date</span>
            
            
            1. <span class="code" spellcheck="false">first\_transcation\_date</span> = <span class="code" spellcheck="false">trade\_date</span>
        3. else
            
            
            1. if **<u>old </u>**<span class="code" spellcheck="false">trade\_date</span> == <span class="code" spellcheck="false">first\_transcation\_date</span>
                
                
                1. <span class="code" spellcheck="false">first\_transcation\_date</span> = find new <span class="code" spellcheck="false">first\_transcation\_date</span>
    3. if **Delete**
        
        
        1. if base transaction class == <span class="code" spellcheck="false">Cash-Inflow</span> or <span class="code" spellcheck="false">Cash-Outflow</span>
            
            
            1. if <span class="code" spellcheck="false">trade\_date</span> == <span class="code" spellcheck="false">first\_cash\_flow\_date</span>
                
                
                1. if true <span class="code" spellcheck="false">first\_cash\_flow\_date</span> = find new <span class="code" spellcheck="false">first\_cash\_flow\_date</span>
        2. if <span class="code" spellcheck="false">trade\_date</span> == <span class="code" spellcheck="false">first\_transcation\_date</span>
            
            
            1. if true <span class="code" spellcheck="false">first\_transcation\_date</span> = find new <span class="code" spellcheck="false">first\_transcation\_date</span>

#### **Cookbook**

##### *CRUD* 

- **Create: [How to Create a Portfolio Entity](https://docs.finmars.com/books/entities/page/how-to-create-a-portfolio-entity "How to Create a Portfolio Entity")**
- **Read: [How to Read a Portfolio Entity](https://docs.finmars.com/books/entities/page/how-to-read-a-portfolio-entity "How to Read a Portfolio Entity")**
- **Update: [How to Update a Portfolio Entity](https://docs.finmars.com/books/entities/page/how-to-update-a-portfolio-entity "How to Update a Portfolio Entity")**
- **Delete: [How to Delete a Portfolio Entity](https://docs.finmars.com/books/entities/page/how-to-delete-a-portfolio-entity "How to Delete a Portfolio Entity")**

##### *Use Cases*

- Within a portfolio, transactions and instrument positions are grouped using **registers**, which feed into bundles and ultimately affect portfolio-level calculations and reporting.
- Auto-populated fields such as **First Transaction Date** and **First Cash Flow Date** are critical inputs for internal workflows, audit tracking, and performance evaluation logic.
- Leverage the **Portfolio Type** field to define reconciliation logic and reporting behavior (e.g., General, Manual, or Position Only).

#### **F.A.Q.**

Frequently asked questions.

#### **API documentation**

Link to API documentation.

# How to Create a Portfolio 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 Portfolio Entity

1. Open the ****“Data”**** section in the left-hand side menu. Select the ****“Portfolios”**** <span style="white-space: pre-wrap;">entity from the list under </span>****Data****.  
    [![Снимок экрана 2025-05-04 195556.png](https://docs.finmars.com/uploads/images/gallery/2025-05/scaled-1680-/snimok-ekrana-2025-05-04-195556.png)](https://docs.finmars.com/uploads/images/gallery/2025-05/scaled-1680-/snimok-ekrana-2025-05-04-195556.png)
2. ****Click the “+ Add” button****<span style="white-space: pre-wrap;"> located in the top-left corner of the portfolio list view.</span>  
    [![Снимок экрана 2025-05-04 195818.png](https://docs.finmars.com/uploads/images/gallery/2025-05/scaled-1680-/snimok-ekrana-2025-05-04-195818.png)](https://docs.finmars.com/uploads/images/gallery/2025-05/scaled-1680-/snimok-ekrana-2025-05-04-195818.png)
3. <span style="white-space: pre-wrap;">This action opens the </span>****Add Portfolio****<span style="white-space: pre-wrap;"> form.</span>  
    [![image.png](https://docs.finmars.com/uploads/images/gallery/2025-05/scaled-1680-/image.png)](https://docs.finmars.com/uploads/images/gallery/2025-05/image.png)
4. ****Fill in the required fields in the creation panel:****
    1. ****Portfolio****<span style="white-space: pre-wrap;"> (Full Name) – the unique name of the portfolio. This will be used to identify it across the platform.</span>
    2. ****Portfolio Type –**** select from predefined types (e.g., General, Positional). Determines portfolio behavior and classification.
    3. ****Notes****<span style="white-space: pre-wrap;"> – optional field to add internal comments or details about the portfolio’s purpose or structure.</span>
    4. ****First Transaction Date****<span style="white-space: pre-wrap;"> (auto populated, do not fill) – this field will automatically reflect the earliest transaction date once transactions are associated.</span>
    5. ****First Cash Flow Date****<span style="white-space: pre-wrap;"> (auto populated, do not fill) – similar to the above, it will auto-fill based on actual cash flow activity.</span>
5. Click ****“Create and Exit”****<span style="white-space: pre-wrap;"> to save the portfolio and return to the list view. Alternatively, use </span>****“Create”****<span style="white-space: pre-wrap;"> to save and continue editing.</span>  
    [![Снимок экрана 2025-05-04 200008.png](https://docs.finmars.com/uploads/images/gallery/2025-05/scaled-1680-/snimok-ekrana-2025-05-04-200008.png)](https://docs.finmars.com/uploads/images/gallery/2025-05/scaled-1680-/snimok-ekrana-2025-05-04-200008.png)

# How to Read a Portfolio Entity

#### ****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**

<span style="white-space: pre-wrap;">Financial meaning behind the entity (incl. diagrams and other explanatory materials). </span>

##### **Platform abstraction**

Description of the entity in Platform (incl. diagrams, excel and other explanatory materials on how it works).

#### ****Examples****

<span style="white-space: pre-wrap;">Platform screenshots with a description of a record table example. </span>

#### ****Cookbook****

##### **CRUD**

Operations within platform.

##### **Use Cases**

What for it's used.

#### ****F.A.Q.****

Frequently asked questions.

#### ****API documentation****

<span style="white-space: pre-wrap;">Link to API documentation. </span>

# How to Update a Portfolio Entity

#### ****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**

<span style="white-space: pre-wrap;">Financial meaning behind the entity (incl. diagrams and other explanatory materials). </span>

##### **Platform abstraction**

Description of the entity in Platform (incl. diagrams, excel and other explanatory materials on how it works).

#### ****Examples****

<span style="white-space: pre-wrap;">Platform screenshots with a description of a record table example. </span>

#### ****Cookbook****

##### **CRUD**

Operations within platform.

##### **Use Cases**

What for it's used.

#### ****F.A.Q.****

Frequently asked questions.

#### ****API documentation****

<span style="white-space: pre-wrap;">Link to API documentation. </span>

# How to Delete a Portfolio Entity

#### ****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**

<span style="white-space: pre-wrap;">Financial meaning behind the entity (incl. diagrams and other explanatory materials). </span>

##### **Platform abstraction**

Description of the entity in Platform (incl. diagrams, excel and other explanatory materials on how it works).

#### ****Examples****

<span style="white-space: pre-wrap;">Platform screenshots with a description of a record table example. </span>

#### ****Cookbook****

##### **CRUD**

Operations within platform.

##### **Use Cases**

What for it's used.

#### ****F.A.Q.****

Frequently asked questions.

#### ****API documentation****

<span style="white-space: pre-wrap;">Link to API documentation. </span>

# 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>

# Accounts

It's a financial entity used to track and manage transactions, balances, and holdings.

# Accounts

#### **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*

Accounts represent storage locations for financial assets or cash. They define where securities, cash, or other financial holdings are kept, ensuring legal ownership, custody, and safekeeping.

##### *Platform abstraction*

An Account in the Finmars platform defines a place where assets or cash are held. It carries properties like type, name, and purpose (e.g., depository, provisional account).  
Accounts are essential for linking transactions, managing cash, tracking positions, and generating reports.

**Accounts are used in:**

- Connecting holdings to the correct location (e.g. [portfolio ](https://docs.finmars.com/books/entities/page/portfolio "Portfolio")or [counterparty](https://docs.finmars.com/books/entities/page/counterparty "Counterparty"))
- Managing and tracking cash and asset transfers
- Verifying asset values across different accounts
- Supporting regulatory and internal financial [reporting](https://docs.finmars.com/books/reports "Reports")

#### **Examples**

<table border="1" id="bkmrk-user-code-type%C2%A0-shor" 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>**Type** </td><td>**Short Name**</td><td>**Name**</td><td>**Public Name**</td><td>**Notes**</td></tr><tr><td>129900RGLDPQ3DT2T5H1</td><td>Default Account Type</td><td>SCVA</td><td>Securities Vault Alpha</td><td>SECALPHAZZXXX</td><td>Depository for Securities</td></tr></tbody></table>

- `<strong data-end="49" data-start="36">User code</strong>`: a unique identifier of the account within the system.
- `<strong data-end="117" data-start="109">Type</strong>`: classification of the account (e.g., default, provisional, etc.).
- `<strong data-end="203" data-start="189">Short name</strong>`: a brief label for quick reference of the account.
- `<strong data-end="267" data-start="259">Name</strong>`: the full name of the account for user clarity.
- `<strong data-end="335" data-start="320">Public name</strong>`: the name displayed externally or used in reporting.
- `<strong data-end="402" data-start="393">Notes</strong>`: additional information about the purpose or specifics of the account.

#### **Cookbook**

##### *CRUD* 

- **Create: [How to Create an Account Entity](https://docs.finmars.com/books/entities/page/how-to-create-an-account-entity "How to Create an Account Entity")**
- **Read:** All accounts are listed in the Accounts management page. This list provides quick access to key fields such as name, type, and status. Users can filter, group, or search to locate specific accounts and review their configuration.
- **Update:** To edit a account, users can click on an existing entry to open the edit form. All field – except those constrained by platform rules – can be modified, including the full name, type, status or optional notes.
- **Delete:** Accounts can be deleted directly from the management page.

##### *Use Cases*

- Use the **Type** field to distinguish accounts based on purpose—such as a provisional holding account for pending transactions or a default account for general asset storage.
- Multiple name fields (Full Name, Short Name, Public Name) ensure that the same account can be clearly identified internally while presenting a different label in client-facing or compliance reports.
- Transactions are booked to accounts to reflect real-world movements of cash or securities, ensuring accurate position and cash flow tracking.

#### **F.A.Q.**

Frequently asked questions.

#### **API documentation**

Link to API documentation.

# How to Create an Account 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 Account 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> ****“Accounts”**** <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 034052.png](https://docs.finmars.com/uploads/images/gallery/2025-05/scaled-1680-/snimok-ekrana-2025-05-06-034052.png)](https://docs.finmars.com/uploads/images/gallery/2025-05/scaled-1680-/snimok-ekrana-2025-05-06-034052.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 034133.png](https://docs.finmars.com/uploads/images/gallery/2025-05/scaled-1680-/snimok-ekrana-2025-05-06-034133.png)](https://docs.finmars.com/uploads/images/gallery/2025-05/scaled-1680-/snimok-ekrana-2025-05-06-034133.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>****Account**** <span style="color: rgb(170, 170, 170); background-color: rgb(34, 34, 34);">form.</span>  
    [![Снимок экрана 2025-05-06 034143.png](https://docs.finmars.com/uploads/images/gallery/2025-05/scaled-1680-/snimok-ekrana-2025-05-06-034143.png)](https://docs.finmars.com/uploads/images/gallery/2025-05/scaled-1680-/snimok-ekrana-2025-05-06-034143.png)
4. ****Fill in the required fields in the creation panel:****
    1. ****Account****<span style="white-space: pre-wrap;"> – full name of the account. This will serve as the primary identifier in the interface and reports.</span>
    2. ****Type****<span style="white-space: pre-wrap;"> – choose the account type from the dropdown (e.g., Default Account Type, FX Buy/Sell, Provision). This determines behavior in flows, reports, and reconciliations.</span>
    3. ****Notes****<span style="white-space: pre-wrap;"> </span>**(optional) –**<span style="white-space: pre-wrap;"> any internal comments or descriptions related to the account setup.Any internal comments or descriptions related to the account setup.</span>  
        [![Снимок экрана 2025-05-06 03414.png](https://docs.finmars.com/uploads/images/gallery/2025-05/scaled-1680-/snimok-ekrana-2025-05-06-03414.png)](https://docs.finmars.com/uploads/images/gallery/2025-05/scaled-1680-/snimok-ekrana-2025-05-06-03414.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>

# Instrument

This entity is a unique ID for a financial asset or security involved in a transaction.

# Instrument

#### **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*

Financial instruments are contracts that represent a financial asset for one party and a financial liability or equity instrument for another. They are used in investing, hedging, and speculative strategies across global financial markets.

Instruments can be categorized into equity instruments (e.g., stocks), debt instruments (e.g., bonds), derivatives (e.g., options, swaps), and hybrid instruments.

##### *Platform abstraction*

In the **Finmars** platform, the Instrument entity represents the complete set of [financial instruments](https://docs.finmars.com/books/entities/page/instrument "Instrument") under management. It serves as a central component for accounting, valuation, performance measurement, risk analysis, reconciliation, and reporting.

**Instruments are used in:**

- Identifying and tracking specific financial assets or securities involved in [transactions](https://docs.finmars.com/books/entities/page/transactions "Transactions")
- Linking related [transactions ](https://docs.finmars.com/books/entities/page/transactions "Transactions")where instruments and cash considerations are connected (via linked instruments)
- Ensuring accurate valuation and processing of asset movements
- Supporting [reconciliation ](https://docs.finmars.com/books/reports/chapter/reconciliation "Reconciliation")and [reporting ](https://docs.finmars.com/books/reports "Reports")of financial positions across [portfolios ](https://docs.finmars.com/books/entities/page/portfolio "Portfolio")and [accounts](https://docs.finmars.com/books/entities/page/accounts "Accounts")

#### **Examples**

**First part of table**

<table border="1" id="bkmrk-user-code-modified-a" style="border-collapse: collapse; width: 100%;"><colgroup><col style="width: 12.5%;"></col><col style="width: 12.5%;"></col><col style="width: 12.5%;"></col><col style="width: 12.5%;"></col><col style="width: 12.5%;"></col><col style="width: 12.5%;"></col><col style="width: 12.5%;"></col><col style="width: 12.5%;"></col></colgroup><tbody><tr><td>**User code**</td><td>**Modified at**</td><td>**Asset type**</td><td>**Country**</td><td>**PRC CCY**</td><td>**ACCR CCY**</td><td>**Short name**</td><td>**Name**</td></tr><tr><td>CH-BND-20394856</td><td>2025-02-10</td><td>Other</td><td>Colombia</td><td>USD</td><td>USD</td><td>CH-BND-20394856</td><td>Ms\_XX:20394856</td></tr></tbody></table>

**Second part of table**

<table border="1" id="bkmrk-public-name-mat%C2%A0-dt-" style="border-collapse: collapse; width: 100%;"><colgroup><col style="width: 12.5%;"></col><col style="width: 12.5%;"></col><col style="width: 12.5%;"></col><col style="width: 12.5%;"></col><col style="width: 12.5%;"></col><col style="width: 12.5%;"></col><col style="width: 12.5%;"></col><col style="width: 12.5%;"></col></colgroup><tbody><tr><td>**Public name**</td><td>**MAT DT**</td><td>**MAT PRC**</td><td>**PRC MULT**</td><td>**ACCR MULT**</td><td>**INSTR TYPE**</td><td>**PMT SZ DTL**</td><td>**Notes**</td></tr><tr><td>20394856</td><td>9999-12-31</td><td>0.00</td><td>1.00</td><td>1.00</td><td>Portfolio</td><td>Default</td><td>  
</td></tr></tbody></table>

1. `<strong data-end="187" data-start="174">User code</strong>`: unique identifier assigned to the instrument. Used for internal reference and tracking.
2. `<strong data-end="326" data-start="311">Modified at</strong>`: date and time of the last modification to the instrument data.
3. `<strong data-end="450" data-start="436">Asset type</strong>`: classification of the instrument (e.g., Bond, Derivative, Real Estate). Determines behavior and processing rules in the system.
4. `<strong data-end="590" data-start="579">Country</strong>`: country of issuance or jurisdiction of the instrument's issuer. Important for regulatory and risk assessment purposes.
5. `<strong data-end="745" data-start="715">PRC CCY </strong><strong data-end="745" data-start="715">(Pricing Currency)</strong>`: the currency in which the instrument is quoted or priced. Used for valuation and financial reporting.
6. `<strong data-end="884" data-start="853">ACCR CCY (Accrual Currency)</strong>`: the currency used to calculate interest or accruals. May differ from pricing currency.
7. `<strong data-end="991" data-start="977">Short name</strong>`: abbreviated or condensed label for quick reference.
8. `<strong data-end="1097" data-start="1089">Name</strong>`: full name of the instrument, typically including issuer, coupon/yield, and maturity details.
9. `<strong data-end="1211" data-start="1196">Public name</strong>`: market-facing or external name of the instrument, often matching how it appears on exchanges or public reports.
10. `<strong data-end="1356" data-start="1330">MAT DT (Maturity Date)</strong>`: the date on which the instrument matures or principal is repaid. Key for fixed-income instruments.
11. `<strong data-end="1490" data-start="1462">MAT PRC (Maturity Price)</strong>`: the expected or agreed price of the instrument at maturity.
12. `<strong data-end="1629" data-start="1596">PRC MULT (Pricing Multiplier)</strong>`: factor applied to scale the market price to nominal or unit-based values (e.g., per 100 or per 1,000 units).
13. `<strong data-end="1779" data-start="1745">ACCR MULT (Accrual Multiplier)</strong>`: factor used to adjust accrual amounts. Helps handle non-standard periods or calculation rules.
14. `<strong data-end="1913" data-start="1881">INSTR TYPE (Instrument Type)</strong>`: instrument type code (e.g., BOND, STOCK, PORTFOLIO). Used for classification, logic, and filtering.
15. `<strong data-end="2049" data-start="2013">PMT SZ DTL (Payment Size Detail)</strong>`: specifies the payment structure (e.g., default). Supports payment schedule modeling.
16. `<strong data-end="2170" data-start="2161">Notes</strong>`: free-text field for comments or special handling notes related to the instrument.

#### **Cookbook**

##### *CRUD* 

**Create:** [How to Create a Instrument entity](https://docs.finmars.com/books/entities/page/how-to-create-an-instrument-entity "How to Create a Instrument entity")

##### *Use Cases*

What for it's used.

#### **F.A.Q.**

Frequently asked questions.

#### **API documentation**

Link to API documentation.

# How to Create an Instrument 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> ****“Instruments”**** <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-07 051134.png](https://docs.finmars.com/uploads/images/gallery/2025-05/scaled-1680-/snimok-ekrana-2025-05-07-051134.png)](https://docs.finmars.com/uploads/images/gallery/2025-05/scaled-1680-/snimok-ekrana-2025-05-07-051134.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>A dropdown menu will appear offering four methods to add a new instrument:
    1. ****Add Blank****<span style="white-space: pre-wrap;"> – manual entry with a fully blank template.</span>
    2. ****Add Typical****<span style="white-space: pre-wrap;"> – pre-filled template with commonly used default values.</span>
    3. ****Import from File****<span style="white-space: pre-wrap;"> – bulk import instruments using a file.</span>
    4. ****Get from Provider****<span style="white-space: pre-wrap;"> – retrieve instrument data from a market data provider.</span>

[![Снимок экрана 2025-05-07 051324.png](https://docs.finmars.com/uploads/images/gallery/2025-05/scaled-1680-/snimok-ekrana-2025-05-07-051324.png)](https://docs.finmars.com/uploads/images/gallery/2025-05/scaled-1680-/snimok-ekrana-2025-05-07-051324.png)

##### Option 1: Add Blank

This opens a completely blank form where you can manually input all instrument details.

[![image.png](https://docs.finmars.com/uploads/images/gallery/2025-05/scaled-1680-/yC7image.png)](https://docs.finmars.com/uploads/images/gallery/2025-05/yC7image.png)  
  
Fill out the following fields as needed:

1. ****Instrument****<span style="white-space: pre-wrap;"> – full name or unique identifier (required).</span>
2. ****Instrument type****<span style="white-space: pre-wrap;"> – defines the kind of instrument (e.g., Bond, Stock, FX Forward, etc.).</span>
3. ****Asset Type**** – specifies the financial asset classification (e.g., Equity, Fixed Income).
4. ****Country**** – country of issuance of the instrument.
5. ****Accrual Size Clarification****<span style="white-space: pre-wrap;"> – optional explanation or note for accrual calculation basis.</span>
6. ****Pricing currency****<span style="white-space: pre-wrap;"> – the currency in which the instrument's market price is quoted.</span>
7. ****Accrued currency****<span style="white-space: pre-wrap;"> – the currency in which interest or other accruals are calculated and reported.</span>
8. ****Price multiplier**** – multiplier applied to the quoted price to calculate notional or total value (e.g., 100 if price is per 100 units).
9. ****Accrued multiplier****<span style="white-space: pre-wrap;"> – multiplier used to adjust the accrual value, typically to scale interest or dividend values appropriately.</span>
10. ****Maturity date****<span style="white-space: pre-wrap;"> – the date when the instrument is due to mature and be settled (e.g., for bonds or term deposits).</span>
11. ****Maturity price****<span style="white-space: pre-wrap;"> – the expected price or value at maturity, often used in valuation or final settlement (if applicable).</span>
12. ****Notes**** – any relevant internal comments or additional metadata for this instrument.
13. ****Identifiers****<span style="white-space: pre-wrap;"> – optional key-value fields such as ISIN, CUSIP, internal codes, etc., used to uniquely identify the instrument.</span>

<span style="white-space: pre-wrap;">Click </span>****“Create and Exit”****<span style="white-space: pre-wrap;"> to save and return to the list, or</span> ****“Create”****<span style="white-space: pre-wrap;"> to save and continue editing.</span>  
[![Снимок экрана 2025-05-07 051440.png](https://docs.finmars.com/uploads/images/gallery/2025-05/scaled-1680-/snimok-ekrana-2025-05-07-051440.png)](https://docs.finmars.com/uploads/images/gallery/2025-05/scaled-1680-/snimok-ekrana-2025-05-07-051440.png)

## Option 2: Add Typical

This will load a pre-filled template with default values for typical instruments, which can be modified as needed. Use this option to speed up creation when working with commonly used instruments.  
[![image.png](https://docs.finmars.com/uploads/images/gallery/2025-05/scaled-1680-/oTGimage.png)](https://docs.finmars.com/uploads/images/gallery/2025-05/oTGimage.png)

<span style="white-space: pre-wrap;">Click </span>****“Create and Exit”****<span style="white-space: pre-wrap;"> to save and return to the list, or</span> ****“Create”****<span style="white-space: pre-wrap;"> to save and continue editing.</span>

## Option 3: Import from File

Use this option to import multiple instruments into the system from a prepared file (e.g., Excel or CSV).

1. ****Name****<span style="white-space: pre-wrap;"> – provide a name for the import process).</span>
2. ****Import Scheme**** – select the appropriate scheme that matches the structure of your file. This determines how the system interprets and maps the data.
3. ****Browse**** – click this button to choose a file from your computer. Supported formats depend on the selected import scheme (e.g., .xlsx, .csv).  
    [![image.png](https://docs.finmars.com/uploads/images/gallery/2025-05/scaled-1680-/Yrnimage.png)](https://docs.finmars.com/uploads/images/gallery/2025-05/Yrnimage.png)

<span style="white-space: pre-wrap;">After selecting the file, click </span>****“Validate”****<span style="white-space: pre-wrap;"> to check the file for errors and confirm it matches the selected scheme. If the validation is successful, click </span>****“Import”****<span style="white-space: pre-wrap;"> to load the instruments into the database.</span>

## Option 4: Get from Provider

Automatically pull instrument data from a connected market data provider.

[![image.png](https://docs.finmars.com/uploads/images/gallery/2025-05/scaled-1680-/7gTimage.png)](https://docs.finmars.com/uploads/images/gallery/2025-05/7gTimage.png)

<span style="white-space: pre-wrap;">After selecting the desired instrument, click the </span>****“Add”****<span style="white-space: pre-wrap;"> button to load it into the system.</span>

# Counterparty

It's other party or entity involved in a transaction.

# Counterparty

#### **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 **counterparty** is any party — individual or organization — that participates in a financial transaction from the opposite side. In capital markets and investment platforms, counterparties include brokers, banks, issuers, custodians, and clients.

##### *Platform abstraction*

In the Finmars platform, **Counterparty** is a master data entity used to associate financial [transactions](https://docs.finmars.com/books/entities/page/transactions "Transactions"), [portfolios](https://docs.finmars.com/books/entities/page/portfolio "Portfolio"), and [registers ](https://docs.finmars.com/books/entities/page/register "Register")with external trading parties.

**Counterparty also is used in:**

- As a reference for identifying the external trading party involved in a [transaction](https://docs.finmars.com/books/entities/page/transactions "Transactions").
- position settlement, linked with [portfolio ](https://docs.finmars.com/books/entities/page/portfolio "Portfolio")to reflect obligations per counterparty.
- cash flow tracking, where it is associated with [account](https://docs.finmars.com/books/entities/page/accounts "Accounts") to record inflows and outflows per counterparty;

#### **Examples**

<table border="1" id="bkmrk-user-code%C2%A0-group%C2%A0-sh" style="border-collapse: collapse; width: 100%;"><colgroup><col style="width: 16.6891%;"></col><col style="width: 16.6891%;"></col><col style="width: 16.6891%;"></col><col style="width: 16.6891%;"></col><col style="width: 16.6891%;"></col><col style="width: 16.6891%;"></col></colgroup><tbody><tr><td>User code </td><td>Group </td><td>Short name </td><td>Name </td><td>Public name </td><td>Notes </td></tr><tr><td>CH-BND-20394857</td><td>  
</td><td>Am\_test01\_</td><td>Am Test01</td><td>  
</td><td>  
</td></tr></tbody></table>

- `<strong data-end="187" data-start="174">User code</strong>`: unique identifier assigned to the counterparty. Used for internal reference and tracking.
- `Group`: a logical classification that allows grouping counterparties by type, role, or business relationship. Useful for filtering and reporting.
- `<strong data-end="991" data-start="977">Short name</strong>`: abbreviated or condensed label for quick reference.
- `<strong data-end="1097" data-start="1089">Name</strong>`: the full legal or registered name of the counterparty as used internally and in official documentation.
- `<strong data-end="1211" data-start="1196">Public name</strong>`: market-facing or external name of the instrument, often matching how it appears on exchanges or public reports.
- `<strong data-end="2170" data-start="2161">Notes</strong>`: free-text field for comments or special handling notes related to the counterparty.

#### **Cookbook**

##### *CRUD* 

Operations within platform.

##### *Use Cases*

What for it's used.

#### **F.A.Q.**

Frequently asked questions.

#### **API documentation**

Link to API documentation.

# How to Create a Counterparty 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 Counterparty 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> ****“Counterparties”**** <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 040557.png](https://docs.finmars.com/uploads/images/gallery/2025-05/scaled-1680-/snimok-ekrana-2025-05-06-040557.png)](https://docs.finmars.com/uploads/images/gallery/2025-05/scaled-1680-/snimok-ekrana-2025-05-06-040557.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 040603.png](https://docs.finmars.com/uploads/images/gallery/2025-05/scaled-1680-/snimok-ekrana-2025-05-06-040603.png)](https://docs.finmars.com/uploads/images/gallery/2025-05/scaled-1680-/snimok-ekrana-2025-05-06-040603.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="color: rgb(170, 170, 170); background-color: rgb(34, 34, 34); white-space: pre-wrap;"> </span>****Counterparty**** <span style="color: rgb(170, 170, 170); background-color: rgb(34, 34, 34);">form.</span>  
    [![Снимок экрана 2025-05-06 040613.png](https://docs.finmars.com/uploads/images/gallery/2025-05/scaled-1680-/snimok-ekrana-2025-05-06-040613.png)](https://docs.finmars.com/uploads/images/gallery/2025-05/scaled-1680-/snimok-ekrana-2025-05-06-040613.png)
4. ****Fill in the required fields in the creation panel:****
5. 1. ****Counterparty****<span style="white-space: pre-wrap;"> – full name or identifier for the counterparty (required). This can be a bank, broker, client, or any financial entity you deal with.</span>
    2. ****Group****<span style="white-space: pre-wrap;"> </span>**–** used to organize counterparties into categories such as “Banks,” “Funds,” “Clients,” etc.
    3. ****Notes****<span style="white-space: pre-wrap;"> </span>**–**<span style="white-space: pre-wrap;"> any additional internal comments or metadata for the counterparty.</span>  
        [![copy 3.png](https://docs.finmars.com/uploads/images/gallery/2025-05/scaled-1680-/copy-3.png)](https://docs.finmars.com/uploads/images/gallery/2025-05/scaled-1680-/copy-3.png)
6. <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>

# Currency

An entity representing a standardized unit of exchange used in financial transactions and asset valuation.

# Currency

#### **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*

**Currency** is a system of money used in a particular country or region to facilitate trade, value goods/services, and store wealth. It is a **medium of exchange**, a **unit of account**, and a **store of value**—the three key functions of money in economics.

##### *Platform abstraction*

**Currency** in the Finmars platform is a reference entity that represents monetary units used across all financial operations, including [transactions](https://docs.finmars.com/books/entities/page/transactions "Transactions"), valuations, and [reporting](https://docs.finmars.com/books/reports "Reports"). Currencies are linked to [instruments](https://docs.finmars.com/books/entities/page/instrument "Instrument"), [portfolios](https://docs.finmars.com/books/entities/page/portfolio "Portfolio"), and other modules where value tracking is required.

**Currency also is used in:**

- instrument pricing and valuation with base currency association
- cash positioning within [portfolios](https://docs.finmars.com/books/entities/page/portfolio "Portfolio") as part of asset allocation
- [reporting ](https://docs.finmars.com/books/reports "Reports")in multiple currencies using [FX rate ](https://docs.finmars.com/books/entities/page/fx-rate-currency-history-eN8 "FX Rate (Currency History)")conversions
- [reconciliation](https://docs.finmars.com/books/reports/chapter/reconciliation "Reconciliation") by matching positions and [transactions](https://docs.finmars.com/books/entities/chapter/transactions "Transactions") by currency

#### **Examples**

<table border="1" id="bkmrk-user-code-country-sh" 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>**Country**</td><td>**Short Name**</td><td>**Name**</td><td>**Public Name**</td><td>**Notes**</td></tr><tr><td>EUR</td><td>Europe</td><td>EUR</td><td>Euro</td><td>EUR</td><td>  
</td></tr></tbody></table>

- `<strong data-end="184" data-start="171">User code</strong>:` internal system identifier for the currency.
- `<strong data-end="314" data-start="303">Country</strong>`: the country or region that officially issues or predominantly uses the currency (e.g., "Switzerland" for CHF, "Europe" for EUR); "Worldwide" used for globally recognized assets like BTC, Silver (XAG), or Palladium (XPD).
- `<strong data-end="554" data-start="540">Short name</strong>`: standard currency code (typically ISO 4217 format), used across the system in relations, selections, and dropdowns (e.g., "USD", "GBP", "BTC").
- `<strong data-end="711" data-start="703">Name</strong>`: full name of the currency (e.g., "US Dollar", "Pound Sterling", "Bitcoin") used in detailed views or documentation.
- `<strong data-end="847" data-start="832">Public name</strong>`: display name for external users or limited-access users, often identical to the short name (e.g., "EUR", "HKD"); controls visibility in shared environments.
- `<strong data-end="1018" data-start="1009">Notes</strong>`: optional field for internal comments, labels, or usage notes – can be left blank or filled with custom metadata (e.g., restrictions, FX rules, system flags).

#### **Cookbook**

##### *CRUD* 

Operations within platform.

##### *Use Cases*

What for it's used.

#### **F.A.Q.**

Frequently asked questions.

#### **API documentation**

Link to API documentation.

# How to Create a Currency 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 Currency Entity

[](https://docs.finmars.com/books/entities/page/how-to-create-a-register-entity/edit?content-id=bkmrk-open-the-%E2%80%9Cdata%E2%80%9D-sect&content-text=Open%20the%20%E2%80%9CData%E2%80%9D%20section%20in%20the%20left-hand%20side%20menu "Jump to section in editor")

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> ****“Currency”**** <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 035244.png](https://docs.finmars.com/uploads/images/gallery/2025-05/scaled-1680-/snimok-ekrana-2025-05-06-035244.png)](https://docs.finmars.com/uploads/images/gallery/2025-05/scaled-1680-/snimok-ekrana-2025-05-06-035244.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 035251.png](https://docs.finmars.com/uploads/images/gallery/2025-05/scaled-1680-/snimok-ekrana-2025-05-06-035251.png)](https://docs.finmars.com/uploads/images/gallery/2025-05/scaled-1680-/snimok-ekrana-2025-05-06-035251.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 035301.png](https://docs.finmars.com/uploads/images/gallery/2025-05/scaled-1680-/snimok-ekrana-2025-05-06-035301.png)](https://docs.finmars.com/uploads/images/gallery/2025-05/scaled-1680-/snimok-ekrana-2025-05-06-035301.png)
4. ****Fill in the required fields in the creation panel:****
    1. ****Currency**** – enter the full name of the currency. This typically follows the ISO 4217 format (e.g., USD, EUR, CHF).
    2. ****Public name**** – optional field for external-facing labels, if different from internal naming.
    3. ****Country****<span style="white-space: pre-wrap;"> – select the issuing country for context/reference. This may be used in filters or reports.</span>
    4. ****Notes****<span style="white-space: pre-wrap;"> – add any internal notes for clarification or documentation purposes.</span>
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>

# Transactions

Records of financial activities affecting assets or cash.

# Transactions

#### **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*

Transactions in an investment platform represent **any economic activity** that results in a **change of ownership, value, or cash position** of financial instruments or related accounts. They are the **building blocks** of portfolio management, accounting, performance analysis, and compliance.

##### *Platform abstraction*

**Transaction** in the Finmars platform is a fundamental entity that represents any economic action involving a financial instrument, cash, or both. Transactions serve as the **source of truth for portfolio activity**, capturing events such as purchases, sales, income, redemptions, and other movements.

**Transaction** also is used in:

- valuation, serving as inputs for position lifecycle, pricing, and performance.
- [**reconciliation**](https://docs.finmars.com/books/reports/chapter/reconciliation "Reconciliation"), comparing expected vs. actual positions and cash events.
- reporting, providing raw and derived data for trade activity, cash analysis, and compliance.
- accounting, enabling P&amp;L, fee, tax, and ledger mapping through transaction classification.

#### **Examples**

**First part of table**

<table border="1" id="bkmrk-txn-id-date-source-d" style="border-collapse: collapse; width: 100%;"><colgroup><col style="width: 10.0132%;"></col><col style="width: 9.0596%;"></col><col style="width: 8.22517%;"></col><col style="width: 8.70199%;"></col><col style="width: 11.2053%;"></col><col style="width: 9.53642%;"></col><col style="width: 9.89404%;"></col><col style="width: 8.10596%;"></col><col style="width: 13.8289%;"></col><col style="width: 11.5618%;"></col></colgroup><tbody><tr><td>**TXN ID**</td><td>**Date**</td><td>**Source**</td><td>**Date (Trade)**</td><td>**Description**</td><td>**Date (Value)**</td><td>**TXN TYPE**</td><td>**CCY STL**</td><td>**Cash Consideration**</td><td>**Instrument**</td></tr><tr><td>20240125001.0</td><td>2025-02-13</td><td>std.file</td><td>2022-12-03</td><td>Buy : Instrument: TREASURY BILL 0.00% </td><td>2022-12-05</td><td>Buy</td><td>USD</td><td>-1'654'021.90</td><td>TREASURY BILL 0.00% 25-Jan-2024</td></tr></tbody></table>

**Second part of table**

<table border="1" id="bkmrk-isin-position-%28adjus" style="border-collapse: collapse; width: 100%;"><colgroup><col style="width: 6.7947%;"></col><col style="width: 10.8477%;"></col><col style="width: 10.3709%;"></col><col style="width: 9.77483%;"></col><col style="width: 10.4901%;"></col><col style="width: 10.8477%;"></col><col style="width: 11.0858%;"></col><col style="width: 10.3712%;"></col><col style="width: 11.8013%;"></col><col style="width: 7.74834%;"></col></colgroup><tbody><tr><td>**ISIN**</td><td>**Position (Adjusted)**</td><td>**Account (Cash)**</td><td>**Portfolio**</td><td>**Status (Reversed)**</td><td>**Status (Cancelled)**</td><td>**Reference Transaction ID**</td><td>**Allocation (PL)**</td><td>**Linked Instruments**</td><td>**Notes**</td></tr><tr><td>USP</td><td>-303.90</td><td>US4508411200000</td><td>CH-BND-203948</td><td>0.0</td><td>-</td><td>None</td><td>TREASURY BILL 0.00% 25-Jan-2024</td><td>TREASURY BILL 0.00% 25-Jan-2024</td><td>  
</td></tr></tbody></table>

- `<strong data-end="1174" data-start="1164">TXN ID (Transaction ID)</strong>`: unique transaction ID within the platform.
- `<strong data-end="1230" data-start="1222">Date</strong>`: date when the transaction was recorded in the system.
- `<strong data-end="1299" data-start="1289">Source</strong>`: origin of the transaction data (e.g., `std_file` for standard imported file).
- `<strong data-end="1398" data-start="1382">Date (Trade)</strong>`: actual trade date when the transaction was executed.
- `<strong data-end="1472" data-start="1456">Date (Value)</strong>`: value date when the transaction becomes effective in financial terms.
- `<strong data-end="1562" data-start="1547">Description</strong>`: freeform description of the transaction (typically includes action and instrument).
- `<strong data-end="1663" data-start="1651">TXN TYPE (Transaction type)</strong>`: transaction type (e.g., Buy, Sell, Coupon, Deposit).
- `<strong data-end="1732" data-start="1721">CCY STL</strong>`: settlement currency used in the transaction.
- `<strong data-end="1804" data-start="1782">Cash Consideration</strong>`: monetary amount of the transaction (net cash inflow/outflow).
- `<strong data-end="168" data-start="154">Instrument</strong>`: name of the financial instrument involved in the transaction.
- `<strong data-end="243" data-start="235">ISIN</strong>`: international identifier for the security (International Securities Identification Number).
- `<strong data-end="363" data-start="340">Position (Adjusted)</strong>`: net change in instrument quantity after transaction adjustment.
- `<strong data-end="450" data-start="432">Account (Cash)</strong>`: cash account associated with the transaction's payment or settlement.
- `<strong data-end="538" data-start="525">Portfolio</strong>`: unique portfolio identifier that the transaction is associated with.
- `<strong data-end="633" data-start="612">Status (Reversed)</strong>`: flag indicating whether the transaction has been reversed.
- `<strong data-end="719" data-start="697">Status (Cancelled)</strong>`: flag indicating whether the transaction has been cancelled.
- `<strong data-end="812" data-start="784">Reference Transaction ID</strong>`: ID of a related or referenced transaction.
- `<strong data-end="911" data-start="892">Allocation (PL)</strong>`: categorization of the transaction for performance or reporting purposes.
- `<strong data-end="1010" data-start="989">Linked Instrument</strong>`: related instrument (if transaction is part of a structured deal or derivative).
- `<strong data-end="1104" data-start="1095">Notes</strong>`: user-defined comments or notes about the transaction.

#### **Cookbook**

##### *CRUD* 

Operations within platform.

##### *Use Cases*

What for it's used.

#### **F.A.Q.**

Frequently asked questions.

#### **API documentation**

Link to API documentation.

# Pricing Policy

It's a set of prices for products or services, defining how they are structured and applied.

# Pricing Policy

#### **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*

**Pricing Policy** defines the methodology or rule set used to determine financial values, such as Fx Rates or instrument prices on a specific date. It ensures consistent and transparent valuation practices across portfolios and transactions.

##### *Platform abstraction*

In the **Finmars platform**, a **Pricing Policy** is a system-defined entity that determines how [prices ](https://docs.finmars.com/books/entities/page/price "Price")and [FX rates ](https://docs.finmars.com/books/entities/page/fx-rate-currency-history "FX Rate (Currency History)")are sourced, calculated, and maintained. It directly influences data handling in valuations, [reporting](https://docs.finmars.com/books/reports "Reports"), and [reconciliation](https://docs.finmars.com/books/reports/chapter/reconciliation "Reconciliation").

Pricing Policy types:

1. **Master –** Combines all other Pricing Policies in the Workspace. The compilation follows a configured order, and the Master Pricing Policy is mandatory for use in reports to ensure consistent aggregation logic.
2. **Rolled Master –** Designed to include rolled prices and FX rates. The rolling method is defined by a dedicated rolling pricing module, allowing dynamic calculation based on available data.
3. **Standard –** Applied when prices or rates are manually created or imported. It provides a straightforward structure for static or user-defined pricing.

**Pricing Policy also is used in:**

- valuation workflows, where it governs how instrument prices and [FX rates ](https://docs.finmars.com/books/entities/page/fx-rate-currency-history-eN8 "FX Rate (Currency History)")are sourced and applied based on policy type.
- [report ](https://docs.finmars.com/books/reports "Reports")generation, with the **Master** Pricing Policy ensuring consistent aggregation across [portfolios ](https://docs.finmars.com/books/entities/page/portfolio "Portfolio")and [transactions](https://docs.finmars.com/books/entities/page/transactions "Transactions").
- data imports and manual adjustments, where the **Standard** policy is used to apply static or user-defined [prices ](https://docs.finmars.com/books/entities/page/price "Price")and [FX rates](https://docs.finmars.com/books/entities/page/fx-rate-currency-history-eN8 "FX Rate (Currency History)").
- rolling calculations, where the **Rolled Master** policy enables dynamic valuation using time-series data through a rolling pricing module.
- [reconciliation ](https://docs.finmars.com/books/reports/chapter/reconciliation "Reconciliation")processes, supporting comparison of expected vs. actual [prices](https://docs.finmars.com/books/entities/page/price "Price") and rates.
- workspace configuration, where different Pricing Policies are assigned to ensure each [portfolio](https://docs.finmars.com/books/entities/page/portfolio-type "Portfolio Type") or [transaction type](https://docs.finmars.com/books/entities/page/transaction-type "Transaction Type") follows the appropriate pricing logic.

#### **Examples**

<table border="1" id="bkmrk-name-unique-code-not" style="border-collapse: collapse; width: 100%;"><colgroup><col style="width: 33.3333%;"></col><col style="width: 33.3333%;"></col><col style="width: 33.3333%;"></col></colgroup><tbody><tr><td>**Name**</td><td>**Unique Code**</td><td>**Notes**</td></tr><tr><td>Standard</td><td>com.finmars.standard-pricing:standard</td><td>Pricing Policy for Manual Import and Manually Created.</td></tr></tbody></table>

1. `<strong data-end="135" data-start="127">Name</strong>`: full descriptive name of the pricing policy.
2. `<strong data-end="329" data-start="314">Unique Code</strong>`: system-wide unique identifier for the pricing policy ( (e.g. com.finmars.standard-pricing:standard ).
3. `<strong data-end="493" data-start="484">Notes</strong>`: optional free-text field for internal documentation, detailing assumptions, special rules, or customizations related to the pricing logic

#### **Cookbook**

##### *CRUD* 

Operations within platform.

##### *Use Cases*

What for it's used.

#### **F.A.Q.**

Frequently asked questions.

#### **API documentation**

Link to API documentation.

# How to Create a Pricing Policy entity

## Prerequisites

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

[](https://docs.finmars.com/books/entities/page/how-to-create-a-currency-entity/edit?content-id=bkmrk-vpn-configured-%28prov&content-text=If%20needed%3A%20the%20VPN%20is%20configured%20to%20access%20the%20Fin "Jump to section in editor")

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 Pricing Policy Entity

1. <span style="color: rgb(170, 170, 170); background-color: rgb(34, 34, 34);">Open the</span> ****“Configuration”**** <span style="color: rgb(170, 170, 170); background-color: rgb(34, 34, 34);">section in the left-hand side menu. Select the</span> ****“Pricing Policies”**** <span style="color: rgb(170, 170, 170); background-color: rgb(34, 34, 34);">entity.</span>  
    [![Снимок экрана 2025-05-08 050733.png](https://docs.finmars.com/uploads/images/gallery/2025-05/scaled-1680-/snimok-ekrana-2025-05-08-050733.png)](https://docs.finmars.com/uploads/images/gallery/2025-05/scaled-1680-/snimok-ekrana-2025-05-08-050733.png)
2. You will be directed to a page displaying a list of existing pricing policies.  
    [![Снимок экрана 2025-05-08 050752.png](https://docs.finmars.com/uploads/images/gallery/2025-05/scaled-1680-/snimok-ekrana-2025-05-08-050752.png)](https://docs.finmars.com/uploads/images/gallery/2025-05/scaled-1680-/snimok-ekrana-2025-05-08-050752.png)
3. <span style="white-space: pre-wrap;">Scroll down to the bottom of the list and click the </span>****Add new****<span style="white-space: pre-wrap;"> button.</span>  
    [![copy 5.png](https://docs.finmars.com/uploads/images/gallery/2025-05/scaled-1680-/copy-5.png)](https://docs.finmars.com/uploads/images/gallery/2025-05/scaled-1680-/copy-5.png)
4. <span style="color: rgb(170, 170, 170); background-color: rgb(34, 34, 34); white-space: pre-wrap;">This action opens the </span>****Create Pricing Policy****<span style="color: rgb(170, 170, 170); background-color: rgb(34, 34, 34); white-space: pre-wrap;"> form.</span>  
    [![Снимок экрана 2025-05-08 050816.png](https://docs.finmars.com/uploads/images/gallery/2025-05/scaled-1680-/snimok-ekrana-2025-05-08-050816.png)](https://docs.finmars.com/uploads/images/gallery/2025-05/scaled-1680-/snimok-ekrana-2025-05-08-050816.png)
5. ****Fill in the following fields:****
    1. ****Name****<span style="white-space: pre-wrap;"> – the name of the pricing policy.</span>
    2. ****Configuration Code****<span style="white-space: pre-wrap;"> – select from the dropdown menu.</span>
    3. ****User Code****<span style="white-space: pre-wrap;"> – enter a user code using only lowercase letters (</span>`<span class="editor-theme-code">a–z</span>`), numbers (`<span class="editor-theme-code">0–9</span>`), and special characters: underscore (`<span class="editor-theme-code">_</span>`) or dash (`<span class="editor-theme-code">-</span>`).
    4. ****Notes****<span style="white-space: pre-wrap;"> – any additional comments or context.</span>
6. <span style="white-space: pre-wrap;">Once all required data is filled out, click </span>****Save****<span style="white-space: pre-wrap;"> to create the new pricing policy.</span>  
    [![copy 6.png](https://docs.finmars.com/uploads/images/gallery/2025-05/scaled-1680-/copy-6.png)](https://docs.finmars.com/uploads/images/gallery/2025-05/scaled-1680-/copy-6.png)

# Bundle

Group of related portfolios or registers for analysis

# Portfolio Bundle

#### **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 **portfolio bundle** is a logical grouping of multiple portfolios that are managed, monitored, or processed together. It allows combining different portfolios under a single structure for operational efficiency, consolidated reporting, or grouped reconciliation.

##### *Platform abstraction*

In the Finmars platform, a **Portfolio Bundle** serves as an entity that links several [portfolios](https://docs.finmars.com/books/entities/page/portfolio "Portfolio") into a single operational unit.

**Portfolio Bundles are used in:**

- Grouping multiple [portfolios ](https://docs.finmars.com/books/entities/page/portfolio "Portfolio")together to allow consolidated views for valuation, [reporting](https://docs.finmars.com/books/reports "Reports"), and performance analysis.
- Enabling aggregated [reconciliation ](https://docs.finmars.com/books/reports/chapter/reconciliation "Reconciliation")workflows by combining cash and position data across bundled portfolios.
- Allowing batch operations and monitoring across multiple [portfolios ](https://docs.finmars.com/books/entities/page/portfolio "Portfolio")in operational workflows.

#### **Examples**

<table border="1" id="bkmrk-name-unique-code-not" style="border-collapse: collapse; width: 100%;"><colgroup><col style="width: 33.3333%;"></col><col style="width: 33.3333%;"></col><col style="width: 33.3333%;"></col></colgroup><tbody><tr><td>**Name**</td><td>**Unique Code**</td><td>**Notes**</td></tr><tr><td>CH-BND-20394857</td><td>CH-BND-20394857</td><td>  
</td></tr></tbody></table>

- `<strong data-end="107" data-start="99">Name</strong>`: Display name of the portfolio or bundle, used for identification in the interface.
- `<strong data-end="209" data-start="194">Unique Code</strong>`: System-generated unique identifier for the portfolio or bundle, used for internal references and linking.
- `<strong data-end="328" data-is-only-node="" data-start="319">Notes</strong>`: Additional comments or descriptions to provide operational or contextual information.

#### **Cookbook**

##### *CRUD* 

Operations within platform.

##### *Use Cases*

What for it's used.

#### **F.A.Q.**

Frequently asked questions.

#### **API documentation**

Link to API documentation.

# How to Create a Portfolio Bundle 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

[](https://docs.finmars.com/books/entities/page/how-to-create-a-counterparty-entity/edit?content-id=bkmrk-creation-of-counterp&content-text=Creation%20of%20Counterparty%20Entity "Jump to section in editor")

## Creation of Counterparty Entity

1. <span style="white-space: pre-wrap;">Navigate to the </span>****“Configuration”****<span style="white-space: pre-wrap;"> section from the left-side menu. Under Configuration, select the </span>****“Data Settings”****<span style="white-space: pre-wrap;"> subsection.</span>  
    [![Снимок экрана 2025-05-08 044057.png](https://docs.finmars.com/uploads/images/gallery/2025-05/scaled-1680-/snimok-ekrana-2025-05-08-044057.png)](https://docs.finmars.com/uploads/images/gallery/2025-05/scaled-1680-/snimok-ekrana-2025-05-08-044057.png)
2. <span style="white-space: pre-wrap;">In the list of available options, click on </span>****“Portfolio Bundle.”****  
    [![Снимок экрана 2025-05-08 044158.png](https://docs.finmars.com/uploads/images/gallery/2025-05/scaled-1680-/snimok-ekrana-2025-05-08-044158.png)](https://docs.finmars.com/uploads/images/gallery/2025-05/scaled-1680-/snimok-ekrana-2025-05-08-044158.png)
3. <span style="white-space: pre-wrap;">You will see a list of existing bundles. Scroll down to the bottom of the page and click the </span>****“Add New”****<span style="white-space: pre-wrap;"> button.</span>  
    [![Снимок экрана 2025-05-08 044235.png](https://docs.finmars.com/uploads/images/gallery/2025-05/scaled-1680-/snimok-ekrana-2025-05-08-044235.png)](https://docs.finmars.com/uploads/images/gallery/2025-05/scaled-1680-/snimok-ekrana-2025-05-08-044235.png)
4. This opens the Portfolio Bundle creation page.  
    [![Снимок экрана 2025-05-08 044343.png](https://docs.finmars.com/uploads/images/gallery/2025-05/scaled-1680-/snimok-ekrana-2025-05-08-044343.png)](https://docs.finmars.com/uploads/images/gallery/2025-05/scaled-1680-/snimok-ekrana-2025-05-08-044343.png)
5. <span style="white-space: pre-wrap;"> Fill in the following fields:</span>
    1. ****Name****<span style="white-space: pre-wrap;"> – provide a name for the new bundle.</span>
    2. ****User Code****<span style="white-space: pre-wrap;"> – enter a unique identifier or code for internal reference.</span>
    3. ****Notes****<span style="white-space: pre-wrap;"> – optional field for internal comments or description.</span>
    4. ****Portfolios Multiselector****<span style="white-space: pre-wrap;"> – use the multiselector to choose one or more portfolios to include in the bundle.</span>
6. Once all required information is entered, save the bundle using "****Save****" button.  
    [![Снимок экрана 2025-05-08 044351.png](https://docs.finmars.com/uploads/images/gallery/2025-05/scaled-1680-/snimok-ekrana-2025-05-08-044351.png)](https://docs.finmars.com/uploads/images/gallery/2025-05/scaled-1680-/snimok-ekrana-2025-05-08-044351.png)

# Price

Market or calculated value of an instrument at a given time.

# Price

#### **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*

Prices represent the market value or quoted price of a financial instrument at a specific point in time. They are essential for valuation, performance measurement, and accurate reporting across financial systems.

##### *Platform abstraction*

In the Finmars platform, a Price is a separate entity linked to an [Instrument ](https://docs.finmars.com/books/entities/page/instrument "Instrument")and dated to a specific moment. Each price entry stores the principal value, accrued interest component (for debt instruments), a[ pricing policy](https://docs.finmars.com/books/entities/page/pricing-policy "Pricing Policy") identifier (e.g., Standard, Custom), and valuation-related fields like Yield to Maturity (YTM) and Duration.

**Prices are used in:**

- Providing market or modeled values for [instruments ](https://docs.finmars.com/books/entities/page/instrument "Instrument")held in [portfolios](https://docs.finmars.com/books/entities/page/portfolio "Portfolio").
- Defining end-of-day valuations and snapshots for asset positions.
- Supporting duration, yield, and factor-based sensitivity analyses.
- Assisting in generating fair value [reports](https://docs.finmars.com/books/reports "Reports"),[ P&amp;L](https://docs.finmars.com/books/marscapital/chapter/pl-report "P&L Report"), and balance sheet entries.

#### **Examples**

<table border="1" id="bkmrk-instrument-date-pric" style="border-collapse: collapse; width: 100%;"><colgroup><col style="width: 11.6813%;"></col><col style="width: 10.4909%;"></col><col style="width: 11.0861%;"></col><col style="width: 11.0861%;"></col><col style="width: 11.0861%;"></col><col style="width: 11.0861%;"></col><col style="width: 11.0861%;"></col><col style="width: 11.0861%;"></col><col style="width: 11.0861%;"></col></colgroup><tbody><tr><td>**Instrument**</td><td>**Date**</td><td>**Pricing Policy**</td><td>**Principal Price**</td><td>**Accrued Price**</td><td>**Factor**</td><td>**YTM**</td><td>**Modified Duration**</td><td>**Is Temporary Price**</td></tr><tr><td>BAIDU INC</td><td>2023-03-14</td><td>Standard</td><td>144.9500</td><td>0.000</td><td>1</td><td>0.00</td><td>0.000</td><td>False</td></tr></tbody></table>

- `Instrument`: name or identifier of the financial instrument.
- `Date`: the date for which the price is recorded.
- `Pricing Policy`: method used for price calculation (e.g., Standard).
- `Principal Price`: main price of the instrument excluding accrued interest.
- `Accrued Price`: accumulated interest up to the pricing date.
- `Factor`: multiplier used to adjust the nominal or market value of the instrument.
- `YTM`: yield to maturity, representing the expected return if the instrument is held until maturity.
- `Modified Duration`: measure of the price sensitivity of the instrument to interest rate changes.
- `Is Temporary Price`: flag indicating if the price is temporary (`True` or `False`).

#### **Cookbook**

##### *CRUD* 

Operations within platform.

##### *Use Cases*

What for it's used.

#### **F.A.Q.**

Frequently asked questions.

#### **API documentation**

Link to API documentation.

# How to Create a Price 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 Price Entity

1. <span style="color: rgb(170, 170, 170); background-color: rgb(34, 34, 34);">Open the</span> ****“Valuation”**** <span style="color: rgb(170, 170, 170); background-color: rgb(34, 34, 34);">section in the left-hand side menu. Select the</span> ****“Price”**** <span style="color: rgb(170, 170, 170); background-color: rgb(34, 34, 34); white-space: pre-wrap;">entity from the list under </span>****Valuation****<span style="color: rgb(170, 170, 170); background-color: rgb(34, 34, 34);">.</span>  
    [![Снимок экрана 2025-05-08 045350.png](https://docs.finmars.com/uploads/images/gallery/2025-05/scaled-1680-/snimok-ekrana-2025-05-08-045350.png)](https://docs.finmars.com/uploads/images/gallery/2025-05/scaled-1680-/snimok-ekrana-2025-05-08-045350.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-08 045357.png](https://docs.finmars.com/uploads/images/gallery/2025-05/scaled-1680-/snimok-ekrana-2025-05-08-045357.png)](https://docs.finmars.com/uploads/images/gallery/2025-05/scaled-1680-/snimok-ekrana-2025-05-08-045357.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 Price history** <span style="color: rgb(170, 170, 170); background-color: rgb(34, 34, 34);">form.</span>  
    [![Снимок экрана 2025-05-08 045414.png](https://docs.finmars.com/uploads/images/gallery/2025-05/scaled-1680-/snimok-ekrana-2025-05-08-045414.png)](https://docs.finmars.com/uploads/images/gallery/2025-05/scaled-1680-/snimok-ekrana-2025-05-08-045414.png)
4. ****Fill out the following fields as needed:****
    1. ****Instrument****<span style="white-space: pre-wrap;"> – select the full name or unique identifier of the instrument (required).</span>
    2. ****Date****<span style="white-space: pre-wrap;"> – the date when the price is recorded, in </span>`<span class="editor-theme-code">yyyy-mm-dd</span>`<span style="white-space: pre-wrap;"> format (required).</span>
    3. ****Pricing Policy****<span style="white-space: pre-wrap;"> – select the pricing policy used for valuation.</span>
    4. ****Principal Price****<span style="white-space: pre-wrap;"> – main market price of the instrument (e.g., 100).</span>
    5. ****Accrued Price****<span style="white-space: pre-wrap;"> – the accrued interest or price component (e.g., 0).</span>
    6. ****Factor****<span style="white-space: pre-wrap;"> – scaling factor for partial repayments or amortization (e.g., 1 or 0.95).</span>
    7. ****YTM****<span style="white-space: pre-wrap;"> – yield to maturity as a percentage (e.g., 4.5).</span>
    8. ****Modified Duration****<span style="white-space: pre-wrap;"> – interest rate sensitivity measure (e.g., 2.3).</span>
    9. ****Is Temporary Price****<span style="white-space: pre-wrap;"> – optional checkbox; leave empty or check to mark the price as temporary.</span>
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>  
    [![copy4.png](https://docs.finmars.com/uploads/images/gallery/2025-05/scaled-1680-/copy4.png)](https://docs.finmars.com/uploads/images/gallery/2025-05/scaled-1680-/copy4.png)

# Portfolio Type

#### **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*

**Portfolio Type** has no specific financial meaning, it's a logical configure-defined classification of the portfolios, help to differentiate manual portfolios from transaction and position based portfolios.

##### *Platform abstraction*

**Portfolio Type** is an entity designed as a criterion for comparing portfolios against each other, defining configured-defined groups with the Portfolio Classes. **Portfolio Classes** represents the primary attribute, with pre-defined classes for reconciliation calculation and filtering purposes in the reports, entity viewers:

- `General Portfolio`: Consists of banking transactions and/or a combination of initial positions and banking transactions.
- `Manual Managed Portfolio`: Managed through manual transaction booking within the system or imported from the client's internal manual tracking systems for bank verification purposes.
- `Position Only Portfolio`: Focuses on importing balance states for a specific day using Daily Positions/Cash transaction types.

**It's used in:**

- [reconciliation](https://docs.finmars.com/books/reports/chapter/reconciliation "Reconciliation") using [portfolio](https://docs.finmars.com/books/entities/chapter/portfolio "Portfolio") and [portfolio reconcile group](https://docs.finmars.com/books/entities/page/portfolio-reconcile-group "Portfolio Reconcile Group").

#### **Examples**

<table border="1" id="bkmrk-user-code-portfolio-" style="border-collapse: collapse; width: 100%; height: 76.5452px;"><colgroup><col style="width: 14.2857%;"></col><col style="width: 14.2857%;"></col><col style="width: 14.2857%;"></col><col style="width: 14.2857%;"></col><col style="width: 14.2857%;"></col><col style="width: 14.2857%;"></col><col style="width: 14.2857%;"></col></colgroup><tbody><tr style="height: 46.6667px;"><td style="height: 46.6667px;">**User code**</td><td style="height: 46.6667px;">**Portfolio class**</td><td style="height: 46.6667px;">**Short name**</td><td style="height: 46.6667px;">**Name**</td><td style="height: 46.6667px;">**Public name** </td><td style="height: 46.6667px;">**Notes** </td><td style="height: 46.6667px;">**Configuration code**</td></tr><tr style="height: 29.8785px;"><td style="height: 29.8785px;">com.finmars.standard-other:portfolios.portfoliotype:general</td><td style="height: 29.8785px;">General Portfolio</td><td style="height: 29.8785px;">General Portfolio</td><td style="height: 29.8785px;">General Portfolio</td><td style="height: 29.8785px;">  
</td><td style="height: 29.8785px;">  
</td><td style="height: 29.8785px;">com.finmars.standard-other</td></tr></tbody></table>

- `<strong data-end="158" data-start="145">User code</strong>`: workspace-unique identifier of the portfolio type with source prefix
- `<strong data-end="288" data-start="269">Portfolio class</strong>`: classification used to define general behavior or usage category of the portfolio (e.g., General, Manual Managed)
- `<strong data-end="422" data-start="408">Short name</strong>`: compact label shown in lists and relations for easier navigation
- `<strong data-end="501" data-start="493">Name</strong>`: full descriptive name of the portfolio type
- `<strong data-end="566" data-start="551">Public name</strong>`: label shown to users without configuration access; often used in reports
- `<strong data-end="654" data-start="645">Notes</strong>`: optional custom description or comment field for internal purposes
- `<strong data-end="749" data-start="727">Configuration code</strong>`: reference to the configuration source that governs the behavior of this portfolio type

#### **Cookbook**

##### *CRUD* 

- **Create:** A new portfolio type can be created using the "+" button in the upper-right corner of the page. Users must provide the configuration code, user code, portfolio class, short name, name, public name, and optional notes.
- **Read:** The same page provides a list of all existing portfolio types. Users can search, filter, and review attributes such as class, names, and configuration references.
- **Update:** To edit a portfolio type, users can click on an existing entry to open the edit form. All fields—except those constrained by platform rules—can be modified, including the classification and public-facing labels.
- **Delete:** Portfolio types can be deleted directly from the management page.

##### *Use Cases*

- Portfolio Types help categorize portfolios by behavior, such as whether they are general-purpose, manually managed, or used solely for reconciliation. These classifications are leveraged in reporting filters and entity viewers.
- Fields like Short Name and Public Name allow different representations for internal use and external presentation. This is useful in environments where access permissions differ across user roles.

#### **F.A.Q.**

Frequently asked questions.

#### **API documentation**

Link to API documentation.

# Portfolio Reconcile Group



# Register Records

#### **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*

Register Records represent individual transaction entries that record cash movements, share [transactions](https://docs.finmars.com/books/entities/chapter/transactions "Transactions"), and valuation events within a [portfolio](https://docs.finmars.com/books/entities/page/portfolio "Portfolio"). They ensure that all changes in portfolio value and structure are properly documented and traceable.

##### *Platform abstraction*

A Register Record in the Finmars used to track, value, and reconcile all [transactions ](https://docs.finmars.com/books/entities/page/transactions "Transactions")related to a [portfolio](https://docs.finmars.com/books/entities/page/portfolio "Portfolio"). They support accurate NAV calculations, historical transaction analysis, and operational audits within the investment platform.

**Register Record also is used in:**

- portfolio accounting, where it documents all cash movements, asset purchases, and sales linked to [portfolio](https://docs.finmars.com/books/entities/page/portfolio "Portfolio"), [Instrument](https://docs.finmars.com/books/entities/page/instrument "Instrument"), and date.
- NAV calculation, providing a detailed basis for tracking valuation-impacting events.
- transaction reconciliation, matching recorded entries against external confirmations.
- performance reporting, aggregating Register Records using [portfolio ](https://docs.finmars.com/books/entities/page/portfolio "Portfolio")to generate accurate [P&amp;L](https://docs.finmars.com/books/marscapital/page/pl-reports "P&L Reports") and exposure analysis.

#### **Examples**

**First part of table**

<table border="1" id="bkmrk-transaction-code-por" style="border-collapse: collapse; width: 100%;"><colgroup><col style="width: 11.9205%;"></col><col style="width: 8.10596%;"></col><col style="width: 7.74929%;"></col><col style="width: 11.0851%;"></col><col style="width: 11.2053%;"></col><col style="width: 10.0132%;"></col><col style="width: 8.58278%;"></col><col style="width: 11.4437%;"></col><col style="width: 10.0132%;"></col><col style="width: 10.0132%;"></col></colgroup><tbody><tr><td>**Transaction code**</td><td>**PORT REG**</td><td>**TRX DAT**</td><td>**Transaction Class**</td><td>**Cash Amount**</td><td>**Cash Currency**</td><td>**FX Rate**</td><td>**Valuation Currency**</td><td>**Cash Amount Valuation Currency**</td><td>**Rolling shares of the day**</td></tr><tr><td>38201</td><td>CH-EQ-75648329</td><td>2023-01-12</td><td>Cash-Inflow</td><td>5781000.00</td><td>USD</td><td>1.0000</td><td>USD</td><td>5'781'000.00</td><td>5'781'000.00</td></tr></tbody></table>

**Second part of table**

<table border="1" id="bkmrk-nav-previous-day-val" style="border-collapse: collapse; width: 100%;"><colgroup><col style="width: 10.0132%;"></col><col style="width: 10.0132%;"></col><col style="width: 10.0132%;"></col><col style="width: 10.0132%;"></col><col style="width: 10.0132%;"></col><col style="width: 11.2053%;"></col><col style="width: 9.0596%;"></col><col style="width: 8.70341%;"></col><col style="width: 11.5615%;"></col><col style="width: 9.53642%;"></col></colgroup><tbody><tr><td>**NAV Previous day Valuation Currency**</td><td>**N Shares Added**</td><td>**N Shares previous day**</td><td>**Dealing Price Valuation Currency**</td><td>**Nav Valuation Currency**</td><td>**Instrument**</td><td>**Portfolio**</td><td>**Created**</td><td>**Share Price Calculation Type**</td><td>**Modified**</td></tr><tr><td>  
</td><td>5'781'000.00</td><td>0.00</td><td>1.000</td><td>5'781'000.00</td><td>CH-EQ-75648329</td><td>CH-EQ-75648329</td><td>  
</td><td>Automatic</td><td>  
</td></tr></tbody></table>

- `Transaction code`: Unique identifier of the transaction within the register.
- `PORT REG (Portfolio register)`: portfolio register indicator connecting portfolio and register together.
- `TRX DAT (Transaction Date)`: date of the transaction associated with the register record.
- `Transaction Class`: Type of cash flow event (e.g., Cash-Inflow or Cash-Outflow).
- `Cash amount`: Amount of money involved in the transaction.
- `Cash currency`: Currency in which the cash amount is denominated.
- `FX rate`: Foreign exchange rate applied if currencies differ.
- `Valuation currency`: Currency used for valuation purposes.
- `Cash Amount Valuation Currency`: Cash amount converted into valuation currency.
- `Rolling shares of the day`: Updated total number of shares after the transaction.
- `NAV Previous Day Valuation Currency`: the currency used to represent the Net Asset Value (NAV) of the position as calculated for the previous day.
- `N Shares Added`: Number of shares added during this transaction.
- `N Shares previous day`: Number of shares recorded the previous day.
- `Dealing Price Valuation Currency`: Price per share used for transactions in valuation currency.
- `Nav Valuation Currency`: Net Asset Value in the valuation currency after transaction.
- `Instrument`: Financial instrument involved in the transaction.
- `Portfolio`: Portfolio to which the transaction belongs.
- `Created`: timestamp when the register record was initially created.
- `Share Price Calculation Type`: Method used to calculate share price (e.g., Automatic).
- `Modified`: timestamp of the last modification made to the register record.

#### **Cookbook**

##### *CRUD* 

Operations within platform.

##### *Use Cases*

What for it's used.

#### **F.A.Q.**

Frequently asked questions.

#### **API documentation**

Link to API documentation.

# Instrument Type

#### **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*

**Instrument Type** it's standardized classification of the financial instrument used for system processing, grouping, and reporting.

##### *Platform abstraction*

In the Finmars platform, **Instrument Types** represent the core classification system for all financial instruments managed and processed within the environment. This abstraction allows the system to assign logic, behavior, and processing rules to each type of financial asset.

**Instrument type also is used in:**

- instrument aggregation within [portfolios](https://docs.finmars.com/books/entities/page/portfolio "Portfolio") and [bundles](https://docs.finmars.com/books/entities/chapter/bundle "Bundle")
- valuation using [instrument](https://docs.finmars.com/books/entities/page/instrument "Instrument")-dependent[ pricing policies](https://docs.finmars.com/books/entities/chapter/pricing-policy "Pricing Policy")
- [reconciliation](https://docs.finmars.com/books/reports/chapter/reconciliation "Reconciliation") by matching expected and actual instrument events based on type logic

**Instrument **Type include**:**

- **Bond**: Debt security representing a loan made by an investor to a borrower.
- **CDS**: Credit Default Swap, a financial derivative used to manage credit risk.
- **Derivative**: Financial contract deriving its value from an underlying asset.
- **Forward**: Agreement to buy or sell an asset at a future date at a predetermined price.
- **FX Forward Leg**: The settlement leg of a foreign exchange forward contract.
- **Option**: A contract offering the right, but not the obligation, to buy or sell an asset.
- **Other**: Instruments not categorized under standard financial classes.
- **Portfolio**: A collection of financial assets held by an entity.
- **Stock**: Equity security representing ownership in a corporation.
- **T-Bill**: Treasury Bill, a short-term government debt obligation.

#### **Examples**

<table border="1" id="bkmrk-user-code-short-name" style="border-collapse: collapse; width: 103.095%; height: 28.8785px;"><colgroup><col style="width: 8.46358%;"></col><col style="width: 6.7947%;"></col><col style="width: 11.0861%;"></col><col style="width: 6.79533%;"></col><col style="width: 7.03248%;"></col><col style="width: 7.03311%;"></col><col style="width: 7.03311%;"></col><col style="width: 6.91391%;"></col><col style="width: 8.10596%;"></col><col style="width: 7.03311%;"></col><col style="width: 6.91391%;"></col><col style="width: 7.39073%;"></col><col style="width: 9.53642%;"></col></colgroup><tbody><tr style="height: 28.8785px;"><td style="height: 28.8785px;">**User code**</td><td style="height: 28.8785px;">**Short name**</td><td style="height: 28.8785px;">**Instrument class**</td><td style="height: 28.8785px;">**Name**</td><td style="height: 28.8785px;">**Notes**</td><td style="height: 28.8785px;">**Public name**</td><td style="height: 28.8785px;">**Is Active**</td><td style="height: 28.8785px;">**One of event**</td><td>**Regular event**</td><td style="height: 28.8785px;">**Factor same**</td><td>**Factor up** </td><td style="height: 28.8785px;">**Factor down**</td><td>**Config. code**</td></tr><tr><td>com.finmars.standard-instrument-type:bond</td><td>Bond</td><td>Regular Event with Maturity</td><td>Bond</td><td>  
</td><td>Bond</td><td>  
</td><td>  
</td><td>  
</td><td>  
</td><td>  
</td><td>  
</td><td>com.finmars.standard-instrument-type</td></tr></tbody></table>

1. `<strong data-end="113" data-start="100">User code</strong>`: workspace-specific unique identifier of the instrument type, prefixed by its source (e.g., `com.finmars`)
2. `<strong data-end="239" data-start="225">Short name</strong>`: a brief, recognizable label for the instrument type used in user interfaces and linked tables
3. `<strong data-end="359" data-start="339">Instrument class</strong>`: classification that defines the behavior of the instrument type in the system (e.g., General Class, Event at Maturity, Regular Event with Maturity)
4. `<strong data-end="521" data-start="513">Name</strong>`: full descriptive name of the instrument type
5. `<strong data-end="581" data-start="572">Notes</strong>`: optional text field used for internal comments, documentation, or classification notes (e.g., risk labels, abstract categories)
6. `<strong data-end="730" data-start="715">Public name</strong>`: the name visible to users who have limited access, used for external or simplified presentation
7. `<strong data-end="845" data-start="832">Is Active</strong>`: status flag indicating whether the instrument type is currently active and available for selection and processing
8. `<strong data-end="982" data-start="965">One off event</strong>`: indicator that the instrument generates a single event (e.g., payment or valuation) during its lifecycle
9. `<strong data-end="1110" data-start="1093">Regular event</strong>`: indicator that the instrument is expected to generate recurring events at specified intervals (e.g., interest payments)
10. `<strong data-end="1251" data-start="1236">Factor same</strong>`: configuration value used to define a standard multiplier or conversion factor that applies uniformly across scenarios
11. `<strong data-end="1388" data-start="1375">Factor up</strong>`: value used when an upward adjustment or scenario-specific increase is applied to the instrument’s event calculations
12. `<strong data-end="1526" data-start="1511">Factor down</strong>`: value used when a downward adjustment or stress scenario is applied to the instrument’s parameters
13. `<strong data-end="1647" data-start="1631">Config. code</strong>`: internal system configuration reference code used to tie the instrument type to deeper logic or custom workflows

#### **Cookbook**

##### *CRUD* 

Operations within platform.

##### *Use Cases*

What for it's used.

#### **F.A.Q.**

Frequently asked questions.

#### **API documentation**

Link to API documentation.

# Base Transactions

#### **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*

**Base transactions** are the core financial actions that record what actually happens with your money or investments. They’re the most essential and original records in a financial system — like receipts for everything going in or out of your portfolio.

##### *Platform abstraction*

**Base Transactions** in the Finmars platform represent the **core building blocks of financial activity tracking**. Each base transaction shows the **essential details** of a financial action (like a purchase, sale, or cash movement), but in a simplified format — before it's split into accounting entries like cash or positions.

#### **Examples**

Platform screenshots with a description of a record table example.

#### **Cookbook**

##### *CRUD* 

Operations within platform.

##### *Use Cases*

What for it's used.

#### **F.A.Q.**

Frequently asked questions.

#### **API documentation**

Link to API documentation.

# Entity Doc Template

#### **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*

Financial meaning behind the entity (incl. diagrams and other explanatory materials).

##### *Platform abstraction*

Description of the entity in Platform (incl. diagrams, excel and other explanatory materials on how it works).

#### **Examples**

Platform screenshots with a description of a record table example.

#### **Cookbook**

##### *CRUD* 

Operations within platform.

##### *Use Cases*

What for it's used.

#### **F.A.Q.**

Frequently asked questions.

#### **API documentation**

Link to API documentation.

# FX Rate (Currency History)

#### **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*

**FX Rate**, or exchange rate, is the price of one currency (base currency) in terms of another currency (quote currency).

##### *Platform abstraction*

**FX Rate** in Finmars (a.k.a. Currency history) is an entity which evaluates a [currency](https://docs.finmars.com/books/entities/chapter/currency "Currency") (base currency) in system default currency (quote currency, USD by default) on a specific date for specific [pricing policy](https://docs.finmars.com/books/entities/chapter/pricing-policy "Pricing Policy"). By default, system currency is set to USD, it can be changed in [default settings](https://docs.finmars.com/books/default-settings "Default Settings"), but it's not recommended due to some modules may depend on system default currency set as USD.

#### **Examples**

<table border="1" id="bkmrk-currency-date-fx-rat" style="border-collapse: collapse; width: 100%;"><colgroup><col style="width: 20.0269%;"></col><col style="width: 20.0269%;"></col><col style="width: 20.0269%;"></col><col style="width: 13.8364%;"></col><col style="width: 26.2174%;"></col></colgroup><tbody><tr><td>**Currency**</td><td>**Date**</td><td>**Fx rate**</td><td>**Pricing policy**</td><td>**Modified Date And Time**</td></tr><tr><td>BTC</td><td>2024-06-20</td><td>64854.3000</td><td>Standard</td><td>2024-06-27 19:00:31</td></tr></tbody></table>

1. `BTC` - Base currency
2. `64854.3000` - is BTC/USD FX Rate (quote currency is the default currency USD)
3. `Standard` - is the name of the pricing policy
4. `2024-06-27 19:00:31` - modified at datetime

[![image.png](https://docs.finmars.com/uploads/images/gallery/2025-04/scaled-1680-/xNAimage.png)](https://docs.finmars.com/uploads/images/gallery/2025-04/xNAimage.png)

#### **Cookbook**

##### *CRUD* 

Operations within platform.

##### *Use Cases*

What for it's used.

#### **F.A.Q.**

Frequently asked questions.

#### **API documentation**

Link to API documentation.

# Transaction Type

#### **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*

Transaction types ensure that every economic event is correctly classified, allowing accurate portfolio valuation, performance calculation, risk analysis, compliance reporting, and accounting.

##### *Platform abstraction*

In the platform, transaction types drive the business logic behind how each [transaction ](https://docs.finmars.com/books/entities/page/transactions "Transactions")affects the portfolio structure and cash flows. They determine treatment in reconciliation, reporting, valuation, and accounting processes.

**Transaction Type include**:

- **Buy/Sell**: buying or selling of [instruments ](https://docs.finmars.com/books/entities/page/instrument "Instrument")(e.g., stocks, bonds).
- **Coupon/Dividend**: income received from holding an [instrument](https://docs.finmars.com/books/entities/page/instrument "Instrument").
- **Deposit/Withdrawal**: cash movement into or out of the [portfolio](https://docs.finmars.com/books/entities/page/portfolio "Portfolio").
- **Expense/Income (Non-instrument)**: operational or external income/expense not tied directly to [instruments](https://docs.finmars.com/books/entities/page/instrument "Instrument").
- **Expense/Other Income (Instrument-related)**: expenses or additional income tied specifically to an [instrument](https://docs.finmars.com/books/entities/page/instrument "Instrument").
- **FX Forward**: a forward contract to exchange [currencies ](https://docs.finmars.com/books/entities/page/currency "Currency")at a future date.
- **FX Trade**: spot or forward [transactions ](https://docs.finmars.com/books/entities/page/transactions "Transactions")for [currency ](https://docs.finmars.com/books/entities/page/currency "Currency")exchange.
- **Position Daily**: daily valuation update for open positions.
- **Position Initial**: initial entry of a position into the system.
- **Standard (Import)**: imported transactions from external systems.
- **Transfer**: internal movement of assets or cash between [portfolios](https://docs.finmars.com/books/entities/page/portfolio "Portfolio").
- **None**: undefined or uncategorized [transactions](https://docs.finmars.com/books/entities/page/transactions "Transactions").

#### **Examples**

<table border="1" id="bkmrk-user-code-group-shor" 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>**Group**</td><td>**Short Name**</td><td>**Name**</td><td>**Display Expression**</td><td>**Notes**</td></tr><tr><td>com.finmars.standard-transaction-type:buy\_with\_fx\_trade</td><td>Buy/Sell</td><td>Buy</td><td>Buy</td><td>'Buy : ' \\</td><td>  
</td></tr></tbody></table>

- `User code`: Internal user identifier for the entity.
- `Group`: Category grouping the action type (e.g., Buy/Sell).
- `Short name`: Short label representing the action (e.g., Buy or Sell).
- `Name`: Full name of the action type (Buy or Sell).
- `Display Expression`: Visual formatting or label used for display purposes.
- `Notes`: Optional field for additional comments or context.

#### **Cookbook**

##### *CRUD* 

Operations within platform.

##### *Use Cases*

What for it's used.

#### **F.A.Q.**

Frequently asked questions.

#### **API documentation**

Link to API documentation.