Capital contribution-distribution transactions
You can retrieve a list of capital contribution – distribution transactions using the following API:
HTTP Method | POST |
Path | /api/search/capital |
Reference | [searchcapitaltransaction] |
Request Body | CapitalCallTransactionSearch object in JSON, the required fields are - fundvehicleIds - investorIds |
Request Body JSON format
{
"fromDate": "", // leave blank for a search without specific start date
"toDate": "", // leave blank for a search without specific end date
"fundvehicleIds ": [], // required**
"subTypes": [], // leave blank for all subtypes search
"investorIds": [], // required**
"chartOfAccountIds": [], // leave blank for all subtypes search
"subTypeExpenseIdsFilter": [], // leave blank for all expense types search
}
Request body example
Below is a basic example of the "Capital transaction search" body request.
{
"fromDate": "",
"toDate": "",
"fundvehicleIds": [17,26,27],
"subTypes": [1,2,4,5,6],
"investorIds": [22],
"spvIds": [2,7],
"chartOfAccountIds": [25,26,27],
"subTypeExpenseIdsFilter": []
}
curl -X POST "https://<Quantium Web API URL>/api/search/capital" -H "accept: */*" -H "Authorization: Bearer <Your bearer token>" -H "Content-Type: application/json-patch+json" -d "{\"fromDate\":\"\",\"toDate\":\"\",\"fundvehicleIds\":[17,26,27],\"subTypes\":[1,2,4,5,6],\"investorIds\":[22],\"spvIds\":[2,7],\"chartOfAccountIds\":[25,26,27],\"subTypeExpenseIdsFilter\":[]}"
var payload = {
"fromDate": "",
"toDate": "",
"fundvehicleIds": [17,26,27],
"subTypes": [1,2,4,5,6],
"investorIds": [22],
"spvIds": [2,7],
"chartOfAccountIds": [25,26,27],
"subTypeExpenseIdsFilter": []
};
$.ajax({
url: `https://Quantium web api url/api/search/capital`,
type: 'post',
dataType: 'json',
contentType: 'application/json',
success: function (data) {
$('#target').html(data.msg);
},
data: JSON.stringify(payload)
});
using (var client = new HttpClient())
{
client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", "Your token");
client.BaseAddress = new Uri($"https://Quantium web api url/api/search/capital");
var response = await client.PostAsync(urlpart, new StringContent(data, Encoding.UTF8, "application/json"));
var responseResult = await response.Content.ReadAsStringAsync();
return responseResult;
}
Response
Code | Meaning |
200(OK) | The successful request will return transactions in the response body |
400 (Bad request) | Invalid input, the reason provided, in the response body |
Capital transaction list result example
[
{
"transactionId": 4962,
"transactionType": "Capital",
"entity": "Limited Partner 1 Asia Program",
"dealName": null,
"assetName": null,
"investor": "Limited Partner 1 Asia Investment",
"expenseSubSubTypeItem": "",
"assetSubSubTypeItem": "",
"subTypeId": 0,
"subtype": "Contribution",
"typeId": 821,
"type": "",
"viewBy": null,
"dueDate": null,
"noticeDate": null,
"transactionDate": "2021-05-01",
"paymentDate": "",
"reference": "",
"amount": 8000,
"currencyCode": "USD",
"status": "Overdue",
"investmentCost": 0,
"returnOfInvestmentCost": 0,
"realizedGainLoss": 0,
"unrealizedGainLoss": 0,
"investeeFundName": null
},
{
...
// transactions
}
]
Updated over 1 year ago