Currency

• Currency
• How to Create a Currency entity

Currency

Table of Contents

• Description
• Examples
• Cookbook
• F.A.Q.
• 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, valuations, and reporting. Currencies are linked to instruments, portfolios, 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 as part of asset allocation

• reporting in multiple currencies using FX rate conversions

• reconciliation by matching positions and transactions by currency

Examples

User Code	Country	Short Name	Name	Public Name	Notes
EUR	Europe	EUR	Euro	EUR

• User code: internal system identifier for the currency.

• Country: 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).

• Short name: standard currency code (typically ISO 4217 format), used across the system in relations, selections, and dropdowns (e.g., "USD", "GBP", "BTC").

• Name: full name of the currency (e.g., "US Dollar", "Pound Sterling", "Bitcoin") used in detailed views or documentation.

• Public name: display name for external users or limited-access users, often identical to the short name (e.g., "EUR", "HKD"); controls visibility in shared environments.

• Notes: 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

1. Open the “Data” section in the left-hand side menu. Select the “Currency” entity from the list under Data.
   
2. Click the “+ Add” button located in the top-left corner of the portfolio list view.
   
3. This action opens the Add Portfolio register form.
   
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 – select the issuing country for context/reference. This may be used in filters or reports.
   4. Notes – add any internal notes for clarification or documentation purposes.
5. Click “Create and Exit” to save the portfolio and return to the list view. Alternatively, use “Create” to save and continue editing.