GuidesRecipesAPI Reference
Log In
Guides

Investment transactions with allocations

Description

This endpoint returns multiple investment transactions and valuations that match the request body. The response also contains ‘allocations’ and, additionally, ‘dynamicAllocations’. The dynamicAllocations property is an array containing objects for each allocation cycle of every transaction. If a transaction does not have its allocation type set to dynamic, it will not be included in the response. Users can use the ‘viewBy’ property to filter the returned transactions, which can be set to either ‘Investment’, ‘Valuation’, or an empty string to include both types.

HTTP MethodPOST
Path/api/search/investment/withallocations
ReferenceLink

Request body

Property nameTypeRequired
fromDateString with format YYYY-mm-ddNo
toDateString with format YYYY-mm-ddNo
fundVehicleIdsArray of numbersYes
viewByString null | “Investment” | “Valuation”No
spvIdsArray of numbersNo
assetIdsArray of numbersYes

Response body examples

viewBy: “Investment”:

[
   {
      "transactionId":2985,
      "transactionType":"Investment",
      "entity":"Anaheim Electronics",
      "dealName":"2479 - Nu Gundam",
      "assetName":"Nu Gundam",
      "investor":null,
      "expenseSubSubTypeItem":null,
      "assetSubSubTypeItem":null,
      "subTypes":[
         {
            "subTypeId":0,
            "subType":"EQ - Common shares"
         }
      ],
      "typeId":0,
      "type":null,
      "viewBy":"investment",
      "dueDate":null,
      "noticeDate":null,
      "transactionDate":"2024-01-01",
      "paymentDate":"2024-01-01",
      "reference":"",
      "amount":0.0,
      "currencyCode":"JPY",
      "status":"Complete",
      "investmentCost":30000.0,
      "returnOfInvestmentCost":0.0,
      "realizedGainLoss":0.0,
      "unrealizedGainLoss":0.0,
      "investeeFundName":null,
      "allocationRule":"Dynamic capital commitment",
      "allocations":[
         {
            "investor":"Amuro Ray",
            "percentAllocation":0.5,
            "subTypeId":0,
            "subType":null,
            "typeId":0,
            "type":null,
            "dueDate":null,
            "noticeDate":null,
            "transactionDate":"2024-01-01",
            "paymentDate":"2024-01-01",
            "reference":"",
            "amount":0.0,
            "currencyCode":"JPY",
            "investmentCost":15000.0,
            "returnOfInvestmentCost":0.0,
            "realizedGainLoss":0.0,
            "unrealizedGainLoss":0.0
         }
      ],
      "dynamicAllocations":[
         {
            "cycle":"2014-01-01 onwards",
            "from":"2014-01-01",
            "to":"9999-12-31",
            "allocations":[
               {
                  "investor":"Jom LP2",
                  "percentAllocation":0.00116924876109105,
                  "subTypeId":0,
                  "subType":null,
                  "typeId":0,
                  "type":null,
                  "dueDate":null,
                  "noticeDate":null,
                  "transactionDate":"2024-01-01",
                  "paymentDate":"2024-01-01",
                  "reference":"",
                  "amount":0.0,
                  "currencyCode":"JPY",
                  "investmentCost":30000.0,
                  "returnOfInvestmentCost":0.0,
                  "realizedGainLoss":0.0,
                  "unrealizedGainLoss":0.0
               }
            ]
         }
      ]
   }
]

viewBy: “Valuation”:

[
   {
      "transactionId":319,
      "transactionType":"Valuation",
      "entity":"Anaheim Electronics",
      "dealName":"2479 - Nu Gundam",
      "assetName":"Nu Gundam",
      "investor":null,
      "expenseSubSubTypeItem":null,
      "assetSubSubTypeItem":null,
      "subTypes":[
         {
            "subTypeId":0,
            "subType":"Valuation"
         }
      ],
      "typeId":0,
      "type":null,
      "viewBy":"Valuation",
      "dueDate":null,
      "noticeDate":null,
      "transactionDate":"2024-09-01",
      "paymentDate":null,
      "reference":"",
      "amount":0.0,
      "currencyCode":"JPY",
      "status":null,
      "investmentCost":0.0,
      "returnOfInvestmentCost":0.0,
      "realizedGainLoss":0.0,
      "unrealizedGainLoss":5000.000000,
      "investeeFundName":null,
      "allocationRule":"Dynamic capital commitment",
      "allocations":[
         {
            "investor":"Jom LP5",
            "percentAllocation":0.169541069773578,
            "subTypeId":0,
            "subType":null,
            "typeId":0,
            "type":null,
            "dueDate":null,
            "noticeDate":null,
            "transactionDate":"2024-09-01",
            "paymentDate":null,
            "reference":"",
            "amount":0.0,
            "currencyCode":"JPY",
            "investmentCost":0.0,
            "returnOfInvestmentCost":0.0,
            "realizedGainLoss":0.0,
            "unrealizedGainLoss":847.705348867891
         }
      ],
      "dynamicAllocations":[
         {
            "cycle":"2014-01-01 onwards",
            "from":"2014-01-01",
            "to":"9999-12-31",
            "allocations":[
               {
                  "investor":"Jom LP5",
                  "percentAllocation":0.169541069773578,
                  "subTypeId":0,
                  "subType":null,
                  "typeId":0,
                  "type":null,
                  "dueDate":null,
                  "noticeDate":null,
                  "transactionDate":"2024-09-01",
                  "paymentDate":null,
                  "reference":"",
                  "amount":0.0,
                  "currencyCode":"JPY",
                  "investmentCost":0.0,
                  "returnOfInvestmentCost":0.0,
                  "realizedGainLoss":0.0,
                  "unrealizedGainLoss":847.705348867891
               }
            ]
         }
      ]
   }
]