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