Portfolio summary

API Reference : /api/summary/portfolio/{scopeId}/{fundVehicleId}/{asOfDate}
[Get portfolio summary] (https://quantiumfund.readme.io/reference#portfoliosummary)

Definition

Portfolio summary consists of standard fieldsets of output calculation from Quantium CORE.

Output is fund vehicle specific as of a selected date.

The following is a list of standard fieldsets returned from Quantium API.

Output	Description
fullyRealizedDeals	Deal(s) with current investment cost as zero
partialyRealizedDeals	Deal(s) with current investment cost less than total investment cost and greater than zero
unrealizedDeals	Deal(s) with current investment cost equal to total investment cost
initialInvestmentDate	Initial date that records a new deal transaction of an asset
investingEntity	Entity (i.e. fund vehicle or SPV) that makes the deal investment
industry	Industry that the asset operates in
sector	Sector that the asset operates in
commitmentReserve	Amount(s) that an entity commits to invest in an asset with a deal transaction status as "committed"
currentOwnershipPercent	Current ownership percentage of a deal by an investing entity
initialInvestmentCost	Total investment cost(s) of a deal
remainingInvestmentCost	Current investment cost(s) of a deal
dealExpense	Investment related expense(s) of a deal
dealIncome	Investment related income(s) (excluding dividends, interest) of a deal
proceeds	Total investment return (i.e. realized gain / (loss) + investment cost) of a deal
fmv	Fair market value of a deal
totalValue	Total value = proceeds + FMV of a deal
realizedGainLoss	Sum of all realized gain/loss from EQ-Sale, LN-Sale, EQ-Dividend income and LN-Cash interest income of a deal
unrealizedGainLoss	Sum of all unrealized gain/loss of a deal
multipleOfCost	Total value / total investment cost of a deal
grossIrr	Internal rate of return using all investment related cash flows and remaining fair market value of a deal as of selected date
committedDeals	Deal(s) that an entity commits to invest with a deal transaction status as "committed"
writeOffDeals	Deal(s) whose current investment cost is greater than zero but fair market value is equal to zero

Generating portfolio summary output


HTTP Method	GET
Path	/api/summary/portfolio/{scopeId}/{fundVehicleId}/{asOfDate}
Request parameters	Scope ID (string): An ID of the selected scope which can be acquired by the [Scope list API] fundVehicleId (integer): unique ID of fund vehicle asOfDate: "YYYY-MM'DD" format
Reference	API Reference : /api/summary/portfolio/{scopeId}/{fundVehicleId}/{asOfDate}

Example

{
  "fullyRealizedDeals": [
    // list of fully realized deal object
  ],
  "partialyRealizedDeals": [
     // list of partially realized deal object
  ],
  "unrealizedDeals": [
    {
      "assetId": 3,
      "dealId": 5,
      "dealName": "0030 - Asset I",
      "dealSerialNumber": 30,
      "initialInvestmentDate": "02-2018",
      "investingEntity": "Fund I - USD",
      "industry": "Chemicals",
      "industryId": 3,
      "sector": null,
      "commitmentReserve": 0,
      "currentOwnershipPercent": 0.2,
      "initialInvestmentCost": 2000000,
      "remainingInvestmentCost": 2000000,
      "dealExpense": 0,
      "dealIncome": 0,
      "proceeds": 0,
      "realized": 0,
      "fmv": 2000000,
      "totalValue": 0,
      "realizedGainLoss": 0,
      "unrealizedGainLoss": 0,
      "multipleOfCost": 1,
      "grossIrr": 0,
         }
  ],
  "committedDeals": [
     // list of committed deal object
  ],
  "writeOffDeals": [
       // list of write off deal object
  ],
}