Validation will fail if any of the properties marked with 
are missing. Additionally, incorrectly formatted input values can lead to validation failures, e.g. providing a blank value for a decimal property.
A default value will be provided for those properties marked with 
.
Please note; For rules that require netting, we will automatically do so, thus you should not net positions provided in the positions file. For more information on this please see here
For information on integrating via API, please see our technical documentation. For all other information please see our Zendesk HelpCentre
An asset is the specific position a portfolio has in an instrument. Instrument properties are independent of portfolio, whereas asset properties are specific to the portfolio
| Property Name | Applies To | Description | Data type | Valid values & notes | |||
|---|---|---|---|---|---|---|---|
| AssetId | |
All | Unique identifier for the asset | String(255) | e.g. Use InstrumentId + AssetClass to signify the unique asset, or another significant unique combination such as ISIN + LocalTicker or ISIN + Execution Venue (these are also provided by the exchange-level FIGI or quote-level PermID). 1. Must be unique for every asset in the portfolio (but may be duplicated across portfolios) or else validation will fail and 2. Consistent across NAV dates or else HasActivity will not work and the UI will mark all assets as new |
||
| AssetName | |
All | Name of the asset | String(255) | Used as the primary display name for the asset, so ensure this name is meaningful | ||
| MarketValue | All | Market value of a position in portfolio currency | Decimal | If the market value can't be provided in portfolio currency, it should be provided in instrument currency (property MarketValueInInstrumentCurrency). For derivatives, this should represent the fair market value and should be provided with accrued interest. For non-derivative assets, market value should be provided without accrued interest. For bonds, the regulation does not specify the method but we suggest using the face value multiplied by the bond's dirty price to calculate the market value. | |||
| MarketValueInInstrumentCurrency | All | Market value of a position in instrument currency | Decimal | Should only be provided if the market value can't be provided in portfolio currency (property MarketValue). For derivatives, this should represent the fair market value and should be provided with accrued interest. For non-derivative assets, market value should be provided without accrued interest. For bonds, the regulation does not specify the method but we suggest using the face value multiplied by the bond's dirty price to calculate the market value. | |||
| Quantity | |
All | Equities - Number of shares held Bonds (including Convertibles) - Total nominal value of the position, divided by the FaceValue of the (single) bond instrument. ETF - Number of units held Derivatives - Number of contracts held |
Decimal | Short sale positions - Insert a negative quantity for positions resulting from short sale transactions. Lending/Borrowing/Collateral (SFTType) - For any asset which does NOT have an SFTType set to 'Normal', insert only positive quantities. CDS - For credit default swaps, use a negative quantity for protection buys (which is an effective short position) and a positive quantity for protection sells (which is an effective long position). |
||
| SFTType | All | Type of securities financing transaction (SFT) | String(255) | Valid values: Borrowed, CollateralGiven, CollateralTaken, Lent, Normal. This property accounts for various kinds of transactions such as lending, borrowing, repos, reverse repos, while also allowing for general collateral taken and collateral given. See here for more details on populating |
An instrument is the portfolio independent information
| Property Name | Applies To | Description | Data type | Valid values & notes | |||
|---|---|---|---|---|---|---|---|
| AssetClass | |
All | Asset class (e.g. Equity, Bond, CFD etc.) | String(255) | Valid values: ADR, Bond, CDS, CFD, Convertible, Equity, Future, Index, Option, PreferredEquity, Rights, StructuredProduct, Swap, Unit, Warrant. To ignore this asset during checking, set to 'Ignore' |
||
| CallOrPut | |
Option, Warrant | If an option / warrant is call or put | String(255) | Valid values: Call, Put. | ||
| CountryOfIncorporation | Equity, PreferredEquity, Unit | [Issuer Property] Equity and Preferred Equity - Country where the issuer is incorporated. ETFs - Country where the collective investment scheme's (or other company structure's) legal personality is incorporated |
String(255) | Valid values: ISO 3166-1 Alpha 2 country codes. | |||
| InstrumentCurrency |
ADR, Bond, CDS, CFD, Convertible, Equity, Future, Index , Option, PreferredEquity, Rights, StructuredProduct , Swap, Unit, Warrant |
Currency the instrument is denominated in. | String(255) | Valid values: ISO 4217 currency codes. | |||
| InstrumentId | |
All | Identifier to link assets to instruments and instruments to Underlying instruments | String(255) | Must be unique for every instrument in one upload | ||
| InstrumentName | |
All | Instrument name | String(255) | Used as the primary display name for the instrument, so ensure this name is meaningful | ||
| IsExemptApexIssuerIN | Equity, PreferredEquity | [Issuer Property] Whether the issuer is exempt from the 50% threshold by satisfying Section 2(i) and 2(iii) of the SEBI Circular SEBI/HO/AFD/AFD-POD-2/P/CIR/2024/19 dated March 20, 2024. If this field is set to true, then the issuer will be excluded, otherwise the issuer will be included. | Boolean | ||||
| ISIN | ADR, Bond, CDS, CFD, Convertible, Equity, Future, Option, PreferredEquity, Rights, Swap, Unit, Warrant | ISIN of the instrument | String(255) | Used to look-up Instrument in many lists such as EU Short Selling Exempt, short selling black & white lists, Takeover lists etc. Please note that ISIN is not required for instruments with the following asset classes unless they happen to be listed on a South African exchange: Swap, Option, Future, and CFD. ISIN is only required for Rights for Short US 13f-2 and Takeover GB & IE. | |||
| IssuerGroupNameIN | |
Equity, PreferredEquity | [Issuer Property] Name of the Indian corporate group, using Regulatory Data scraped from the National Stock Exchange of India (NSE)'s website. | String(255) | The National Stock Exchange of India (NSE) is obligated to provide this information with respect to the Indian FPI rules outlined in SEBI circular no. SEBI/ HO/ AFD/ AFD -PoD -2/ CIR/ P/ 2023/148 dated August 24, 2023. | ||
| MarketsListedIn | ADR, Bond, CDS, CFD, Convertible, Equity, Future, Option, PreferredEquity, Rights, Swap, Unit, Warrant | List of all market identification codes (MICs) where the instrument is listed - should be a list of all markets that the instrument is listed on, and should include the primary market. | List | ISO 10383 code (MIC). Insert the MICs of all markets that the instrument is listed on (should include the primary market). Where a specific market segment is different than the Operating MIC, please use the specific market segment since the Operating MIC is the parent market venue only. For instruments which are truly over-the-counter (OTC), use the value recommended by the ISO standard: XXXX For instruments where the market is completely unknown, use the value: XMIC (which is not an ISO code but a suggested default value in such cases). It is critical that for any market, segment MICs are provided. Please see ISO's official FAQs for the MIC standard under the section 'MIC LEVELS', making note of the definitions for 'market segment MIC' and 'operating MIC' including the point that 'The use of market segment MICs provides more accuracy.' FundApps is unable to validate whether our clients are providing the MICs at the granularity of segment MIC; we strongly recommend that you re-confirm with your data provider(s) that MICs are provided at segment MICs level. |
|||
| Price | All | Price of the instrument in instrument currency. For bonds and convertibles, the price must be stated as a percentage of the face value of an individual bond (since this is the way bonds are quoted on the market). | Decimal |
AssetClass, AssetId, AssetName, InstrumentCurrency, InstrumentId, InstrumentName, MarketValue, MarketValueInInstrumentCurrency, Price, Quantity, SFTType
Asset classes which require exactly one underlying asset to pass validation are marked with 
Asset classes which can have multiple underlying assets are marked with 
| Asset Class | Description | Valid Underlyings | Properties |
|---|---|---|---|
|
ADR
|
Depositary Receipts. Certificates that represent an ownership interest in shares of a (usually foreign-listed) company. Only NVDRs, which are identified by the DRType 'NVDR', are permitted to have 'Convertible', 'Warrant', or 'Rights' as their underlying assets. This specification is exclusive to NVDRs due to their unique structure. | Convertible, Equity, PreferredEquity, Rights, Warrant | ISIN, MarketsListedIn |
| Bond | A fixed income instrument where the issuer owes the holder a debt and pays them interest on it | ISIN, MarketsListedIn | |
|
CDS
|
Credit Default Swap. A financial derivative contract that allows an investor to swap the credit risk of an issuer, country or another entity with another counterparty | Bond, Index, StructuredProduct | ISIN, MarketsListedIn |
|
CFD
|
Contract For Difference | ADR, Bond, Convertible, Equity, Index, PreferredEquity, Rights, StructuredProduct, Unit, Warrant | ISIN, MarketsListedIn |
|
Convertible
|
A type of bond which can be converted to a specific number of equity shares of the issuing company (or another company in the case of an exchangeable bond) | ADR, Equity | ISIN, MarketsListedIn |
| Equity | Also called: Common Stock. A stock or other security representing an ownership interest in a company | CountryOfIncorporation, IsExemptApexIssuerIN, ISIN, IssuerGroupNameIN, MarketsListedIn | |
|
Future
|
A contract or agreement to buy or sell an asset at a certain date at a certain price | ADR, Bond, Convertible, Equity, Index, PreferredEquity, Rights, StructuredProduct, Unit, Warrant | ISIN, MarketsListedIn |
|
Index
|
A collection or basket of securities which usually track the basket's performance and serve as reference values for a financial derivative | ADR, Bond, CDS, Convertible, Equity, PreferredEquity, Rights, Warrant | |
|
Option
|
Financial derivatives that give the buyer the right to buy or sell the underlying asset at a stated price within a specified period. | ADR, Bond, Convertible, Equity, Future, Index, PreferredEquity, Rights, StructuredProduct, Swap, Unit, Warrant | CallOrPut, ISIN, MarketsListedIn |
| PreferredEquity | Also called: Preference Shares or Preferred Shares. A type of stock in which holders have a higher claim to the dividends or assets of a company and which may contain features of debt instruments, including convertibility into common stock | Equity | CountryOfIncorporation, IsExemptApexIssuerIN, ISIN, IssuerGroupNameIN, MarketsListedIn |
|
Rights
|
Subscription Rights. A certificate issued to existing shareholders giving them the right to purchase a certain number of shares from the issuer at a specific price | Equity | ISIN, MarketsListedIn |
|
StructuredProduct
|
A customised collection or basket of securities which may be pre-packaged as an investment, usually track the basket's performance and may serve as reference values for a financial derivative | ADR, Bond, CDS, Convertible, Equity, Future, Index, Option, PreferredEquity, Rights, StructuredProduct, Unit | |
|
Swap
|
A derivative contract in which two parties exchange the cash flows or liabilities of two different financial instruments. Excludes Credit Default Swaps | ADR, Bond, Convertible, Equity, Index, PreferredEquity, Rights, StructuredProduct, Unit, Warrant | ISIN, MarketsListedIn |
|
Unit
|
A collective investment scheme or fund (set of pooled investments) which issues units or shares giving rights to the scheme's assets and associated income | ADR, Bond, CDS, Convertible, Equity, Future, Option, PreferredEquity, Rights, StructuredProduct | CountryOfIncorporation, ISIN, MarketsListedIn |
|
Warrant
|
A certificate providing a right, but not an obligation to buy or sell a certain number of shares of a company at a specific price in the future; or a financial derivative that gives the buyer the right to receive payment, or the seller the obligation to deliver payment based on a reference composite's value at a particular time or within a period of time specified. | ADR, Equity, Index, StructuredProduct, Unit | CallOrPut, ISIN, MarketsListedIn |
A portfolio is the smallest unit that can hold assets (aka an account, fund etc.), an entity is a grouping of portfolios. The properties are generally set-up once and then only updated when changes occur. Portfolio properties can be entered directly into the UI and do not need to be provided in an input file.
The following are required for the rules / system to function correctly
| Property Name | Applies To | Description | Data type | Valid values & notes | |
|---|---|---|---|---|---|
| PortfolioId | |
Both | Unique identifier for the portfolio / entity | String(255) | This Id should NOT change over time (even during implementation). If it does a new portfolio / entity will be created. |
| PortfolioName | |
Portfolio | Name of the portfolio / entity | String(255) | |
| PortfolioCurrency | |
Top Entity | Base currency of the portfolio / currency entity should use for calculations | String(255) | Valid values: ISO 4217 currency codes. |
| PortfolioType | |
Both | Portfolio: a container that holds assets (Accounts, Funds, Portfolios etc.); Entity: an aggregation of portfolios (Management Company, Controlling Entity, etc.) Umbrella: If a portfolio's direct parent is an umbrella and a portfolio level disclosure is required, A disclosure will be triggered on the parent umbrella, aggregating all portfolios underneath that specific umbrella |
String(255) | Valid values: Entity, Portfolio, Umbrella. Click here for more information on umbrellas |
| PortfolioCompany | |
Both | If a Chinese wall, or similar, exists, you will be able to limit the visibility to specific areas of the business. | String(255) | More information is available here |
| DefaultParentId | Both | Identifier (PortfolioId) of the Entity that a portfolio or (sub)Entity aggregates to | String(255) | Must match a PortfolioId of an Entity in the file. This is used to define the aggregation structure. In this case, an aggregation structure named 'Default' is used. For Entities which are at the top of the tree, the DefaultParentId will be its own PortfolioId. For clients with multiple aggregation structures, additional columns named 'XParentId' can be added, where X is the name of the tree (e.g. Voting, Legal, Management). More information here | |
| RuleFolders | Portfolio | Defines which rules run on the system. | List | Valid values all folders active in your system see bottom left panel in the rules page | |
| LiquidationDate | Both | When the portfolio / entity was / will be liquidated | Date | ||
| ForeignPortfolioInvestorGroupIN | Portfolio | Name of the registered Indian Foreign Portfolio Investor (FPI) Group for the portfolio. If more than one portfolio is related to the same FPI Group, make sure to apply the same value/name across all portfolios linked to that FPI Group. The definition of an FPI Group is found in the Securities and Exchange Board of India (Foreign Portfolio Investors) Regulations, 2019 Section 22(3. |
String(255) | This property is only used for India SEBI FPI rules | |
| ForeignPortfolioInvestorIN | Portfolio | Name of the registered Indian Foreign Portfolio Investor (FPI) for the portfolio. If more than one portfolio is associated with a given FPI, make sure to apply the same value/name across all portfolios linked to that FPI. Any portfolio without a value for this property, will not be considered an FPI in any rule. |
String(255) | This property is only used for India SEBI FPI rules |
Last generated: 2024-11-18 10:02:35 UTC