Instrument Type

Table of Contents

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

Description

Financial meaning

FinancialInstrument meaningType behind– standardized classification of the entityfinancial (incl.instrument diagramsused for system processing, grouping, and other explanatory materials). reporting.

Platform abstraction

DescriptionIn 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 thefinancial entityasset.

in

Instrument Platformtype (incl.also diagrams,is excelused in:

• instrument aggregation within portfolios and otherbundles
  

  explanatory
materials

• valuation using instrument-dependent pricing policies

• reconciliation by matching expected and actual instrument events based on howtype itlogic

  works).

Examples

Platform

screenshots description

User code

Short name

Instrument class

Name

Notes

Public name

Is Active

One of event

Regular event

Factor same

Factor up

Factor down

Config. code

com.finmars.standard-instrument-type:bond

Bond

Regular Event with aMaturity

Bond

Bond

com.finmars.standard-instrument-type

1. User code: workspace-specific unique identifier of the instrument type, prefixed by its source (e.g., com.finmars)

2. Short name: a recordbrief, tablerecognizable example.label for the instrument type used in user interfaces and linked tables

3. Instrument class: classification that defines the behavior of the instrument type in the system (e.g., General Class, Event at Maturity, Regular Event with Maturity)

4. Name: full descriptive name of the instrument type

5. Notes: optional text field used for internal comments, documentation, or classification notes (e.g., risk labels, abstract categories)

6. Public name: the name visible to users who have limited access, used for external or simplified presentation

7. Is Active: status flag indicating whether the instrument type is currently active and available for selection and processing

8. One off event: indicator that the instrument generates a single event (e.g., payment or valuation) during its lifecycle

9. Regular event: indicator that the instrument is expected to generate recurring events at specified intervals (e.g., interest payments)

10. Factor same: configuration value used to define a standard multiplier or conversion factor that applies uniformly across scenarios

11. Factor up: value used when an upward adjustment or scenario-specific increase is applied to the instrument’s event calculations

12. Factor down: value used when a downward adjustment or stress scenario is applied to the instrument’s parameters

13. Config. code: 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.