Why should I use Reporting APIs?
Reporting API platform is a unified API platform which provides a single interface to access different reports from different RTAs. The platform manages all the report specific and RTA specific idiosyncrasies under the hood so that the API consumers can focus on what matters the most : Reports and data points.
What kinds of reports can I get?
|Transactions||A list of transactions per folio per scheme(isin). Most of the data points including holdings related data points can be generated from a list of the trasactions. Some of them are the part of transaction response while some other data points can be generated easily from the transaction data.|
|Holdings report||Get details about current holdings of a folio|
What kinds of transactions are supported?
At present, the reporting engine supports the following types of transactions.
|Transaction type||Description||Effect on Units||Capital gains?|
||All "purchase" type transactions like fresh purchase, additional purchase, systematic investments etc.||Increase||No|
||All "sell" type transactions like partial redemption, full redemption, systematic withdrawal etc.||Decrease||Yes*|
||Switch in to the destination scheme.||Increase||No|
||Switch out from the scheme||Decrease||Yes*|
||Dividend payout received by the investor||No change||No|
||Dividend earned has been reinvested in the scheme.||Increase||No|
||Bonus units have been awarded to the investor.||Increase||No|
* Capital gains will not be calculated for transactions resulting from corporate actions.
What are the data points that the reporting APIs provide?
The table below explains the different data points which can be generated from the transaction list obtained via transactions . To view the detailed explanation on how to calculate the values of these data points from transactions, please see the Usage section.
|Scheme holdings units||Number of units being held by the customer as of now.|
|Scheme holdings redeemable units||Number of units available for redemption. For example, ELSS funds have a lock in of 3 years. Hence, the units which have not completed 3 Years are not available for redemption.|
|Market value of current investment||The market value of the units held(includes both redeemable and non-redeemable units) by the investor as per the last available NAV|
|Market value redeemable amount||The market value of the redeemable units as per last available NAV|
|Invested value amount||Total value of amount invested by the investor in a particular scheme.|
|Payout amount||Total dividend payout received by the investor.|
|Average NAV||Total cost per unit|
|Unrealized gains||Potential gain/loss amount from the investment|
|Redemption date||Date on which units were redeemed.|
|Redemption units||Number of units redeemed.|
|Purchase date||Date on which the redeemed units were bought.|
|Cost||Total cost value of the units.|
|Average cost||Average price at which units were bought.|
|Realized gains||Total Gains/Loss due to selling of holdings.|
|Sale price||Price at which units were redeemed|
What are the different cases supported by the reporting engine?
The reporting engine incorporates rules for handling the below cases -
- Scheme mergers: The impact of mutual fund scheme categorizations has been built into reports like holdings and capital gains.
- Folio consolidation: If the user decides to merge transactions of all folios into a single folio for a particular scheme.
- Transfer in/Transfer out: If the user changes his/her broker.
- Migration of exsiting folios: Upload of investor data and transaction data; reconcilliation and then generation of data points to ensure updated data is available.