This route is used to get the details regarding a capital event (Capital Call / Distribution), given a set of search filters.
This endpoint returns paginated data. Up to 100 can be extracted per call.
This endpoint can be called by applications with access to scope "readCapitalEvent".
The number of rows being retrieved. Must be a positive integer.
The offset (i.e. row start index). Must be a positive integer (or 0).
The comma delimited list of security ids to filter the capital events records. Up to 10 records can be provided. Each record should not exceed 12 characters.
USCCWSF01I00,USCCWSF01I01
The comma delimited list of security correlation ids to filter the capital events records. Up to 10 records can be provided. Each record should not exceed 100 characters.
USCCWSF01I00,USCCWSF01I01
The comma delimited list of capital event correlation ids to filter the capital event records. Up to 100 records can be provided. Each record should not exceed 100 characters.
USCCWSF01I00,USCCWSF01I01
The organization identifier linked to the correlation ids provided in the "capitalEventCorrelationIdsFilter" property. If not provided the organization id will be inferred from the access token.
The comma delimited list of capital event ids to filter the capital event records. Up to 100 records can be provided. Each record should not exceed 12 characters.
USCCWSF01I00,USCCWSF01I01
The comma delimited list of statuses to filter the capital event records. Up to 9 entries can be provided. Available values: preSync, deleted, draft, pending, approval_in_progress, active, closed, canceled, cancel_in_progress
draft,active
GET /external/v1/capital-events HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
[
{
"extraData": {
"externalId": "123456789",
"some": "Custom Property"
},
"type": "capitalCall",
"endDate": "2024-09-12T00:00:00.000Z",
"amountCalled": 100000,
"expenses": 2000,
"temporaryDistributionAmount": 100000,
"permanentDistributionAmount": 2000,
"correlationData": [
{
"correlationId": "123245573717",
"origin": "Identifies capital event on backoffice",
"organization": {
"name": "Test Organization",
"orgId": "TEST1234"
},
"extraData": {
"some": "Custom Property"
}
}
],
"status": "draft",
"capitalEventId": "US9QIMAOAS1Q",
"securityId": "USS3JKS01I00",
"breakdown": [
{
"categoryId": "USS3JKS01I00",
"amount": 90000,
"extraData": {
"some": "Custom Data"
}
},
{
"categoryId": "USS3JKS01I01",
"amount": 10000
}
],
"organization": {
"orgId": "TEST1234",
"name": "Test Organization"
}
}
]