User Quick Start
- How to Register in Finmars
- How to Get an Access to the Workspace
- How to Navigate in a Profile page
- How to Import Data into a Workspace via Dashboard (STD Manual Import)
- How to Prepare Standard Template Files for Import
- How to Check Balance Report
- How to Duplicate the Layout
- How To Check Transaction Report
How to Register in Finmars
- To register at finmars.com you need to click to "SIGN UP" button
- It will direct you to the "CONTACT US" section
- You should fill in your information and click "Submit"
- Then you will get a confirmation message that your form was submitted successfully.
- After that Finmars will contact you for finishing the Registration.
How to Get an Access to the Workspace
Prerequisites
- Already registered in Finmars (see How to Register in Finmars)
- Received the credentials to use in the Finmars platform.
Getting an Access to the Workspace
- Go to your allocated Finmars URL (environment) which was as the part of your credentials and usually defined for a specific regions in accordance with the compliance requirements.
- You will access the Profile page which will contain your Workspace (an instance of your Finmars engine with your data).
- At the moment you may not have available Workspaces (like in the screenshot above). You should request Finmars to create your own Workspace, you should provide your Username to get an invitation to the Workspace.
- You can find your Username in the upper right corner of the profile page (
new_user
- in the example above) - That is the exact Username you use as a login
- You can find your Username in the upper right corner of the profile page (
- Then Finmars will sent you an invitation, which can be found in the "Invites" section of the Profile page: you will see the card with the name of the Workspace, then click "Accept" button
- After the "Accept" is clicked you will be redirected to the "New User Setup" page consisting of 2 steps:
- "Please select your complexity level" (deprecated setting) -> Always select "Advanced Sophisticated User"
- "Please select init configuration you would like to use" (selecting the layouts for reports) -> Select a card representing needed configuration and click button "Finish" (if no cards from the configurations you may select "Blank" card and install layouts directly from the Marketplace.
- Upon finishing installation you will be redirected to the "Home" page, meaning that now you have an access to the Workspace.
- Also the Workspace now will be listed in the "Profile" page
How to Navigate in a Profile page
Prerequisites
We assume you have all prerequisites you may need, including:
- If needed: the VPN is configured to access the Finmars resources
- If needed: access to the Virtual Machine to work with the sensitive information
- Must have: registered in Finmars in the needed region environment (self-registered or registered by Finmars)
- Must have: having permissions set to allow continue with the Action in the Guide
Navigating in a Profile page
- Go to the needed region environment URL
- Login
- You will be redirected to the Profile page: it's the page where you can find
- Profile page has a sidebar menu:
- Realm - default tab with Dashboard with all available Realm & Workspaces in them (see screenshot above). You can:
- open available workspaces by clicking "Open"
- click on cog icon on a workspace card to
- Export Backup
- Exit the Workspace (if you are not an owner of the workspace)
- Delete the Workspace (if you are an owner of the workspace)
- Backups - list of all available workspaces and their backups statuses
- Invites - list of all pending invitations to join workspaces (reference to the How to get Access to the Workspace point 4)
- User - tab with the user info
- Realm - default tab with Dashboard with all available Realm & Workspaces in them (see screenshot above). You can:
How to Import Data into a Workspace via Dashboard (STD Manual Import)
Prerequisites
We assume you have all prerequisites you may need, including:
- If needed: the VPN is configured to access the Finmars resources
- If needed: access to the Virtual Machine to work with the sensitive information
- Must have: registered in Finmars in the needed region environment (self-registered or registered by Finmars)
- Must have: having permissions set to allow continue with the Action in the Guide
- Must have: to create a new Workspace you must have a License Key (provided by Finmars)
- Must have: installed Standard Configuration package from the marketplace
Import Data into a Workspace via Dashboard (STD Manual Import)
-
Go to the Dashboard menu tab. STD Manual Import tab should be selected. If it's selected, proceed from the step 5. If it's not selected, follow the steps below.
- After you have finished the installation (right upper corner had success popup), you should go to the Dashboard menu tab. Depending on your default layout settings, it may have different layout selected, you need to click on the layout name to navigate to the needed layout.
-
Once the menu is opened, you will be presented a choice of selecting multiple menus. Select STD Manual Import layout.
-
Workflow field denotes which workflow will handle the input. For now, use the default com.finmars.standard-workflow:std-import-pipeline. If you see this import, skip steps 5-6 and go to Step 7.
-
If you do not see this import, double check that you have installed Standard - Workflows module as a part of the Standard Configuration package by following the steps below. This can be done by going to the Configuration → Configuration → Manage
-
Standard - Workflow should be installed there
- The basic way to use STD Import Pipeline is to add all of the needed files yourself.
- That includes currencies, accounts, portfolios, instruments, instruments factor scheduled, instruments accrual scheduled, responsibles, strategies1, transactions, prices, fx-rates, for files see instruction: How to Prepare Standard Template Files for Import.
- You can add multiple files at once in one field.
- Any combination of previously mentioned files is possible. Which means that some fields can be left without any file selected, but it's your responsibility to make sure that you won't be lacking any data.
- Parse Entities from Transactions & Positions checkbox is used when you don’t have simple entities already imported or in the corresponding files (not including Instruments, they need to be in the corresponding file with instruments).
- After adding all those files, you should click Import.
-
-
After clicking Import, information about the workflow status will appear. Refresh status button will refresh the status of the workflow.
-
Open Workflow link will open a more detailed view of the workflow progress. This view shows all of the workflows that will be executed by std-import-pipeline.
-
Zooming in, more information about each separate workflow is shown. Clicking on the workflow, detailed information is shown on the right, including status, created at and finished at, logs, as well as results. Status field has following values: Progress, Success, Nested-Progress, Error. Nested-Progress denotes that a workflow inside the Nested-Progress workflow is being executed.
-
std-import-pipeline executes multiple other workflows. After all of them are completed, the workflow progress will be Success.
-
More details about each workflow can be obtained by clicking on the id of that workflow.
-
After all other workflows have finished Successfully “Status: success” will be shown.
- However, this only confirms that the data transfer was completed, not that the data is free of errors. To check that import has no errors you need to click on Open Workflow after the import is marked as successful.
- The workflow visualization will open. Locate the last executed block in the workflow and click on it, as shown in the screenshot.
- On the right panel, find the Result section. In this section, the top row will indicate whether any errors were encountered. Below, a detailed list of errors will be displayed, specifying the affected files.
- If errors are present, review them carefully and take corrective actions as needed before re-running the import.
How to Prepare Standard Template Files for Import
Prerequisites
We assume you have all prerequisites you may need, including:
- If needed: the VPN is configured to access the Finmars resources
- If needed: access to the Virtual Machine to work with the sensitive information
- Must have: registered in Finmars in the needed region environment (self-registered or registered by Finmars)
- Must have: having permissions set to allow continue with the Action in the Guide
- Must have: to create a new Workspace you must have a License Key (provided by Finmars)
- Must have: installed Standard Configuration package from the marketplace
Prepare Standard Template Files for Import
Standard Configuration supports importing from Excel files:
Currencies, Accounts, Portfolios, Instruments, Instruments Factor Schedules, Instruments Accrual Schedules, Counterparties, Responsibles, Strategies1, Transactions, Positions, Prices & FX Rates.
To import this files follow instruction: How to Import Data into a Workspace via Dashboard (STD Manual Import)
Below you can find instructions on how to fill in templates.
General Requirements:
-
Files MUST be structured in accordance with templates (same columns and formatting).
-
Excel files must NOT have formulas (only values).
-
Excel files must NOT have more than one sheet.
-
Excel files must NOT have empty cells in fields for the data row.
Transactions
-
To book a transaction in the system you can import it from a file.
-
One transaction is one row of data in the file.
-
You should enter a transaction in the file for import in accordance with the instructions below for supported standard transaction/position types.
- Supported Standard transaction types list (case-sensitive):
-
Transactions
-
Deposit
-
Withdraw
-
Expense (Non-instrument)
-
Income (Non-instrument)
-
Coupon
-
Dividend
-
Expense (Instrument)
-
Other Income (Instrument)
-
Buy
-
Sell
-
FX Trade
-
FX Forward (Open)
-
FX Forward (Expiration)
-
Transfer Cash (In)
Transfer Cash (Out)
Transfer Instrument
-
Transfer Instrument (In)
Transfer Instrument (Out)
Split
Reverse Split
-
-
Deposit/Withdraw
-
Transaction ID
-
Text field. Case-sensitive.
-
A unique complex transaction identifier (only one in the workspace).
-
Transactions with repeated ID will NOT be booked (will be skipped).
-
-
Transaction Type
-
Text field. Case-sensitive.
-
Type of a transaction.
-
Should be a value from Standard transaction types for Transactions.
-
For Deposit/Withdraw transactions values should be:
-
Deposit
-
Withdraw
-
-
-
Reverse
-
Text field.
-
Indicator for a reverse transaction.
-
Valid values:
-
True
-
False
-
-
This field has only indicative meaning and will NOT invert any signs in other fields.
-
-
Date (Trade)
-
Date field.
-
A date on which a particular financial transaction is executed or agreed upon.
-
Format should be: “YYYY-MM-DD” (e.g. “
2000-12-31
")
-
-
Date (Value)
-
Date field.
-
A date when cash or funds are expected to be received or paid as part of a financial transaction.
-
Format should be: “YYYY-MM-DD” (e.g. “
2000-12-31
") -
For Deposit/Withdraw transactions:
-
Date (Value)
should be equal toDate (Trade)
-
-
-
Portfolio
-
Text field. Case-sensitive.
-
A collection of financial assets or investments held by an individual or organization.
-
-
Account (Cash)
-
Text field. Case-sensitive.
-
An account that is specifically designated for managing and tracking cash transactions.
-
-
Currency (Settlement)
-
Text field. Case-sensitive.
-
A currency in which the payment or transfer of funds takes place to fulfil the terms of the transaction.
-
Must be an alphabetic code of a currency alphabetic code (e.g.
USD
,EUR
,CHF
).
-
-
Cash Consideration
-
Numeric field.
-
A monetary value or payment made in the form of cash for a particular transaction or asset.
-
Must be in Settlement Currency.
-
A sign of the number:
-
“
+
" (plus sign) is for income -
“
-
" (minus sign) is for expenses
-
-
-
Account (Position)
-
Text field. Case-sensitive.
-
For Deposit/Withdraw transactions values should be “
-
" (dash).
-
-
Instrument
-
Text field. Case-sensitive.
-
For Deposit/Withdraw transactions values should be “
-
" (dash).
-
-
Allocation (PL)
-
Text field. Case-sensitive.
-
For Deposit/Withdraw transactions values should be “
-
" (dash).
-
-
Position size
-
Numeric field.
-
For Deposit/Withdraw transactions values should be “
0
" (zero).
-
-
Principal/Share price
-
Numeric field.
-
For Deposit/Withdraw transactions:
-
The share price of the open-end fund.
-
-
For Deposit/Withdraw transactions values should be “
0
" (zero) for default. -
A sign of the number:
-
“
+
" (plus sign) is for standard prices -
“
-
" (minus sign) is for special prices (e.g. for exotic derivatives)
-
-
-
Amount (Carry)
-
Numeric field.
-
For Deposit/Withdraw transactions values should be “
0
" (zero).
-
-
Amount (Charges)
-
Numeric field.
-
For Deposit/Withdraw transactions values should be “
0
" (zero).
-
-
Notes
-
Text field.
-
Additional comments, instructions, or relevant information associated with a particular transaction.
-
If there are no notes enter “
-
" (dash).
-
-
Payment Purpose (for Income/Expense)
-
Text field. Case-sensitive.
-
For Deposit/Withdraw transactions values should be “
-
" (dash).
-
-
Reference transaction code
-
Text field. Case-sensitive.
-
A reference to related transactions' unique identifiers.
-
For reverse transaction you can specify a transaction ID of the reversed transaction.
-
-
Portfolio To
-
Text field. Case-sensitive.
-
For Deposit/Withdraw transactions values should be “
-
" (dash).
-
-
Account To (Cash)
-
Text field. Case-sensitive.
-
For Deposit/Withdraw transactions values should be “
-
" (dash).
-
-
Account To (Position)
-
Text field. Case-sensitive.
-
For Deposit/Withdraw transactions values should be “
-
" (dash).
-
-
Position size New
-
Numeric field.
- For Deposit/Withdraw transactions values should be “
0
" (zero).
-
-
Principal/Share price New
-
Numeric field.
- For Deposit/Withdraw transactions values should be “
0
" (zero).
-
-
Counterparty
-
Text field. Case-sensitive.
-
-
Responsible
-
Text field. Case-sensitive.
-
-
Strategy1
-
Text field. Case-sensitive.
-
Expense/Income (Non-instrument)
-
Transaction ID
-
Text field. Case-sensitive.
-
A unique complex transaction identifier (only one in the workspace).
-
Transactions with repeated ID will NOT be booked (will be skipped).
-
-
Transaction Type
-
Text field. Case-sensitive.
-
Type of a transaction.
-
Should be a value from Standard transaction types for Transactions.
-
For Income/Expense (Non-instrument) transactions values should be:
-
Income (Non-instrument)
-
Expense (Non-instrument)
-
-
-
Reverse
-
Text field.
-
Indicator for a reverse transaction.
-
Valid values:
-
True
-
False
-
-
This field has only indicative meaning and will NOT invert any signs in other fields.
-
-
Date (Trade)
-
Date field.
-
A date on which a particular financial transaction is executed or agreed upon.
-
Format should be: “YYYY-MM-DD” (e.g. “
2000-12-31
")
-
-
Date (Value)
-
Date field.
-
A date when cash or funds are expected to be received or paid as part of a financial transaction.
-
Format should be: “YYYY-MM-DD” (e.g. “
2000-12-31
")
-
-
Portfolio
-
Text field. Case-sensitive.
-
A collection of financial assets or investments held by an individual or organization.
-
-
Account (Cash)
-
Text field. Case-sensitive.
-
An account that is specifically designated for managing and tracking cash transactions.
-
-
Currency (Settlement)
-
Text field. Case-sensitive.
-
A currency in which the payment or transfer of funds takes place to fulfil the terms of the transaction.
-
Must be an alphabetic code of a currency alphabetic code (e.g.
USD
,EUR
,CHF
).
-
-
Cash Consideration
-
Numeric field.
-
A monetary value or payment made in the form of cash for a particular transaction or asset.
-
Must be in Settlement Currency.
-
A sign of the number:
-
“
+
" (plus sign) is for income -
“
-
" (minus sign) is for expenses
-
-
-
Account (Position)
-
Text field. Case-sensitive.
-
For Income/Expense (Non-instrument) transactions values should be “
-
" (dash).
-
-
Instrument
-
Text field. Case-sensitive.
-
For Income/Expense (Non-instrument) transactions values should be “
-
" (dash).
-
-
Allocation (PL)
-
Text field. Case-sensitive.
-
For Income/Expense (Non-instrument) transactions values should be “
-
" (dash).
-
-
Position size
-
Numeric field.
-
For Income/Expense (Non-instrument) transactions values should be “
0
" (zero).
-
-
Principal/Share price
-
Numeric field.
-
For Income/Expense (Non-instrument) transactions values should be “
0
" (zero).
-
-
Amount (Carry)
-
Numeric field.
-
An amount of an Income/Expense.
-
Must be in Settlement Currency.
-
A sign of the number:
-
“
+
" (plus sign) is for income -
“
-
" (minus sign) is for expenses
-
-
-
Amount (Charges)
-
Numeric field.
-
Costs or fees associated with a transaction.
-
Must be in Settlement Currency.
-
A sign of the number:
-
“
+
" (plus sign) is for income -
“
-
" (minus sign) is for expenses
-
-
-
Notes
-
Text field.
-
Additional comments, instructions, or relevant information associated with a particular transaction.
-
If there are no notes enter “
-
" (dash).
-
-
Payment Purpose (for Income/Expense)
-
Text field. Case-sensitive.
-
A type of Income/Expense associated with a transaction.
-
Used for grouping in reports for non-instrument transactions.
-
-
Reference transaction code
-
Text field. Case-sensitive.
-
A reference to related transactions' unique identifiers.
-
For reverse transaction you can specify a transaction ID of the reversed transaction.
-
-
Portfolio To
-
Text field. Case-sensitive.
-
For Expense/Income (Non-instrument) transactions values should be “
-
" (dash).
-
-
Account To (Cash)
-
Text field. Case-sensitive.
-
For Expense/Income (Non-instrument) transactions values should be “
-
" (dash).
-
-
Account To (Position)
-
Text field. Case-sensitive.
-
For Expense/Income (Non-instrument) transactions values should be “
-
" (dash).
-
-
Position size New
-
Numeric field.
- For Expense/Income (Non-instrument) transactions values should be “
0
" (zero).
-
-
Principal/Share price New
-
Numeric field.
- For Expense/Income (Non-instrument) transactions values should be “
0
" (zero).
-
-
Counterparty
-
Text field. Case-sensitive.
-
-
Responsible
-
Text field. Case-sensitive.
-
-
Strategy1
-
Text field. Case-sensitive.
-
Coupon/Dividend
-
Transaction ID
-
Text field. Case-sensitive.
-
A unique complex transaction identifier (only one in the workspace).
-
Transactions with repeated ID will NOT be booked (will be skipped).
-
-
Transaction Type
-
Text field. Case-sensitive.
-
Type of a transaction.
-
Should be a value from Standard transaction types for Transactions.
-
For Coupon/Dividend transactions values should be:
-
Coupon
-
Dividend
-
-
-
Reverse
-
Text field.
-
Indicator for a reverse transaction.
-
Valid values:
-
True
-
False
-
-
This field has only indicative meaning and will NOT invert any signs in other fields.
-
-
Date (Trade)
-
Date field.
-
A date on which a particular financial transaction is executed or agreed upon.
-
Format should be: “YYYY-MM-DD” (e.g. “
2000-12-31
")
-
-
Date (Value)
-
Date field.
-
A date when cash or funds are expected to be received or paid as part of a financial transaction.
-
Format should be: “YYYY-MM-DD” (e.g. “
2000-12-31
")
-
-
Portfolio
-
Text field. Case-sensitive.
-
A collection of financial assets or investments held by an individual or organization.
-
-
Account (Cash)
-
Text field. Case-sensitive.
-
An account that is specifically designated for managing and tracking cash transactions.
-
-
Currency (Settlement)
-
Text field.
-
A currency in which the payment or transfer of funds takes place to fulfil the terms of the transaction.
-
Must be an alphabetic code of a currency alphabetic code (e.g.
USD
,EUR
,CHF
).
-
-
Cash Consideration
-
Numeric field.
-
A monetary value or payment made in the form of cash for a particular transaction or asset.
-
Must be in Settlement Currency.
-
A sign of the number:
-
“
+
" (plus sign) is for income -
“
-
" (minus sign) is for expenses
-
-
-
Account (Position)
-
Text field. Case-sensitive.
-
An account that tracks and records the positions or holdings of assets.
-
-
Instrument
-
Text field. Case-sensitive.
-
A financial asset or security involved in a transaction.
-
Value must be:
-
ISIN (e.g.
GB00BFZNLB60
) to import Instrument from Finmars Database -
user_code - for instruments without ISIN or already created instruments.
-
-
-
Allocation (PL)
-
Text field. Case-sensitive.
-
An instrument to which the financial outcome of a transaction is attributed or allocated.
-
Value must be:
-
ISIN (e.g.
GB00BFZNLB60
) to import Instrument from Finmars Database -
user_code - for instruments without ISIN or already created instruments.
-
-
-
Position size
-
Numeric field.
-
For Coupon/Dividend transactions values should be “
0
" (zero).
-
-
Principal/Share price
-
Numeric field.
-
For Coupon/Dividend transactions values should be “
0
" (zero).
-
-
Amount (Carry)
-
Numeric field.
-
An amount of a Coupon/Dividend.
-
Must be in Settlement Currency.
-
A sign of the number:
-
“
+
" (plus sign) is for income -
“
-
" (minus sign) is for expenses
-
-
-
Amount (Charges)
-
Numeric field.
-
Costs or fees associated with a transaction.
-
Must be in Settlement Currency.
-
A sign of the number:
-
“
+
" (plus sign) is for income -
“
-
" (minus sign) is for expenses
-
-
-
Notes
-
Text field.
-
Additional comments, instructions, or relevant information associated with a particular transaction.
-
If there are no notes enter “
-
" (dash).
-
-
Payment Purpose (for Income/Expense)
-
Text field. Case-sensitive.
-
For Coupon/Dividend transactions values should be “
-
" (dash).
-
-
Reference transaction code
-
Text field. Case-sensitive.
-
A reference to related transactions' unique identifiers.
-
For reverse transaction you can specify a transaction ID of the reversed transaction.
-
-
Portfolio To
-
Text field. Case-sensitive.
-
For Coupon/Dividend transactions values should be “
-
" (dash).
-
-
Account To (Cash)
-
Text field. Case-sensitive.
-
For Coupon/Dividend transactions values should be “
-
" (dash).
-
-
Account To (Position)
-
Text field. Case-sensitive.
-
For Coupon/Dividend transactions values should be “
-
" (dash).
-
-
Position size New
-
Numeric field.
- For Coupon/Dividend transactions values should be “
0
" (zero).
-
-
Principal/Share price New
-
Numeric field.
- For Coupon/Dividend transactions values should be “
0
" (zero).
-
-
Counterparty
-
Text field. Case-sensitive.
-
-
Responsible
-
Text field. Case-sensitive.
-
-
Strategy1
-
Text field. Case-sensitive.
-
Expense/Other Income (Instrument)
-
Transaction ID
-
Text field. Case-sensitive.
-
A unique complex transaction identifier (only one in the workspace).
-
Transactions with repeated ID will NOT be booked (will be skipped).
-
-
Transaction Type
-
Text field. Case-sensitive.
-
Type of a transaction.
-
Should be a value from Standard transaction types for Transactions.
-
For Other Income/Expense (Instrument) transactions values should be:
-
Other Income (Instrument)
-
Expense (Instrument)
-
-
-
Reverse
-
Text field.
-
Indicator for a reverse transaction.
-
Valid values:
-
True
-
False
-
-
This field has only indicative meaning and will NOT invert any signs in other fields.
-
-
Date (Trade)
-
Date field.
-
A date on which a particular financial transaction is executed or agreed upon.
-
Format should be: “YYYY-MM-DD” (e.g. “
2000-12-31
")
-
-
Date (Value)
-
Date field.
-
A date when cash or funds are expected to be received or paid as part of a financial transaction.
-
Format should be: “YYYY-MM-DD” (e.g. “
2000-12-31
")
-
-
Portfolio
-
Text field.
-
A collection of financial assets or investments held by an individual or organization.
-
-
Account (Cash)
-
Text field. Case-sensitive.
-
An account that is specifically designated for managing and tracking cash transactions.
-
-
Currency (Settlement)
-
Text field. Case-sensitive.
-
A currency in which the payment or transfer of funds takes place to fulfil the terms of the transaction.
-
Must be an alphabetic code of a currency alphabetic code (e.g.
USD
,EUR
,CHF
).
-
-
Cash Consideration
-
Numeric field.
-
A monetary value or payment made in the form of cash for a particular transaction or asset.
-
Must be in Settlement Currency.
-
A sign of the number:
-
“
+
" (plus sign) is for income -
“
-
" (minus sign) is for expenses
-
-
-
Account (Position)
-
Text field. Case-sensitive.
-
An account that tracks and records the positions or holdings of assets.
-
-
Instrument
-
Text field. Case-sensitive.
-
A financial asset or security involved in a transaction.
-
Value must be:
-
ISIN (e.g.
GB00BFZNLB60
) to import Instrument from Finmars Database -
user_code - for instruments without ISIN or already created instruments.
-
-
-
Allocation (PL)
-
Text field. Case-sensitive.
-
An instrument to which the financial outcome of a transaction is attributed or allocated.
-
Value must be:
-
ISIN (e.g.
GB00BFZNLB60
) to import Instrument from Finmars Database -
user_code - for instruments without ISIN or already created instruments.
-
-
-
Position size
-
Numeric field.
-
For Other Income/Expense (Instrument) transactions values should be “
0
" (zero).
-
-
Principal/Share price
-
Numeric field.
-
For Other Income/Expense (Instrument) transactions values should be “
0
" (zero).
-
-
Amount (Carry)
-
Numeric field.
-
An amount of an Income/Expense.
-
Must be in Settlement Currency.
-
A sign of the number:
-
“
+
" (plus sign) is for income -
“
-
" (minus sign) is for expenses
-
-
-
Amount (Charges)
-
Numeric field.
-
Costs or fees associated with a transaction.
-
Must be in Settlement Currency.
-
A sign of the number:
-
“
+
" (plus sign) is for income -
“
-
" (minus sign) is for expenses
-
-
-
Notes
-
Text field.
-
Additional comments, instructions, or relevant information associated with a particular transaction.
-
If there are no notes enter “
-
" (dash).
-
-
Payment Purpose (for Income/Expense)
-
Text field. Case-sensitive.
-
A type of Income/Expense associated with a transaction.
-
Used for grouping in reports for non-instrument transactions.
-
-
Reference transaction code
-
Text field. Case-sensitive.
-
A reference to related transactions' unique identifiers.
-
For reverse transaction you can specify a transaction ID of the reversed transaction.
-
-
Portfolio To
-
Text field. Case-sensitive.
-
For Expense/Other Income (Instrument) transactions values should be “
-
" (dash).
-
-
Account To (Cash)
-
Text field. Case-sensitive.
-
For Expense/Other Income (Instrument) transactions values should be “
-
" (dash).
-
-
Account To (Position)
-
Text field. Case-sensitive.
-
For Expense/Other Income (Instrument) transactions values should be “
-
" (dash).
-
-
Position size New
-
Numeric field.
- For Expense/Other Income (Instrument) transactions values should be “
0
" (zero).
-
-
Principal/Share price New
-
Numeric field.
- For Expense/Other Income (Instrument) transactions values should be “
0
" (zero).
-
-
Counterparty
-
Text field. Case-sensitive.
-
-
Responsible
-
Text field. Case-sensitive.
-
-
Strategy1
-
Text field. Case-sensitive.
-
Buy/Sell
-
Transaction ID
-
Text field. Case-sensitive.
-
A unique complex transaction identifier (only one in the workspace).
-
Transactions with repeated ID will NOT be booked (will be skipped).
-
-
Transaction Type
-
Text field. Case-sensitive.
-
Type of a transaction.
- Should be a value from Standard transaction types for Transactions.
-
For Buy/Sell transactions values should be:
-
Buy
-
Sell
-
-
-
Reverse
-
Text field.
-
Indicator for a reverse transaction.
-
Valid values:
-
True
-
False
-
-
This field has only indicative meaning and will NOT invert any signs in other fields.
-
-
Date (Trade)
-
Date field.
-
A date on which a particular financial transaction is executed or agreed upon.
-
Format should be: “YYYY-MM-DD” (e.g. “
2000-12-31
")
-
-
Date (Value)
-
Date field.
-
A date when cash or funds are expected to be received or paid as part of a financial transaction.
-
Format should be: “YYYY-MM-DD” (e.g. “
2000-12-31
")
-
-
Portfolio
-
Text field. Case-sensitive.
-
A collection of financial assets or investments held by an individual or organization.
-
-
Account (Cash)
-
Text field. Case-sensitive.
-
An account that is specifically designated for managing and tracking cash transactions.
-
-
Currency (Settlement)
-
Text field. Case-sensitive.
-
A currency in which the payment or transfer of funds takes place to fulfil the terms of the transaction.
-
Must be an alphabetic code of a currency alphabetic code (e.g.
USD
,EUR
,CHF
).
-
-
Cash Consideration
-
Numeric field.
- A monetary value or payment made in the form of cash for a particular transaction or asset.
-
Must be in Settlement Currency.
-
A sign of the number:
-
“
+
" (plus sign) is for income -
“
-
" (minus sign) is for expenses
-
-
-
Account (Position)
-
Text field. Case-sensitive.
-
An account that tracks and records the positions or holdings of assets.
-
- Instrument
-
Text field. Case-sensitive.
-
A financial asset or security involved in a transaction.
-
Value must be:
-
ISIN (e.g.
GB00BFZNLB60
) to import Instrument from Finmars Database -
user_code - for instruments without ISIN or already created instruments.
-
-
-
Allocation (PL)
-
Text field. Case-sensitive.
-
An instrument to which the financial outcome of a transaction is attributed or allocated.
-
Value must be:
-
ISIN (e.g.
GB00BFZNLB60
) to import Instrument from Finmars Database -
user_code - for instruments without ISIN or already created instruments.
-
-
-
Position size
-
Numeric field.
- An adjusted position of the asset after all alterations or corrections (e.g. adjusted for a factor).
-
A sign of the number:
-
“
+
" (plus sign) is for position increase -
“
-
" (minus sign) is for position decrease
-
-
-
Principal/Share price
-
Numeric field.
-
For Buy/Sell transactions this field is a Principal price:
-
A unit price or value of a financial instrument, excluding any accrued interest or additional earnings.
-
-
Must be in Settlement Currency.
-
Multipliers will be applied automatically in accordance with an instrument of the transaction.
-
A sign of the number:
-
“
+
" (plus sign) is for standard prices -
“
-
" (minus sign) is for special prices (e.g. for exotic derivatives)
-
-
-
Amount (Carry)
-
Numeric field.
-
An amount or expense that has been incurred but not yet paid or settled.
-
Must be in Settlement Currency.
-
A sign of the number:
-
“
+
" (plus sign) is for income -
“
-
" (minus sign) is for expenses
-
-
-
Amount (Charges)
-
Numeric field.
-
Costs or fees associated with a transaction.
-
Must be in Settlement Currency.
-
A sign of the number:
-
“
+
" (plus sign) is for income -
“
-
" (minus sign) is for expenses
-
-
-
Notes
-
Text field.
-
Additional comments, instructions, or relevant information associated with a particular transaction.
-
If there are no notes enter “-” (dash).
-
-
Payment Purpose (for Income/Expense)
-
Text field. Case-sensitive.
-
For Buy/Sell transactions values should be “-" (dash).
-
-
Reference transaction code
-
Text field. Case-sensitive.
-
A reference to related transactions' unique identifiers.
-
For reverse transaction you can specify a transaction ID of the reversed transaction.
-
-
Portfolio To
-
Text field. Case-sensitive.
-
For Buy/Sell transactions values should be “
-
" (dash).
-
-
Account To (Cash)
-
Text field. Case-sensitive.
-
For Buy/Sell transactions values should be “
-
" (dash).
-
-
Account To (Position)
-
Text field. Case-sensitive.
-
For Buy/Sell transactions values should be “
-
" (dash).
-
-
Position size New
-
Numeric field.
- For Buy/Sell transactions values should be “
0
" (zero).
-
-
Principal/Share price New
-
Numeric field.
- For Buy/Sell transactions values should be “
0
" (zero).
-
-
Counterparty
-
Text field. Case-sensitive.
-
-
Responsible
-
Text field. Case-sensitive.
-
-
Strategy1
-
Text field. Case-sensitive.
-
FX Trade
-
Transaction ID
-
Text field. Case-sensitive.
-
A unique complex transaction identifier (only one in the workspace).
-
Transactions with repeated ID will NOT be booked (will be skipped).
-
-
Transaction Type
-
Text field. Case-sensitive.
-
Type of a transaction.
-
Should be a value from Standard transaction types for Transactions.
-
For FX Trade transactions values should be:
FX Trade
-
-
Reverse
-
Text field.
-
Indicator for a reverse transaction.
-
Valid values:
-
True
-
False
-
-
This field has only indicative meaning and will NOT invert any signs in other fields.
-
-
Date (Trade)
-
Date field.
-
A date on which a particular financial transaction is executed or agreed upon.
-
Format should be: “YYYY-MM-DD” (e.g. “
2000-12-31
")
-
-
Date (Value)
-
Date field.
-
A date when cash or funds are expected to be received or paid as part of a financial transaction.
-
Format should be: “YYYY-MM-DD” (e.g. “
2000-12-31
") -
For FX Trade transactions:
-
Date (Value)
should be equal toDate (Trade)
-
-
-
Portfolio
-
Text field. Case-sensitive.
-
A collection of financial assets or investments held by an individual or organization.
-
-
Account (Cash)
-
Text field. Case-sensitive.
-
An account that is specifically designated for managing and tracking cash transactions.
-
-
Instrument
-
Text field.
-
For FX Trade transactions:
-
A currency that is being purchased (buy currency - base) in a foreign exchange transaction.
-
-
Must be an alphabetic code of a currency alphabetic code (e.g.
USD
,EUR
,CHF
).
-
-
Allocation (PL)
-
Text field. Case-sensitive.
-
An instrument to which the financial outcome of a transaction is attributed or allocated.
-
Value must be:
-
ISIN (e.g.
GB00BFZNLB60
) to import Instrument from Finmars Database -
user_code - for instruments without ISIN or already created instruments.
-
-
-
Position size
-
Numeric field.
-
For FX Trade transactions:
-
An amount of a particular currency that is being purchased (buy currency - base) in a foreign exchange transaction.
-
-
A sign of the number:
-
“
+
" (plus sign) is for position increase -
“
-
" (minus sign) is for position decrease
-
-
-
Principal/Share price
-
Numeric field.
-
For FX Trade transactions:
-
An exchange rate used for a contract’s foreign exchange transaction, where Sell currency is the Quote currency and Buy currency is the Base currency (e.g. we sell 110 USD and buy 100 EUR, then the field’s value should be 1.1 EUR/USD).
-
-
A sign of the number:
-
“
+
" (plus sign) is for standard prices -
“
-
" (minus sign) is for special prices (e.g. for exotic derivatives)
-
-
-
Amount (Carry)
-
Numeric field.
-
For FX Trade transactions values should be “
0
" (zero).
-
-
Amount (Charges)
-
Numeric field.
-
For FX Trade transactions values should be “
0
" (zero).
-
-
Cash Consideration
-
Numeric field.
-
For FX Trade transactions:
-
An amount of a particular currency that is being sold (sell currency - quote) in a foreign exchange transaction.
-
-
A sign of the number:
-
“+” (plus sign) is for position increase
-
“-” (minus sign) is for position decrease
-
-
-
Currency (Settlement)
-
Text field. Case-sensitive.
-
For FX Trade transactions:
-
A currency that is being sold (sell currency - quote) in a foreign exchange transaction.
-
-
Must be an alphabetic code of a currency alphabetic code (e.g.
USD
,EUR
,CHF
).
-
-
Notes
-
Text field.
-
Additional comments, instructions, or relevant information associated with a particular transaction.
-
If there are no notes enter “
-
" (dash).
-
-
Payment Purpose (for Income/Expense)
-
Text field. Case-sensitive.
-
For FX Trade transactions values should be “
-
" (dash).
-
-
Reference transaction code
-
Text field. Case-sensitive.
-
A reference to related transactions' unique identifiers.
-
For reverse transaction you can specify a transaction ID of the reversed transaction.
-
-
Portfolio To
-
Text field. Case-sensitive.
-
For FX Trade transactions values should be “
-
" (dash).
-
-
Account To (Cash)
-
Text field. Case-sensitive.
-
For FX Trade transactions values should be “
-
" (dash).
-
-
Account To (Position)
-
Text field. Case-sensitive.
-
For FX Trade transactions values should be “
-
" (dash).
-
-
Position size New
-
Numeric field.
- For FX Trade transactions values should be “
0
" (zero).
-
-
Principal/Share price New
-
Numeric field.
- For FX Trade transactions values should be “
0
" (zero).
-
-
Counterparty
-
Text field. Case-sensitive.
-
-
Responsible
-
Text field. Case-sensitive.
-
-
Strategy1
-
Text field. Case-sensitive.
-
Transfer Cash
-
Transaction ID
-
Text field. Case-sensitive.
-
A unique complex transaction identifier (only one in the workspace).
-
Transactions with repeated ID will NOT be booked (will be skipped).
-
-
Transaction Type
-
Text field. Case-sensitive.
-
Type of a transaction.
-
Should be a value from Standard transaction types for Transactions.
-
For Transfer Cash transactions values should be:
-
Transfer Cash
-
-
-
Reverse
-
Text field.
-
Indicator for a reverse transaction.
-
Valid values:
-
True
-
False
-
-
This field has only indicative meaning and will NOT invert any signs in other fields.
-
-
Date (Trade)
-
Date field.
-
A date on which a particular financial transaction is executed or agreed upon.
-
Format should be: “YYYY-MM-DD” (e.g. “
2000-12-31
")
-
-
Date (Value)
-
Date field.
-
A date when cash or funds are expected to be received or paid as part of a financial transaction.
-
Format should be: “YYYY-MM-DD” (e.g. “
2000-12-31
") -
For Deposit/Withdraw transactions:
-
Date (Value)
should be equal toDate (Trade)
-
-
-
Portfolio
-
Text field. Case-sensitive.
-
A collection of financial assets or investments held by an individual or organization.
-
-
Account (Cash)
-
Text field. Case-sensitive.
-
An account that is specifically designated for managing and tracking cash transactions.
-
-
Currency (Settlement)
-
Text field. Case-sensitive.
-
A currency in which the payment or transfer of funds takes place to fulfil the terms of the transaction.
-
Must be an alphabetic code of a currency alphabetic code (e.g.
USD
,EUR
,CHF
).
-
-
Cash Consideration
-
Numeric field.
-
A monetary value or payment made in the form of cash for a particular transaction or asset.
-
Must be in Settlement Currency.
-
A sign of the number:
-
“
+
" (plus sign) is for income -
“
-
" (minus sign) is for expenses
-
-
-
Account (Position)
-
Text field. Case-sensitive.
-
For Transfer Cash transactions values should be “
-
" (dash).
-
-
Instrument
-
Text field. Case-sensitive.
-
For Transfer Cash transactions values should be “
-
" (dash).
-
-
Allocation (PL)
-
Text field. Case-sensitive.
-
For Transfer Cash transactions values should be “
-
" (dash).
-
-
Position size
-
Numeric field.
-
For Transfer Cash transactions values should be “
0
" (zero).
-
-
Principal/Share price
-
Numeric field.
-
For Transfer Cash transactions values should be “
0
" (zero) for default. -
A sign of the number:
-
“
+
" (plus sign) is for standard prices -
“
-
" (minus sign) is for special prices (e.g. for exotic derivatives)
-
-
-
Amount (Carry)
-
Numeric field.
-
For Transfer Cash transactions values should be “
0
" (zero).
-
-
Amount (Charges)
-
Numeric field.
-
For Transfer Cash transactions values should be “
0
" (zero).
-
-
Notes
-
Text field.
-
Additional comments, instructions, or relevant information associated with a particular transaction.
-
If there are no notes enter “
-
" (dash).
-
-
Payment Purpose (for Income/Expense)
-
Text field. Case-sensitive.
-
For Transfer Cash transactions values should be “
-
" (dash).
-
-
Reference transaction code
-
Text field. Case-sensitive.
-
A reference to related transactions' unique identifiers.
-
For reverse transaction you can specify a transaction ID of the reversed transaction.
-
-
Portfolio To
-
Text field. Case-sensitive.
-
A collection of financial assets or investments held by an individual or organization where the transaction transfer to.
-
-
Account To (Cash)
-
Text field. Case-sensitive.
-
An account that is specifically designated for managing and tracking cash transactions where the transaction transfer to.
-
-
Account To (Position)
-
Text field. Case-sensitive.
-
For Transfer Cash transactions values should be “
-
" (dash).
-
-
Position size New
-
Numeric field.
- For Transfer Cash transactions values should be “
0
" (zero).
-
-
Principal/Share price New
-
Numeric field.
- For Transfer Cash transactions values should be “
0
" (zero).
-
-
Counterparty
-
Text field. Case-sensitive.
-
-
Responsible
-
Text field. Case-sensitive.
-
-
Strategy1
-
Text field. Case-sensitive.
-
Transfer Cash (In/Out)
-
Transaction ID
-
Text field. Case-sensitive.
-
A unique complex transaction identifier (only one in the workspace).
-
Transactions with repeated ID will NOT be booked (will be skipped).
-
-
Transaction Type
-
Text field. Case-sensitive.
-
Type of a transaction.
-
Should be a value from Standard transaction types for Transactions.
-
For Transfer Cash (In/Out) transactions values should be:
-
Transfer Cash (In)
Transfer Cash (Out)
-
-
-
Reverse
-
Text field.
-
Indicator for a reverse transaction.
-
Valid values:
-
True
-
False
-
-
This field has only indicative meaning and will NOT invert any signs in other fields.
-
-
Date (Trade)
-
Date field.
-
A date on which a particular financial transaction is executed or agreed upon.
-
Format should be: “YYYY-MM-DD” (e.g. “
2000-12-31
")
-
-
Date (Value)
-
Date field.
-
A date when cash or funds are expected to be received or paid as part of a financial transaction.
-
Format should be: “YYYY-MM-DD” (e.g. “
2000-12-31
") -
For Deposit/Withdraw transactions:
-
Date (Value)
should be equal toDate (Trade)
-
-
-
Portfolio
-
Text field. Case-sensitive.
-
A collection of financial assets or investments held by an individual or organization.
-
-
Account (Cash)
-
Text field. Case-sensitive.
-
An account that is specifically designated for managing and tracking cash transactions.
-
-
Currency (Settlement)
-
Text field. Case-sensitive.
-
A currency in which the payment or transfer of funds takes place to fulfil the terms of the transaction.
-
Must be an alphabetic code of a currency alphabetic code (e.g.
USD
,EUR
,CHF
).
-
-
Cash Consideration
-
Numeric field.
-
A monetary value or payment made in the form of cash for a particular transaction or asset.
-
Must be in Settlement Currency.
-
A sign of the number:
-
“
+
" (plus sign) is for income -
“
-
" (minus sign) is for expenses
-
-
-
Account (Position)
-
Text field. Case-sensitive.
-
For Transfer Cash (In/Out) transactions values should be “
-
" (dash).
-
-
Instrument
-
Text field. Case-sensitive.
-
For Transfer Cash (In/Out) transactions values should be “
-
" (dash).
-
-
Allocation (PL)
-
Text field. Case-sensitive.
-
For Transfer Cash (In/Out) transactions values should be “
-
" (dash).
-
-
Position size
-
Numeric field.
-
For Transfer Cash (In/Out) transactions values should be “
0
" (zero).
-
-
Principal/Share price
-
Numeric field.
-
For Transfer Cash (In/Out) transactions values should be “
0
" (zero) for default. -
A sign of the number:
-
“
+
" (plus sign) is for standard prices -
“
-
" (minus sign) is for special prices (e.g. for exotic derivatives)
-
-
-
Amount (Carry)
-
Numeric field.
-
For Transfer Cash (In/Out) transactions values should be “
0
" (zero).
-
-
Amount (Charges)
-
Numeric field.
-
For Transfer Cash (In/Out) transactions values should be “
0
" (zero).
-
-
Notes
-
Text field.
-
Additional comments, instructions, or relevant information associated with a particular transaction.
-
If there are no notes enter “
-
" (dash).
-
-
Payment Purpose (for Income/Expense)
-
Text field. Case-sensitive.
-
For Transfer Cash (In/Out) transactions values should be “
-
" (dash).
-
-
Reference transaction code
-
Text field. Case-sensitive.
-
A reference to related transactions' unique identifiers.
-
For reverse transaction you can specify a transaction ID of the reversed transaction.
-
-
Portfolio To
-
Text field. Case-sensitive.
- For Transfer Cash (In/Out) transactions values should be “
-
" (dash).
-
-
Account To (Cash)
-
Text field. Case-sensitive.
- For Transfer Cash (In/Out) transactions values should be “
-
" (dash).
-
-
Account To (Position)
-
Text field. Case-sensitive.
-
For Transfer Cash (In/Out) transactions values should be “
-
" (dash).
-
-
Position size New
-
Numeric field.
- For Transfer Cash (In/Out) transactions values should be “
0
" (zero).
-
-
Principal/Share price New
-
Numeric field.
- For Transfer Cash (In/Out) transactions values should be “
0
" (zero).
-
-
Counterparty
-
Text field. Case-sensitive.
-
-
Responsible
-
Text field. Case-sensitive.
-
-
Strategy1
-
Text field. Case-sensitive.
-
Transfer Instrument
-
Transaction ID
-
Text field. Case-sensitive.
-
A unique complex transaction identifier (only one in the workspace).
-
Transactions with repeated ID will NOT be booked (will be skipped).
-
-
Transaction Type
-
Text field. Case-sensitive.
-
Type of a transaction.
- Should be a value from Standard transaction types for Transactions.
-
For Transfer Instrument transactions values should be:
-
Transfer Instrument
-
-
-
Reverse
-
Text field.
-
Indicator for a reverse transaction.
-
Valid values:
-
True
-
False
-
-
This field has only indicative meaning and will NOT invert any signs in other fields.
-
-
Date (Trade)
-
Date field.
-
A date on which a particular financial transaction is executed or agreed upon.
-
Format should be: “YYYY-MM-DD” (e.g. “
2000-12-31
")
-
-
Date (Value)
-
Date field.
-
A date when cash or funds are expected to be received or paid as part of a financial transaction.
-
Format should be: “YYYY-MM-DD” (e.g. “
2000-12-31
")
-
-
Portfolio
-
Text field. Case-sensitive.
-
A collection of financial assets or investments held by an individual or organization.
-
-
Account (Cash)
-
Text field. Case-sensitive.
-
An account that is specifically designated for managing and tracking cash transactions.
-
-
Currency (Settlement)
-
Text field. Case-sensitive.
-
A currency in which the payment or transfer of funds takes place to fulfil the terms of the transaction.
-
Must be an alphabetic code of a currency alphabetic code (e.g.
USD
,EUR
,CHF
).
-
-
Cash Consideration
-
Numeric field.
-
A monetary value or payment made in the form of cash for a particular transaction or asset.
-
Must be in Settlement Currency.
-
A sign of the number:
-
“
+
" (plus sign) is for income -
“
-
" (minus sign) is for expenses
-
-
-
Account (Position)
-
Text field. Case-sensitive.
-
An account that tracks and records the positions or holdings of assets.
-
- Instrument
-
Text field. Case-sensitive.
-
A financial asset or security involved in a transaction.
-
Value must be:
-
ISIN (e.g.
GB00BFZNLB60
) to import Instrument from Finmars Database -
user_code - for instruments without ISIN or already created instruments.
-
-
-
Allocation (PL)
-
Text field. Case-sensitive.
-
For Transfer Instrument transactions values should be “
-
" (dash).
-
-
Position size
-
Numeric field.
- An adjusted position of the asset after all alterations or corrections (e.g. adjusted for a factor).
-
A sign of the number:
-
“
+
" (plus sign) is for position increase -
“
-
" (minus sign) is for position decrease
-
-
-
Principal/Share price
-
Numeric field.
-
For Transfer Instrument transactions this field is a Principal price:
-
A unit price or value of a financial instrument, excluding any accrued interest or additional earnings.
-
-
Must be in Settlement Currency.
-
Multipliers will be applied automatically in accordance with an instrument of the transaction.
-
A sign of the number:
-
“
+
" (plus sign) is for standard prices -
“
-
" (minus sign) is for special prices (e.g. for exotic derivatives)
-
-
-
Amount (Carry)
-
Numeric field.
-
An amount or expense that has been incurred but not yet paid or settled.
-
Must be in Settlement Currency.
-
A sign of the number:
-
“
+
" (plus sign) is for income -
“
-
" (minus sign) is for expenses
-
-
-
Amount (Charges)
-
Numeric field.
-
Costs or fees associated with a transaction.
-
Must be in Settlement Currency.
-
A sign of the number:
-
“
+
" (plus sign) is for income -
“
-
" (minus sign) is for expenses
-
-
-
Notes
-
Text field.
-
Additional comments, instructions, or relevant information associated with a particular transaction.
-
If there are no notes enter “-” (dash).
-
-
Payment Purpose (for Income/Expense)
-
Text field. Case-sensitive.
-
For Transfer Instrument transactions values should be “-" (dash).
-
-
Reference transaction code
-
Text field. Case-sensitive.
-
A reference to related transactions' unique identifiers.
-
For reverse transaction you can specify a transaction ID of the reversed transaction.
-
-
Portfolio To
-
Text field. Case-sensitive.
-
A collection of financial assets or investments held by an individual or organization where the transaction transfer to.
-
-
Account To (Cash)
-
Text field. Case-sensitive.
-
For Transfer Instrument transactions values should be “
-
" (dash).
-
-
Account To (Position)
-
Text field. Case-sensitive.
-
An account that tracks and records the positions or holdings of assets where the transaction transfer to.
-
-
Position size New
-
Numeric field.
- For Transfer Instrument transactions values should be “
0
" (zero).
-
-
Principal/Share price New
-
Numeric field.
- For Transfer Instrument transactions values should be “
0
" (zero).
-
-
Counterparty
-
Text field. Case-sensitive.
-
-
Responsible
-
Text field. Case-sensitive.
-
-
Strategy1
-
Text field. Case-sensitive.
-
Transfer Instrument (In/Out)
-
Transaction ID
-
Text field. Case-sensitive.
-
A unique complex transaction identifier (only one in the workspace).
-
Transactions with repeated ID will NOT be booked (will be skipped).
-
-
Transaction Type
-
Text field. Case-sensitive.
-
Type of a transaction.
- Should be a value from Standard transaction types for Transactions.
-
For Transfer Instrument (In/Out) transactions values should be:
-
Transfer Instrument (In)
Transfer Instrument (Out)
-
-
-
Reverse
-
Text field.
-
Indicator for a reverse transaction.
-
Valid values:
-
True
-
False
-
-
This field has only indicative meaning and will NOT invert any signs in other fields.
-
-
Date (Trade)
-
Date field.
-
A date on which a particular financial transaction is executed or agreed upon.
-
Format should be: “YYYY-MM-DD” (e.g. “
2000-12-31
")
-
-
Date (Value)
-
Date field.
-
A date when cash or funds are expected to be received or paid as part of a financial transaction.
-
Format should be: “YYYY-MM-DD” (e.g. “
2000-12-31
")
-
-
Portfolio
-
Text field. Case-sensitive.
-
A collection of financial assets or investments held by an individual or organization.
-
-
Account (Cash)
-
Text field. Case-sensitive.
-
An account that is specifically designated for managing and tracking cash transactions.
-
-
Currency (Settlement)
-
Text field. Case-sensitive.
-
A currency in which the payment or transfer of funds takes place to fulfil the terms of the transaction.
-
Must be an alphabetic code of a currency alphabetic code (e.g.
USD
,EUR
,CHF
).
-
-
Cash Consideration
-
Numeric field.
-
A monetary value or payment made in the form of cash for a particular transaction or asset.
-
Must be in Settlement Currency.
-
A sign of the number:
-
“
+
" (plus sign) is for income -
“
-
" (minus sign) is for expenses
-
-
-
Account (Position)
-
Text field. Case-sensitive.
-
An account that tracks and records the positions or holdings of assets.
-
- Instrument
-
Text field. Case-sensitive.
-
A financial asset or security involved in a transaction.
-
Value must be:
-
ISIN (e.g.
GB00BFZNLB60
) to import Instrument from Finmars Database -
user_code - for instruments without ISIN or already created instruments.
-
-
-
Allocation (PL)
-
Text field. Case-sensitive.
-
For Transfer Instrument (In/Out) transactions values should be “
-
" (dash).
-
-
Position size
-
Numeric field.
- An adjusted position of the asset after all alterations or corrections (e.g. adjusted for a factor).
-
A sign of the number:
-
“
+
" (plus sign) is for position increase -
“
-
" (minus sign) is for position decrease
-
-
-
Principal/Share price
-
Numeric field.
-
For Transfer Instrument (In/Out) transactions this field is a Principal price:
-
A unit price or value of a financial instrument, excluding any accrued interest or additional earnings.
-
-
Must be in Settlement Currency.
-
Multipliers will be applied automatically in accordance with an instrument of the transaction.
-
A sign of the number:
-
“
+
" (plus sign) is for standard prices -
“
-
" (minus sign) is for special prices (e.g. for exotic derivatives)
-
-
-
Amount (Carry)
-
Numeric field.
-
An amount or expense that has been incurred but not yet paid or settled.
-
Must be in Settlement Currency.
-
A sign of the number:
-
“
+
" (plus sign) is for income -
“
-
" (minus sign) is for expenses
-
-
-
Amount (Charges)
-
Numeric field.
-
Costs or fees associated with a transaction.
-
Must be in Settlement Currency.
-
A sign of the number:
-
“
+
" (plus sign) is for income -
“
-
" (minus sign) is for expenses
-
-
-
Notes
-
Text field.
-
Additional comments, instructions, or relevant information associated with a particular transaction.
-
If there are no notes enter “-” (dash).
-
-
Payment Purpose (for Income/Expense)
-
Text field. Case-sensitive.
-
For Transfer Instrument (In/Out) transactions values should be “-" (dash).
-
-
Reference transaction code
-
Text field. Case-sensitive.
-
A reference to related transactions' unique identifiers.
-
For reverse transaction you can specify a transaction ID of the reversed transaction.
-
-
Portfolio To
-
Text field. Case-sensitive.
- For Transfer Instrument (In/Out) transactions values should be “
-
" (dash).
-
-
Account To (Cash)
-
Text field. Case-sensitive.
-
For Transfer Instrument (In/Out) transactions values should be “
-
" (dash).
-
-
Account To (Position)
-
Text field. Case-sensitive.
- For Transfer Instrument (In/Out) transactions values should be “
-
" (dash).
-
-
Position size New
-
Numeric field.
- For Transfer Instrument (In/Out) transactions values should be “
0
" (zero).
-
-
Principal/Share price New
-
Numeric field.
- For Transfer Instrument (In/Out) transactions values should be “
0
" (zero).
-
-
Counterparty
-
Text field. Case-sensitive.
-
-
Responsible
-
Text field. Case-sensitive.
-
-
Strategy1
-
Text field. Case-sensitive.
-
FX Forward (Open)/FX Forward (Expiration)
-
Transaction ID
-
Text field. Case-sensitive.
-
A unique complex transaction identifier (only one in the workspace).
-
Transactions with repeated ID will NOT be booked (will be skipped).
-
-
Transaction Type
-
Text field. Case-sensitive.
-
Type of a transaction.
-
Should be a value from Standard transaction types for Transactions.
-
For FX Forward (Open)/FX Forward (Expiration) transactions values should be:
FX Forward (Open)
-
FX Forward (Expiration)
-
-
Reverse
-
Text field.
-
Indicator for a reverse transaction.
-
Valid values:
-
True
-
False
-
-
This field has only indicative meaning and will NOT invert any signs in other fields.
-
-
Date (Trade)
-
Date field.
-
A date on which a particular financial transaction is executed or agreed upon.
-
Format should be: “YYYY-MM-DD” (e.g. “
2000-12-31
")
-
-
Date (Value)
-
Date field.
-
A date when cash or funds are expected to be received or paid as part of a financial transaction.
-
Format should be: “YYYY-MM-DD” (e.g. “
2000-12-31
")
-
-
Portfolio
-
Text field. Case-sensitive.
-
A collection of financial assets or investments held by an individual or organization.
-
-
Account (Cash)
-
Text field. Case-sensitive.
-
An account that is specifically designated for managing and tracking cash transactions.
-
-
Instrument
-
Text field.
-
For FX Forward (Open)/FX Forward (Expiration) transactions:
-
A currency that is being purchased (buy currency - base) in a foreign exchange transaction.
-
-
Must be an alphabetic code of a currency alphabetic code (e.g.
USD
,EUR
,CHF
).
-
-
Allocation (PL)
-
Text field. Case-sensitive.
-
An instrument to which the financial outcome of a transaction is attributed or allocated.
-
Value must be:
-
ISIN (e.g.
GB00BFZNLB60
) to import Instrument from Finmars Database -
user_code - for instruments without ISIN or already created instruments.
-
-
-
Position size
-
Numeric field.
-
For FX Forward (Open)/FX Forward (Expiration) transactions:
-
An amount of a particular currency that is being purchased (buy currency - base) in a foreign exchange transaction.
-
-
A sign of the number:
-
“
+
" (plus sign) is for position increase -
“
-
" (minus sign) is for position decrease
-
-
-
Principal/Share price
-
Numeric field.
-
For FX Forward (Open)/FX Forward (Expiration) transactions:
-
An exchange rate used for a contract’s foreign exchange transaction, where Sell currency is the Quote currency and Buy currency is the Base currency (e.g. we sell 110 USD and buy 100 EUR, then the field’s value should be 1.1 EUR/USD).
-
-
A sign of the number:
-
“
+
" (plus sign) is for standard prices -
“
-
" (minus sign) is for special prices (e.g. for exotic derivatives)
-
-
-
Amount (Carry)
-
Numeric field.
-
For FX Forward (Open)/FX Forward (Expiration) transactions values should be “
0
" (zero).
-
-
Amount (Charges)
-
Numeric field.
-
For FX Forward (Open)/FX Forward (Expiration) transactions values should be “
0
" (zero).
-
-
Cash Consideration
-
Numeric field.
-
For FX Forward (Open)/FX Forward (Expiration) transactions:
-
An amount of a particular currency that is being sold (sell currency - quote) in a foreign exchange transaction.
-
-
A sign of the number:
-
“+” (plus sign) is for position increase
-
“-” (minus sign) is for position decrease
-
-
-
Currency (Settlement)
-
Text field. Case-sensitive.
-
For FX Forward (Open)/FX Forward (Expiration) transactions:
-
A currency that is being sold (sell currency - quote) in a foreign exchange transaction.
-
-
Must be an alphabetic code of a currency alphabetic code (e.g.
USD
,EUR
,CHF
).
-
-
Notes
-
Text field.
-
Additional comments, instructions, or relevant information associated with a particular transaction.
-
If there are no notes enter “
-
" (dash).
-
-
Payment Purpose (for Income/Expense)
-
Text field. Case-sensitive.
-
For FX Forward (Open)/FX Forward (Expiration) transactions values should be “
-
" (dash).
-
-
Reference transaction code
-
Text field. Case-sensitive.
-
A reference to related transactions' unique identifiers.
-
For reverse transaction you can specify a transaction ID of the reversed transaction.
-
-
Portfolio To
-
Text field. Case-sensitive.
-
For FX Forward (Open)/FX Forward (Expiration) transactions values should be “
-
" (dash).
-
-
Account To (Cash)
-
Text field. Case-sensitive.
-
For FX Forward (Open)/FX Forward (Expiration) transactions values should be “
-
" (dash).
-
-
Account To (Position)
-
Text field. Case-sensitive.
-
For FX Forward (Open)/FX Forward (Expiration) transactions values should be “
-
" (dash).
-
-
Position size New
-
Numeric field.
- For FX Forward (Open)/FX Forward (Expiration) transactions values should be “
0
" (zero).
-
-
Principal/Share price New
-
Numeric field.
- For FX Forward (Open)/FX Forward (Expiration) transactions values should be “
0
" (zero).
-
-
Counterparty
-
Text field. Case-sensitive.
-
-
Responsible
-
Text field. Case-sensitive.
-
-
Strategy1
-
Text field. Case-sensitive.
-
Split/Reverse Split
-
Transaction ID
-
Text field. Case-sensitive.
-
A unique complex transaction identifier (only one in the workspace).
-
Transactions with repeated ID will NOT be booked (will be skipped).
-
-
Transaction Type
-
Text field. Case-sensitive.
-
Type of a transaction.
- Should be a value from Standard transaction types for Transactions.
-
For Split/Reverse Split transactions values should be:
-
Split
-
Reverse Split
-
-
-
Reverse
-
Text field.
-
Indicator for a reverse transaction.
-
Valid values:
-
True
-
False
-
-
This field has only indicative meaning and will NOT invert any signs in other fields.
-
-
Date (Trade)
-
Date field.
-
A date on which a particular financial transaction is executed or agreed upon.
-
Format should be: “YYYY-MM-DD” (e.g. “
2000-12-31
")
-
-
Date (Value)
-
Date field.
-
A date when cash or funds are expected to be received or paid as part of a financial transaction.
-
Format should be: “YYYY-MM-DD” (e.g. “
2000-12-31
")
-
-
Portfolio
-
Text field. Case-sensitive.
-
A collection of financial assets or investments held by an individual or organization.
-
-
Account (Cash)
-
Text field. Case-sensitive.
-
An account that is specifically designated for managing and tracking cash transactions.
-
-
Currency (Settlement)
-
Text field. Case-sensitive.
-
A currency in which the payment or transfer of funds takes place to fulfil the terms of the transaction.
-
Must be an alphabetic code of a currency alphabetic code (e.g.
USD
,EUR
,CHF
).
-
-
Cash Consideration
-
Numeric field.
- A monetary value or payment made in the form of cash for a particular transaction or asset.
-
Must be in Settlement Currency.
-
A sign of the number:
-
“
+
" (plus sign) is for income -
“
-
" (minus sign) is for expenses
-
-
-
Account (Position)
-
Text field. Case-sensitive.
-
An account that tracks and records the positions or holdings of assets.
-
- Instrument
-
Text field. Case-sensitive.
-
A financial asset or security involved in a transaction.
-
Value must be:
-
ISIN (e.g.
GB00BFZNLB60
) to import Instrument from Finmars Database -
user_code - for instruments without ISIN or already created instruments.
-
-
-
Allocation (PL)
-
Text field. Case-sensitive.
-
An instrument to which the financial outcome of a transaction is attributed or allocated.
-
Value must be:
-
ISIN (e.g.
GB00BFZNLB60
) to import Instrument from Finmars Database -
user_code - for instruments without ISIN or already created instruments.
-
-
-
Position size
-
Numeric field.
- An adjusted position of the asset after all alterations or corrections (e.g. adjusted for a factor).
-
A sign of the number:
-
“
+
" (plus sign) is for position increase -
“
-
" (minus sign) is for position decrease
-
-
-
Principal/Share price
-
Numeric field.
-
For Split/Reverse Split transactions this field is a Principal price:
-
A unit price or value of a financial instrument, excluding any accrued interest or additional earnings.
-
-
Must be in Settlement Currency.
-
Multipliers will be applied automatically in accordance with an instrument of the transaction.
-
A sign of the number:
-
“
+
" (plus sign) is for standard prices -
“
-
" (minus sign) is for special prices (e.g. for exotic derivatives)
-
-
-
Amount (Carry)
-
Numeric field.
-
An amount or expense that has been incurred but not yet paid or settled.
-
Must be in Settlement Currency.
-
A sign of the number:
-
“
+
" (plus sign) is for income -
“
-
" (minus sign) is for expenses
-
-
-
Amount (Charges)
-
Numeric field.
-
Costs or fees associated with a transaction.
-
Must be in Settlement Currency.
-
A sign of the number:
-
“
+
" (plus sign) is for income -
“
-
" (minus sign) is for expenses
-
-
-
Notes
-
Text field.
-
Additional comments, instructions, or relevant information associated with a particular transaction.
-
If there are no notes enter “-” (dash).
-
-
Payment Purpose (for Income/Expense)
-
Text field. Case-sensitive.
-
For Split/Reverse Split transactions values should be “-" (dash).
-
-
Reference transaction code
-
Text field. Case-sensitive.
-
A reference to related transactions' unique identifiers.
-
For reverse transaction you can specify a transaction ID of the reversed transaction.
-
-
Portfolio To
-
Text field. Case-sensitive.
-
For Split/Reverse Split transactions values should be “
-
" (dash).
-
-
Account To (Cash)
-
Text field. Case-sensitive.
-
For Split/Reverse Split transactions values should be “
-
" (dash).
-
-
Account To (Position)
-
Text field. Case-sensitive.
-
For Split/Reverse Split transactions values should be “
-
" (dash).
-
-
Position size New
-
Numeric field.
- A new (e.g. after Corporate Action) quantity or size of an asset or instrument after any changes or corrections made to the nominal position. With sign of instrument movement (+ is for increase, - is for decrese).
-
A sign of the number:
-
“
+
" (plus sign) is for position increase -
“
-
" (minus sign) is for position decrease
-
-
-
Principal/Share price New
-
Numeric field.
-
For Split/Reverse Split transactions this field is a Principal price:
-
A new (e.g. after Corporate Action) unit price or value of a financial instrument, excluding any accrued interest or additional earnings.
-
-
Must be in Settlement Currency.
-
Multipliers will be applied automatically in accordance with an instrument of the transaction.
-
A sign of the number:
-
“
+
" (plus sign) is for standard prices -
“
-
" (minus sign) is for special prices (e.g. for exotic derivatives)
-
-
-
Counterparty
-
Text field. Case-sensitive.
-
-
Responsible
-
Text field. Case-sensitive.
-
-
Strategy1
-
Text field. Case-sensitive.
-
Positions Initial/Daily
-
To book a position in the system you can import it from a file, what differentiate Initial from Daily is Import Schemes, use corresponding.
-
One position is one row of data in the file.
-
You should enter a position in the file for import in accordance with the instructions below for supported standard transaction types.
- Supported Standard transaction types for Positions Initial/Daily list (case-sensitive):
-
Positions Initial/Daily (different schemes use the same selectors):
-
Position Cash
-
Position Instrument
-
Position FX Forward
-
-
Position Cash
Daily transaction type is valid only on the trade date then position will be nullified.
-
Transaction ID
-
Text field. Case-sensitive.
-
A unique complex transaction identifier (only one in the workspace).
-
Transactions with repeated ID will NOT be booked (will be skipped).
-
-
Transaction Type
-
Text field. Case-sensitive.
-
Type of a transaction.
- Should be a value from Standard transaction types for Positions.
-
For Position Cash transactions values should be:
-
Position Cash
-
-
-
Reverse
-
Text field.
-
Indicator for a reverse transaction.
-
Valid values:
-
True
-
False
-
-
This field has only indicative meaning and will NOT invert any signs in other fields.
-
-
Date (Trade)
-
Date field.
-
A date on which a particular financial transaction is executed or agreed upon.
-
Format should be: “YYYY-MM-DD” (e.g. “
2000-12-31
")
-
-
Date (Value)
-
Date field.
-
A date when cash or funds are expected to be received or paid as part of a financial transaction.
-
Format should be: “YYYY-MM-DD” (e.g. “
2000-12-31
") -
For Position Cash transactions:
-
Date (Value)
should be equal toDate (Trade)
-
-
-
Portfolio
-
Text field. Case-sensitive.
-
A collection of financial assets or investments held by an individual or organization.
-
-
Account (Cash)
-
Text field. Case-sensitive.
-
An account that is specifically designated for managing and tracking cash transactions.
-
-
Currency (Settlement)
-
Text field. Case-sensitive.
-
A currency in which the payment or transfer of funds takes place to fulfil the terms of the transaction.
-
Must be an alphabetic code of a currency alphabetic code (e.g.
USD
,EUR
,CHF
).
-
-
Cash Consideration
-
Numeric field.
-
A monetary value or payment made in the form of cash for a particular transaction or asset.
-
Must be in Settlement Currency.
-
A sign of the number:
-
“
+
" (plus sign) is for income -
“
-
" (minus sign) is for expenses
-
-
-
Account (Position)
-
Text field. Case-sensitive.
-
For Position Cash transactions values should be “
-
" (dash).
-
-
Instrument
-
Text field. Case-sensitive.
-
For Position Cash transactions values should be “
-
" (dash).
-
-
Position size
-
Numeric field.
-
For Position Cash transactions values should be “
0
" (zero).
-
-
Principal/Share price
-
Numeric field.
-
For Position Cash transactions:
-
The share price of the open-end fund.
-
-
For Position Cash transactions values should be “
0
" (zero) for default. -
A sign of the number:
-
“
+
" (plus sign) is for standard prices -
“
-
" (minus sign) is for special prices (e.g. for exotic derivatives)
-
-
-
Amount (Carry)
-
Numeric field.
-
For Position Cash transactions values should be “
0
" (zero).
-
-
Amount (Charges)
-
Numeric field.
-
For Position Cash transactions values should be “
0
" (zero).
-
-
Notes
-
Text field.
-
Additional comments, instructions, or relevant information associated with a particular transaction.
-
If there are no notes enter “
-
" (dash).
-
-
Payment Purpose (for Income/Expense)
-
Text field. Case-sensitive.
-
For Position Cash transactions values should be “
-
" (dash).
-
-
Reference transaction code
-
Text field. Case-sensitive.
-
A reference to related transactions' unique identifiers.
-
For reverse transaction you can specify a transaction ID of the reversed transaction.
-
Position Instrument
Daily transaction type is valid only on the trade date then position will be nullified.
-
Transaction ID
-
Text field. Case-sensitive.
-
A unique complex transaction identifier (only one in the workspace).
-
Transactions with repeated ID will NOT be booked (will be skipped).
-
-
Transaction Type
-
Text field. Case-sensitive.
-
Type of a transaction.
- Should be a value from Standard transaction types for Positions.
-
For Position Instrument transactions values should be:
-
Position Instrument
-
-
-
Reverse
-
Text field.
-
Indicator for a reverse transaction.
-
Valid values:
-
True
-
False
-
-
This field has only indicative meaning and will NOT invert any signs in other fields.
-
-
Date (Trade)
-
Date field.
-
A date on which a particular financial transaction is executed or agreed upon.
-
Format should be: “YYYY-MM-DD” (e.g. “
2000-12-31
")
-
-
Date (Value)
-
Date field.
-
A date when cash or funds are expected to be received or paid as part of a financial transaction.
-
Format should be: “YYYY-MM-DD” (e.g. “
2000-12-31
") -
For Position Instrument transactions:
-
Date (Value)
should be equal toDate (Trade)
-
-
-
Portfolio
-
Text field. Case-sensitive.
-
A collection of financial assets or investments held by an individual or organization.
-
-
Account (Cash)
-
Text field. Case-sensitive.
-
An account that is specifically designated for managing and tracking cash transactions.
-
-
Currency (Settlement)
-
Text field. Case-sensitive.
-
A currency in which the payment or transfer of funds takes place to fulfil the terms of the transaction.
-
Must be an alphabetic code of a currency alphabetic code (e.g.
USD
,EUR
,CHF
).
-
-
Cash Consideration
-
Numeric field.
-
A monetary value or payment made in the form of cash for a particular transaction or asset.
-
Must be in Settlement Currency.
-
A sign of the number:
-
“
+
" (plus sign) is for income -
“
-
" (minus sign) is for expenses
-
-
-
Account (Position)
-
Text field. Case-sensitive.
-
An account that tracks and records the positions or holdings of assets.
-
- Instrument
-
Text field. Case-sensitive.
-
A financial asset or security involved in a transaction.
-
Value must be:
-
ISIN (e.g.
GB00BFZNLB60
) to import Instrument from Finmars Database -
user_code - for instruments without ISIN or already created instruments.
-
-
-
Position size
-
Numeric field.
- An adjusted position of the asset after all alterations or corrections (e.g. adjusted for a factor).
-
A sign of the number:
-
“
+
" (plus sign) is for position increase -
“
-
" (minus sign) is for position decrease
-
-
-
Principal/Share price
-
Numeric field.
-
For Position Instrument transactions this field is a Principal price:
-
A unit price or value of a financial instrument, excluding any accrued interest or additional earnings.
-
-
Must be in Settlement Currency.
-
Multipliers will be applied automatically in accordance with an instrument of the transaction.
-
A sign of the number:
-
“
+
" (plus sign) is for standard prices -
“
-
" (minus sign) is for special prices (e.g. for exotic derivatives)
-
-
-
Amount (Carry)
-
Numeric field.
-
An amount or expense that has been incurred but not yet paid or settled.
-
Must be in Settlement Currency.
-
A sign of the number:
-
“
+
" (plus sign) is for income -
“
-
" (minus sign) is for expenses
-
-
-
Amount (Charges)
-
Numeric field.
-
Costs or fees associated with a transaction.
-
Must be in Settlement Currency.
-
A sign of the number:
-
“
+
" (plus sign) is for income -
“
-
" (minus sign) is for expenses
-
-
-
Notes
-
Text field.
-
Additional comments, instructions, or relevant information associated with a particular transaction.
-
If there are no notes enter “-” (dash).
-
-
Payment Purpose (for Income/Expense)
-
Text field. Case-sensitive.
- For Position Instrument transactions values should be “-" (dash).
-
-
Reference transaction code
-
Text field. Case-sensitive.
-
A reference to related transactions' unique identifiers.
-
For reverse transaction you can specify a transaction ID of the reversed transaction.
-
Position FX Forward
-
Transaction ID
-
Text field. Case-sensitive.
-
A unique complex transaction identifier (only one in the workspace).
-
Transactions with repeated ID will NOT be booked (will be skipped).
-
-
Transaction Type
-
Text field. Case-sensitive.
-
Type of a transaction.
- Should be a value from Standard transaction types for Positions.
-
For Position FX Forward transactions values should be:
-
Position FX Forward
-
-
-
Reverse
-
Text field.
-
Indicator for a reverse transaction.
-
Valid values:
-
True
-
False
-
-
This field has only indicative meaning and will NOT invert any signs in other fields.
-
-
Date (Trade)
-
Date field.
-
A date on which a particular financial transaction is executed or agreed upon.
-
Format should be: “YYYY-MM-DD” (e.g. “
2000-12-31
")
-
-
Date (Value)
-
Date field.
-
A date when cash or funds are expected to be received or paid as part of a financial transaction.
-
Format should be: “YYYY-MM-DD” (e.g. “
2000-12-31
")
-
-
Portfolio
-
Text field. Case-sensitive.
-
A collection of financial assets or investments held by an individual or organization.
-
-
Account (Cash)
-
Text field. Case-sensitive.
-
An account that is specifically designated for managing and tracking cash transactions.
-
-
Instrument
-
Text field.
-
For Position FX Forward transactions:
-
A currency that is being purchased (buy currency - base) in a foreign exchange transaction.
-
-
Must be an alphabetic code of a currency alphabetic code (e.g.
USD
,EUR
,CHF
).
-
-
Position size
-
Numeric field.
-
For Position FX Forward transactions:
-
An amount of a particular currency that is being purchased (buy currency - base) in a foreign exchange transaction.
-
-
A sign of the number:
-
“
+
" (plus sign) is for position increase -
“
-
" (minus sign) is for position decrease
-
-
-
Principal/Share price
-
Numeric field.
-
For Position FX Forward transactions:
-
An exchange rate used for a contract’s foreign exchange transaction, where Sell currency is the Quote currency and Buy currency is the Base currency (e.g. we sell 110 USD and buy 100 EUR, then the field’s value should be 1.1 EUR/USD).
-
-
A sign of the number:
-
“
+
" (plus sign) is for standard prices -
“
-
" (minus sign) is for special prices (e.g. for exotic derivatives)
-
-
-
Amount (Carry)
-
Numeric field.
-
For Position FX Forward transactions values should be “
0
" (zero).
-
-
Amount (Charges)
-
Numeric field.
-
For Position FX Forward transactions values should be “
0
" (zero).
-
-
Cash Consideration
-
Numeric field.
-
For Position FX Forward transactions:
-
An amount of a particular currency that is being sold (sell currency - quote) in a foreign exchange transaction.
-
-
A sign of the number:
-
“+” (plus sign) is for position increase
-
“-” (minus sign) is for position decrease
-
-
-
Currency (Settlement)
-
Text field. Case-sensitive.
-
For Position FX Forward transactions:
-
A currency that is being sold (sell currency - quote) in a foreign exchange transaction.
-
-
Must be an alphabetic code of a currency alphabetic code (e.g.
USD
,EUR
,CHF
).
-
-
Notes
-
Text field.
-
Additional comments, instructions, or relevant information associated with a particular transaction.
-
If there are no notes enter “
-
" (dash).
-
-
Payment Purpose (for Income/Expense)
-
Text field. Case-sensitive.
-
For Position FX Forward transactions values should be “
-
" (dash).
-
-
Reference transaction code
-
Text field. Case-sensitive.
-
A reference to related transactions' unique identifiers.
-
For reverse transaction you can specify a transaction ID of the reversed transaction.
-
Instruments
Instruments
-
Instrument ID
-
Text field. Case-sensitive.
-
A unique user_code for a financial asset or security involved in a transaction.
-
-
ISIN
-
Text field. Case-sensitive.
-
An identification code assigned to a financial instrument (e.g.
GB00BFZNLB60
).
-
-
Pricing Currency
-
Text field. Case-sensitive.
-
A currency in which the valuation or pricing of a financial instrument is expressed.
-
Must be an alphabetic code of a currency alphabetic code (e.g.
USD
,EUR
,CHF
).
-
- Instrument Type
-
Text field. Case-sensitive.
-
A user-friendly name for a instrument type of financial asset or security involved in a transaction (may influence view forms).
-
Valid values:
Bond
CDS
CFD
Derivative
Forward
FX Forward Leg
Option
Other
Portfolio
Stock
T-Bill
-
-
Asset Type
-
Text field. Case-sensitive.
-
A user-friendly name for an asset type financial asset or security involved in a transaction.
-
Valid values:
-
Alternative Investments
-
Cash & Equivalents
-
Commodities
-
Crypto
-
Debt
-
Derivatives
-
Equipment
-
Equity
-
Other
-
Real Estate
-
Transport
-
-
-
Name
-
Text field. Case-sensitive.
-
A name of the entity.
-
-
Short Name
-
Text field. Case-sensitive.
-
A short name of the entity.
-
-
Public Name
-
Text field. Case-sensitive.
-
A public name of the entity. Will be shown instead of Name if user has no right to see this entity.
-
- Description
-
Text field. Case-sensitive.
-
Additional comments, instructions, or relevant information associated with a particular instrument.
-
If there are no notes enter “
-
" (dash).
-
-
Country
-
Text field. Case-sensitive.
-
A currency in which the valuation or pricing of a financial instrument is expressed.
-
Must be iso 3 symbols country alphabetic code (e.g.
LUX
,GBR
,USA
).
-
-
Security Price Multiplier
-
Numeric field.
-
A factor applied to adjust the nominal value of certain assets. For example, in the context of bonds, a price multiplier of 0.01 is used to convert the quoted price to its actual value.
-
-
Maturity Date
-
Date field.
-
A date on which a financial instrument (e.g. bond or certificate of deposit) reaches the end of its term.
-
Format should be: “YYYY-MM-DD” (e.g. “
2000-12-31
")
-
- Maturity Price
-
Numeric field.
-
A unit price or value of a financial instrument, excluding any accrued interest or additional earnings effective after and including Maturity Date.
-
Must be in instrument Pricing Currency.
-
Multipliers will be applied automatically in accordance with an instrument of the transaction.
-
A sign of the number:
-
“
+
" (plus sign) is for standard prices -
“
-
" (minus sign) is for special prices (e.g. for exotic derivatives)
-
-
-
Yellow Fields for Advanced settings can be left Empty
Instruments Accrual Schedules
-
Instrument ID
-
Text field. Case-sensitive.
-
A unique user_code for a financial asset or security involved in a transaction.
-
-
Accrual ID
-
Text field. Case-sensitive.
-
ID of accrual schedule entries (unique in one Instrument, may repeat for different instruments).
-
-
Accrual Start Date
-
Date field.
-
A date on which a financial instrument starts accrual.
-
Format should be: “YYYY-MM-DD” (e.g. “
2000-12-31
")
-
-
First Payment Date
-
Date field.
-
A date on which a financial instrument has its first accrual payment.
-
Format should be: “YYYY-MM-DD” (e.g. “
2000-12-31
")
-
-
Accrual Calculation Model
-
Text field. Case-sensitive.
-
A user code of the Day Count Convention a.k.a. Accrual Calculation Model (drop-down valid values in Excel).
-
Valid values (as per 2024-07-19 see reference in Finmars API like https://stage.finmars.com/REALM_CODE/SPACE_CODE/api/v1/instruments/accrual-calculation-model/):
-
DAY_COUNT_30_360_ISDA
-
DAY_COUNT_30_360_ISMA
-
DAY_COUNT_30_360_GERMAN
-
DAY_COUNT_30_360_US
-
DAY_COUNT_30_365
-
DAY_COUNT_30E_PLUS_360
-
DAY_COUNT_30E_360
-
DAY_COUNT_ACT_360
-
DAY_COUNT_ACT_364
-
DAY_COUNT_ACT_365
-
DAY_COUNT_ACT_365A
-
DAY_COUNT_ACT_365_FIXED
-
DAY_COUNT_ACT_365L
-
DAY_COUNT_ACT_366
-
DAY_COUNT_ACT_ACT_AFB
-
DAY_COUNT_ACT_ACT_ICMA
-
DAY_COUNT_ACT_ACT_ISDA
-
DAY_COUNT_BD_252
-
DAY_COUNT_NL_365
-
NONE
-
DAY_COUNT_SIMPLE
-
-
NONE
is only applicable for Periodicity with defined N for example:-
Accrual Calculation Model=N_DAY
andPeriodicity N=35
-
-
-
Periodicity
-
Text field. Case-sensitive.
-
A user code of the Periodicity (drop-down valid values in Excel).
-
Valid values (as per 2024-07-19 see reference in Finmars API like https://stage.finmars.com/REALM_CODE/SPACE_CODE/api/v1/instruments/periodicity/):
-
-
-
ANNUALLY
-
BIMONTHLY
-
MONTHLY
-
N_DAY
-
N_MONTH_EOM
-
N_MONTH_SAME_DAY
-
N_WEEK_EOBW
-
N_YEAR_EOY
-
N_YEAR_SAME_DAY
-
QUARTERLY
-
SEMI_ANNUALLY
-
WEEKLY
-
-
-
Periodicity N
-
Numeric field.
-
Only applicable for Periodicity with defined N, for example:
-
Accrual Calculation Model=N_DAY
andPeriodicity N=35
.
-
-
-
Accrual Size, %
-
Numeric field.
-
Accrual size is in %, so that you need to input 5 for 5% and NOT 0.05.
-
-
End of Month
-
Text field.
-
Indicator for a payment in the End of Month.
-
Valid values:
-
True
-
False
-
-
Instruments Factor Schedules
-
Instrument ID
-
Text field. Case-sensitive.
-
A unique user_code for a financial asset or security involved in a transaction.
-
-
Factor ID
-
Text field. Case-sensitive.
-
ID of factor schedule entries (unique in one Instrument, may repeat for different instruments).
-
-
Date
-
Date field.
-
A date on which a financial instrument set the factor.
-
Format should be: “YYYY-MM-DD” (e.g. “
2000-12-31
")
-
-
Factor
-
Numeric field.
-
Factor size is of float type, so that you need to input 0.5 for 50% and NOT 50.
-
Prices
-
Date
-
Date field.
-
A date of valuation.
-
Format should be: “YYYY-MM-DD” (e.g. “
2000-12-31
")
-
-
Instrument ID
-
Text field. Case-sensitive.
-
A unique user_code for a financial asset or security involved in a transaction.
-
-
Principal Price
-
Numeric field.
-
A unit price or value of a financial instrument, excluding any accrued interest or additional earnings.
-
Must be in instrument Pricing Currency.
-
Multipliers will be applied automatically in accordance with an instrument of the transaction.
-
A sign of the number:
-
“
+
" (plus sign) is for standard prices -
“
-
" (minus sign) is for special prices (e.g. for exotic derivatives)
-
-
-
Accrued Price
-
Numeric field.
-
A unit price or value of accrued interest or other earnings of a financial instrument.
-
Must be in accrued currency.
-
Multipliers will be applied automatically in accordance with an instrument of the transaction.
-
A sign of the number:
-
“
+
" (plus sign) is for standard prices -
“
-
" (minus sign) is for special prices (e.g. for exotic derivatives)
-
-
-
Factor
-
Numeric field.
-
A multiplicative factor applied to the nominal or face value of a security, such as bonds or other financial instruments to adjust its value for various purposes.
-
Must NOT be negative.
-
-
YTM
-
Numeric field.
-
Yield to maturity.
-
-
Modified Duration
-
Numeric field.
-
-
Yellow Fields for Advanced settings can be left Empty
FX Rates
-
Date
-
Date field.
-
A date of valuation.
-
Format should be: “YYYY-MM-DD” (e.g. “
2000-12-31
")
-
-
Currency ID
-
Text field. Case-sensitive.
-
A currency that is being purchased in a foreign exchange transaction.
-
Must be an alphabetic code of a currency alphabetic code (e.g.
USD
,EUR
,CHF
).
-
-
FX Rate
-
Numeric field.
-
An exchange rate used for a foreign exchange transaction.
-
Must be in USD (USD must be quoted currency).
-
Must NOT be negative.
-
-
Yellow Fields for Advanced settings can be left Empty
Other Entities
Currencies
-
Currency ID
-
Text field. Case-sensitive.
-
A currency that is being purchased in a foreign exchange transaction.
-
Must be an alphabetic code of a currency alphabetic code (e.g.
USD
,EUR
,CHF
).
-
-
Name
-
Text field. Case-sensitive.
-
A name of the entity.
-
-
Short Name
-
Text field. Case-sensitive.
-
A short name of the entity.
-
-
Public Name
-
Text field. Case-sensitive.
-
A public name of the entity. Will be shown instead of Name if user has no right to see this entity.
-
-
Notes
-
Text field.
-
Additional comments, instructions, or relevant information associated with a particular transaction.
-
If there are no notes enter “
-
" (dash).
-
-
Yellow Fields for Advanced settings can be left Empty
Accounts
-
Account ID
-
Text field. Case-sensitive.
-
A currency that is being purchased in a foreign exchange transaction.
-
Must be an alphabetic code of a currency alphabetic code (e.g.
USD
,EUR
,CHF
).
-
-
Name
-
Text field. Case-sensitive.
-
A name of the entity.
-
-
Short Name
-
Text field. Case-sensitive.
-
A short name of the entity.
-
-
Public Name
-
Text field. Case-sensitive.
-
A public name of the entity. Will be shown instead of Name if user has no right to see this entity.
-
-
Notes
-
Text field.
-
Additional comments, instructions, or relevant information associated with a particular transaction.
-
If there are no notes enter “
-
" (dash).
-
-
Yellow Fields for Advanced settings can be left Empty
Portfolios
-
Portfolio ID
-
Text field. Case-sensitive.
-
A currency that is being purchased in a foreign exchange transaction.
-
Must be an alphabetic code of a currency alphabetic code (e.g.
USD
,EUR
,CHF
).
-
-
Name
-
Text field. Case-sensitive.
-
A name of the entity.
-
-
Short Name
-
Text field. Case-sensitive.
-
A short name of the entity.
-
-
Public Name
-
Text field. Case-sensitive.
-
A public name of the entity. Will be shown instead of Name if user has no right to see this entity.
-
-
Notes
-
Text field.
-
Additional comments, instructions, or relevant information associated with a particular transaction.
-
If there are no notes enter “
-
" (dash).
-
-
Yellow Fields for Advanced settings can be left Empty
Counterparties
-
Counterparty ID
-
Text field. Case-sensitive.
-
A currency that is being purchased in a foreign exchange transaction.
-
Must be an alphabetic code of a currency alphabetic code (e.g.
USD
,EUR
,CHF
).
-
-
Name
-
Text field. Case-sensitive.
-
A name of the entity.
-
-
Short Name
-
Text field. Case-sensitive.
-
A short name of the entity.
-
-
Public Name
-
Text field. Case-sensitive.
-
A public name of the entity. Will be shown instead of Name if user has no right to see this entity.
-
-
Notes
-
Text field.
-
Additional comments, instructions, or relevant information associated with a particular transaction.
-
If there are no notes enter “
-
" (dash).
-
-
Yellow Fields for Advanced settings can be left Empty
Responsibles
-
Responsible ID
-
Text field. Case-sensitive.
-
A currency that is being purchased in a foreign exchange transaction.
-
Must be an alphabetic code of a currency alphabetic code (e.g.
USD
,EUR
,CHF
).
-
-
Name
-
Text field. Case-sensitive.
-
A name of the entity.
-
-
Short Name
-
Text field. Case-sensitive.
-
A short name of the entity.
-
-
Public Name
-
Text field. Case-sensitive.
-
A public name of the entity. Will be shown instead of Name if user has no right to see this entity.
-
-
Notes
-
Text field.
-
Additional comments, instructions, or relevant information associated with a particular transaction.
-
If there are no notes enter “
-
" (dash).
-
-
Yellow Fields for Advanced settings can be left Empty
Strategies
-
Strategy ID
-
Text field. Case-sensitive.
-
A currency that is being purchased in a foreign exchange transaction.
-
Must be an alphabetic code of a currency alphabetic code (e.g.
USD
,EUR
,CHF
).
-
-
Name
-
Text field. Case-sensitive.
-
A name of the entity.
-
-
Short Name
-
Text field. Case-sensitive.
-
A short name of the entity.
-
-
Public Name
-
Text field. Case-sensitive.
-
A public name of the entity. Will be shown instead of Name if user has no right to see this entity.
-
-
Notes
-
Text field.
-
Additional comments, instructions, or relevant information associated with a particular transaction.
-
If there are no notes enter “
-
" (dash).
-
-
Yellow Fields for Advanced settings can be left Empty
How to Check Balance Report
Prerequisites
We assume you have all the prerequisites you may need, including:
- If needed: the VPN is configured to access the Finmars resources
- If needed: access to the Virtual Machine to work with the sensitive information
- Must have: registered in Finmars in the needed region environment (self-registered or registered by Finmars)
- Must have: having permissions set to allow continue with the Action in the Guide
Checking Balance Report
- Go to the left sidebar. Locate and select the Report section and click on Balance. Ensure that the correct layout is selected from the dropdown in the upper-left corner. If the wrong layout is selected, change it before proceeding.
- Once on the Balance page, adjust the settings according to your reporting needs. Сonfirm the Calculation method, Pricing policy, and Currency in the top panel. Also, verify that the Report Date is set correctly. The system displays the balance as of the end of the selected day. This setting should always be used to reflect accurate financial data.
- If you want to configure more detailed report settings, click on the gear icon in the top-right corner to open the settings panel.
- In detailed report settings you can set the Report Date, Currency, and Cost Method (such as AVCO or FIFO) as well.
- Define the Pricing Policy to determine how asset values are calculated (When selecting the Pricing Policy, you are choosing the set of prices and exchange rates to be used.)
- Configure Portfolio Mode and Account Mode to define how data is displayed.
- Independent – Shows separate entries for each portfolio or account for a detailed view.
- Ignore – Aggregates data into a consolidated report without portfolio or account distinctions.
For Example: If Portfolio Mode is set to Ignore, all portfolios will be merged into a single row. However, if Account Mode is set to Independent, accounts will still be displayed as separate rows.
- After adjusting these settings, confirm by clicking OK.
- To apply the selected settings and view the updated report, simply refresh the page. Once refreshed, the report will be displayed with the updated parameters, reflecting the selected configurations.
- Once the report has been prepared, verify the displayed information to ensure that the Grand Total and individual portfolio data are correct. If mistakes are discovered, review the imported data to ensure that all relevant files were included through the import process. If changes are required, return to the Report Settings, alter the settings, and reload the page to update the report.
- After verifying the report, you can either save it within the system for future reference or export it for external use. To do this, locate the Save button, which is positioned in the upper-left corner of the report interface. Clicking this button will store the current report layout and data for future access. It’s important to use the standard settings whenever possible to maintain consistency. If changes are needed, create a duplicate of the layout (see How to Duplicate the Layout) and save it locally to avoid potential data loss during updates or reinstallation of marketplace modules.
- The Export option is located in the top-right corner, providing multiple formats for downloading the report. You can choose to Export to PDF, Export to CSV, or Export to Excel, depending on the preferred format for further analysis.
- Additionally, there are options to Copy all to buffer or Copy selected to buffer, allowing you to quickly copy report data for use in other applications. Ensure that the exported or copied data accurately reflects the report before using it for financial reporting or analysis.
- In case of any errors or missing data warnings, check that the required Import has been successfully completed. Ensure that all necessary financial and transactional data has been imported into the system before running the Balance Report. If issues persist, contact the administrator for further assistance.
How to Duplicate the Layout
Prerequisites
We assume you have all prerequisites you may need, including:
- If needed: the VPN is configured to access the Finmars resources
- If needed: access to the Virtual Machine to work with the sensitive information
- Must have: registered in Finmars in the needed region environment (self-registered or registered by Finmars)
- Must have: having permissions set to allow continue with the Action in the Guide
Duplicating the Layout
- Go to the layout list. Click on the layout name to open the dropdown menu. Choose the layout you want to duplicate (for example, Profit and Loss).
- In the dropdown menu, select "Make a Copy" to create a duplicate of the selected layout.
- To confirm that the copy was successfully created, check the selected layout name at the top. It should indicate that it is a copy (e.g., Profit and Loss_copy).
- After copying, you can Rename the new layout for clarity and organization. Click on the Rename option.
- A dialog box will appear where you can enter any desired name for the copied layout. Also, you can change configuration and user code.
- After choosing a new name, click Save to confirm the changes.
How To Check Transaction Report
Prerequisites
We assume you have all prerequisites you may need, including:
- If needed: the VPN is configured to access the Finmars resources
- If needed: access to the Virtual Machine to work with the sensitive information
- Must have: registered in Finmars in the needed region environment (self-registered or registered by Finmars)
- Must have: having permissions set to allow continue with the Action in the Guide
Checking Trasaction Report
- Go to the left sidebar. Locate and select the Report section and click on Transaction. Ensure that the correct layout is selected from the dropdown in the upper-left corner. If the wrong layout is selected, change it before proceeding.
- Once on the Transaction page, ensure the Report Date is set correctly. You can select predefined periods like YTD, MTD, QTD, or choose a custom date range for more precise reporting. The system displays data as of the end of the selected day. After choosing click Save.
- If you want to configure more detailed report settings, click on the gear icon in the top-right corner to open the settings panel.
- In the Report Settings, you can configure is:
- Report Date - defines the date range for the report. Users can select a specific date range or predefined periods (e.g., YTD, MTD). The system displays the transactions on the end of the selected day.
- Table Font Size - adjusts the text size within the report (Small, Medium, Large).
- Expression Iterations Count - defines how many times the system applies calculations for custom columns in the report. Set to "1" for most reports. Increase only if your report data has dependencies between diferent custom columns, and is not calculated with one iteration.
- Date Field - lets users choose which date type to apply in the report (e.g., Transaction Date, Accounting Date, Cash Date, etc.)
- Custom Fields - this option allows users to enable additional user-defined fields (with expression formulas) in the report for more detailed or specific reporting needs. Not recommended to use due its high resource consumption.
- Depth Level - defines the level of detail in the report, with options:
- Complex Transaction - shows the transaction as a whole, without breaking it down into internal actions or money movements. Best for a quick overview of operations.
- Base Transaction - shows the internal actions within the transaction (for example, different steps of execution), but without splitting it into cash or position movements.
- Entry - shows the most detailed view with all accounting records. Here the transaction is fully broken down into cash flows and position changes.
- Filters – Allows users to refine the displayed data by using multi-selectors for Portfolios, Accounts, and Strategies.
- After adjusting these settings, confirm by clicking OK.
- To apply the selected settings and view the updated report, simply refresh the page. Once refreshed, the report will be displayed with the updated parameters, reflecting the selected configurations.
- Once the report has been prepared, verify the displayed information to ensure that the Grand Total and individual portfolio data are correct. If mistakes are discovered, review the imported data to ensure that all relevant files were included through the import process. If changes are required, return to the Report Settings, alter the settings, and reload the page to update the report.
- After verifying the report, you can either save it within the system for future reference or export it for external use. To do this, locate the Save button, which is positioned in the upper-left corner of the report interface. Clicking this button will store the current report layout and data for future access. It’s important to use the standard settings whenever possible to maintain consistency. If changes are needed, create a duplicate of the layout (see How to Duplicate the Layout) and save it locally to avoid potential data loss during updates or reinstallation of marketplace modules.
- The Export option is located in the top-right corner, providing multiple formats for downloading the report. You can choose to Export to PDF, Export to CSV, or Export to Excel, depending on the preferred format for further analysis.
- Additionally, there are options to Copy all to buffer or Copy selected to buffer, allowing you to quickly copy report data for use in other applications. Ensure that the exported or copied data accurately reflects the report before using it for financial reporting or analysis.
- In case of any errors or missing data warnings, check that the required Import has been successfully completed. Ensure that all necessary financial and transactional data has been imported into the system before running the Transaction Report. If issues persist, contact the administrator for further assistance.