GuidesRecipesAPI Reference
Log In
Guides

Fund operation transactions with allocations

Description

This endpoint returns multiple transaction matching request body. Its response also contained ‘allocations’ and additionally, ‘dynamicAllocations’. The dynamicAllocations property is an array containing object of every allocation’s cycle for each transaction. If a transaction is not set allocation type to a dynamic allocation, such transaction will not be added to response.

Value
HTTP MethodPOST
Path/api/search/fundoperation/withallocations
ReferenceLink

Request body values

Property nameTypeRequired
fromDateString with format YYYY-mm-ddNo
toDateString with format YYYY-mm-ddNo
fundVehicleIdsArray of numbersYes
subTypesArray of numbersNo
spvIdsArray of numbersNo

JSON format

{
  "fromDate": "", // leave blank for a search without specific start date 
  "toDate": "", // leave blank for a search without specific end date 
  "fundVehicleIds ": [], // required**, please see the description in the above tables
  "subTypes": [], // leave blank for all subtypes search 
  "spvIds": [] // required**, please see the description in the above tables
}

Response example

[
   {
      "transactionId":178,
      "transactionType":"Fund operation",
      "entity":"Demo Fund I",
      "dealName":null,
      "assetName":null,
      "investor":null,
      "expenseSubSubTypeItem":null,
      "assetSubSubTypeItem":null,
      "subTypes":[
         {
            "subTypeId":0,
            "subType":"Government annual filings"
         }"..."
      ],
      "typeId":1,
      "type":"General expenses",
      "viewBy":"transaction",
      "dueDate":null,
      "noticeDate":null,
      "transactionDate":"2015-03-14",
      "paymentDate":"2015-03-14",
      "reference":"",
      "amount":-30000.0,
      "currencyCode":"USD",
      "status":"Complete",
      "investmentCost":0.0,
      "returnOfInvestmentCost":0.0,
      "realizedGainLoss":0.0,
      "unrealizedGainLoss":0.0,
      "investeeFundName":null,
      "allocationRuleId":1,
      "allocationRule":"Capital Commitment",
      "allocations":[
         {
            "investor":"GP1",
            "percentAllocation":0.15,
            "subTypeId":0,
            "subtype":null,
            "typeId":1,
            "type":"General expenses",
            "dueDate":null,
            "noticeDate":null,
            "transactionDate":"2015-03-14",
            "paymentDate":"2015-03-14",
            "reference":"",
            "amount":-30000.0,
            "currencyCode":"USD",
            "investmentCost":0.0,
            "returnOfInvestmentCost":0.0,
            "realizedGainLoss":0.0,
            "unrealizedGainLoss":0.0
         },
         "..."
      ],
      "dynamicAllocations":[
         {
            "cycle":"2022-01-02 - 2023-08-01",
            "from":"2022-01-02",
            "to":"2023-08-01",
            "allocations":[
               {
                  "investor":"GP1",
                  "percentAllocation":0.15,
                  "subTypeId":0,
                  "subtype":null,
                  "typeId":1,
                  "type":"General expenses",
                  "dueDate":null,
                  "noticeDate":null,
                  "transactionDate":"2015-03-14",
                  "paymentDate":"2015-03-14",
                  "reference":"",
                  "amount":-30000.0,
                  "currencyCode":"USD",
                  "investmentCost":0.0,
                  "returnOfInvestmentCost":0.0,
                  "realizedGainLoss":0.0,
                  "unrealizedGainLoss":0.0
               },
               "..."
            ]
         },
         "..."
      ]
   },
   "..."
]