Asset cashflow and IRR

Retrieving asset cashflow and IRR output breakdown by deals

API Reference: /api/cashflow/deal/bydeal/{scopeId}/{assetId}/{asOfDate}

This API provides a investment cash flow of the specific asset break down by deals.

Request


HTTP Method	GET
Path	/api/cashflow/deal/bydeal/{scopeId}/{assetId}/{asOfDate}
Request parameters	Scope ID (string): An ID of the selected scope which can be acquired by the [Scope list API] assetId: unique ID of asset asOfDate: "YYYY-MM'DD" format
API Reference	/api/cashflow/deal/bydeal/{scopeId}/{assetId}/{asOfDate}

Response

The returned result is an array of deals cash flow. Each item in an array contains the information of the deal IRR, FMV, and the list of all the historical cash flow.

Description

The table below shows the description of each field name inside a single deal cash flow response data.

Field name	Description
dealId	Deal ID
dealName	Name of the deal
investmentFmv	Fair market value of deal
grossIrr	Internal rate of return using investments-related cash flows and FMV before carried interest deduction as of selected date. If the value of Gross IRR cannot be determined based on the given cash flow, the value inside the field "isGrossIrrNotAvailable" will be true
netIrr	Internal rate of return using all investments and fund operation-related cash flows and FMV before carried interest deduction as of the selected date If the value of Net IRR cannot be determined based on the given cash flow, the value inside the field "isNetIrrNotAvailable" will be true
recentTransactionList	An array containing all cash flows that are used for calculating the IRR. Each item in an array contains the cash flow date, the transaction type, and the amount.

Example output

[   
  {
     // one object per one deal
      "recentTransactionList": [
        {
          "irrDate": "2021-02-15",
          "transactionId": 64,
          "transactionDate": "2021-02-15T00:00:00",
          "transactionType": "EQ - Investment cost adjustment",
          "isNewDealType": false,
          "totalAmount": -20000,
          "allocationMethod": "Deal specific investment cost",
          "percentAllocation": 1,
          "amount": 20000,
          "isDealRelated": true,
          "dealId": 13,
          "reference": "",
          "isFundInvestment": false,
          "isFundOpTransaction": false
        },
        {
          // cash flow from other transactions
        }
      ],
      "dealId": 13,
      "dealName": "0042 - Company 1",
      "investmentFmv": 980000,
      "grossIrr": 0.005321856180983,
      "netIrr": 0.005321856180983,
      "isGrossIrrNotAvailable": false,
      "isNetIrrNotAvailable": false,
      "asOfDate": "2021-12-31",
      "lastestValuationDate": "2021-02-15"
    },
    {
      // Other deals object
      "recentTransactionList": [..]
      "dealId": 17,
      "dealName": "0102 - Company 1",
      "investmentFmv": 5000000,
      "grossIrr": 0,
      "netIrr": 0,
      "isGrossIrrNotAvailable": false,
      "isNetIrrNotAvailable": false,
      "asOfDate": "2021-12-31",
      "lastestValuationDate": "2021-01-01"
    }  
]

Retrieving asset cashflow and IRR output (Combined View)

API Reference : Deal cashflow

Response

If the asset has multiple investments (aka deals), the deal cash flow response will be in an array of multiple deal cash flow objects.

Each asset cash flow object consists of 2 sections

Total cashflow tab: the data for this tab is in dealIrr object, within dealIrr object, there is a nested object called recentTransactionList which contains all the cashflow information related to this investment in the amount field in this object is the total amount done by each transaction. Other properties value description can be found in InvestorCashflow
By investors cashflow tab: the data for this tab is in dealByDealIrrList object, within this object, the cash flow is broken down by investors' allocations. In other word, if there are 10 GP/LPs participated in this deal, there will be 10 items in the dealByDealIrrList array. The information inside the object in this array is the same as InvestorCashflow

	Value
HTTP Method	GET
Path	/api/cashflow/deal/{scopeId}/{assetId}/{asOfDate}
Request parameters	Scope ID (string): An ID of the selected scope which can be acquired by the [Scope list API] assetId: unique ID of asset asOfDate: "YYYY-MM'DD" format
Reference	API Reference : Deal cashflow

Example

Field name	Description
fundVehicleName	Name of the fund vehicle
investorName	Name of the investor entity
dealId	Deal ID
dealName	Name of the deal
grossIrr	Internal rate of return using investments-related cash flows and FMV before carried interest deduction as of selected date
netIrr	Internal rate of return using all investments and fund operation-related cash flows and FMV before carried interest deduction as of selected date
t(x)	Different waterfall tier amount(s) calculated as per fund waterfall policy configuration
asOfDate	The date for calculation of the IRR in the format of "YYYY-MM-DD"
investmentFmv	Fair market value of deal

Example output

[
  {
    "dealIrr": {
      "recentTransactionList": [
        {
          "investorId": 0,
          "investorTypeId": 0,
          "investingEntityType": null,
          "irrDate": "2020-01-01",
          "transactionId": 14,
          "transactionDate": "2020-01-01T00:00:00",
          "transactionType": "EQ - Purchase",
          "instrument": null,
          "isNewDealType": true,
          "totalAmount": 1000000,
          "allocationMethod": "Capital Commitment",
          "percentAllocation": 1,
          "amount": -1000000,
          "isDealRelated": true,
          "isOtherAL": false,
          "dealId": 3,
          "ownershipId": 0,
          "reference": "",
          "isExcluded": false,
          "isVirtualCashFlow": false
        }
      ],
      "dealId": 3,
      "dealName": "0028 - AA",
      "investmentFmv": 1000000,
      "grossIrr": 0,
      "netIrr": 0,
      "isGrossIrrNotAvailable": false,
      "isNetIrrNotAvailable": false,
      "asOfDate": "2020-09-30",
      "lastestValuationDate": "2020-01-01"
    },
    "dealByDealIrrList": [
      {
        "assetId": 3,
        "assetName": "AA",
        "isTotalAsset": false,
        "dealId": 3,
        "dealName": "0028 - AA",
        "latestValuationDate": "2020-01-01",
        "ownerEntities": null,
        "recentTransactionList": [
          {
            "investorId": 0,
            "investorTypeId": 0,
            "investingEntityType": null,
            "irrDate": "2020-01-01",
            "transactionId": 14,
            "transactionDate": "2020-01-01T00:00:00",
            "transactionType": "EQ - Purchase",
            "instrument": null,
            "isNewDealType": true,
            "totalAmount": 1000000,
            "allocationMethod": "Capital Commitment",
            "percentAllocation": 1,
            "amount": -1000000,
            "isDealRelated": true,
            "isOtherAL": false,
            "dealId": 3,
            "ownershipId": 0,
            "reference": "",
            "isExcluded": false,
            "isVirtualCashFlow": false
          }
        ],
        "fundVehicleId": 1,
        "fundVehicleName": "Main Fund",
        "investorId": 0,
        "investorName": "Total amount",
        "investingEntityType": null,
        "navBeforeManualJournalAdjustment": 0,
        "manualJournalAdjustment": 0,
        "investmentFmvOrNav": 1000000,
        "navBalanceSheet": 0,
        "navByDueDateWithPrepaid": 0,
        "investmentCost": 0,
        "grossIrr": -2.31930847576e-17,
        "netIrr": -2.31930847576e-17,
        "hurdleRateFmvOrNav": 0,
        "t1InvestorDistributionAmount": 0,
        "t2InvestorDistributionAmount": 0,
        "t3GpCatchupDistributionAmount": 0,
        "t4InvestorDistributionAmount": 0,
        "t4GPDistributionAmount": 0,
        "t5GpPreCatchup": 0,
        "t5LpPreCatchup": 0,
        "t5InvestorDistributionAmount": 0,
        "t5GPDistributionAmount": 0,
        "t5GpPostCatchup": 0,
        "t6GpPreCatchup": 0,
        "t6LpPreCatchup": 0,
        "t6InvestorDistributionAmount": 0,
        "t6GPDistributionAmount": 0,
        "discountRate": 0,
        "carryAccruedToGp": 0,
        "netIrrIncludeCarry": 0,
        "commitmentAmount": 0,
        "isFundLevel": false,
        "isTotal": true,
        "isGp": false,
        "isLpTotal": false,
        "isGpTotal": false,
        "waterfallAdvanceLayer": null,
        "isActual": false,
        "isGrossIrrNotAvailable": false,
        "isNetIrrNotAvailable": false,
        "isNetIrrIncludeCarryNotAvailable": false,
        "isUseWaterfallAdvance": false,
        "isDealByDealBasis": false,
        "paidInCapital": 0,
        "asOfDate": "2020-09-30"
      },
      // skip some investor allocation for simplicity
    ],
    "dealCurrencyCode": "CNY",
  },
  
  // skip cash flow of other deals of this asset for simplicitiy    
]