Throughout the API flows, an asset represents multiple shares, or a lot, of a given security.
/external/v1/capital-events/assets
This route is used to get the details regarding a capital event (Capital Call / Distribution) at the asset level, given a set of search filters.
i.e., the details of how much is being called/distributed from/to each asset.
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 capital event correlation ids to filter the asset capital event records. Up to 100 records can be provided. Each record should not exceed 100 characters.
USCCWSF01I00,USCCWSF01I01The 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 asset capital event records. Up to 100 records can be provided. Each record should not exceed 12 characters.
USCCWSF01I00,USCCWSF01I01The comma delimited list of asset ids to filter the asset capital events records. Up to 500 records can be provided. Each record should not exceed 12 characters.
USCCWSF01I00,USCCWSF01I01The comma delimited list of asset correlation ids to filter the asset capital events records. Up to 50 records can be provided. Each record should not exceed 100 characters.
1234,5678,7890The organization identifier linked to the correlation ids provided in the "assetCorrelationIdsFilter" property. If not provided the organization id will be inferred from the access token.
The comma delimited list of statuses to filter the asset capital event records. Up to 8 entries can be provided. Available values: preSync, draft, active, settled, failed, funded, fundedAfterFailure, canceled
draft,activeGET /external/v1/capital-events/assets HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
[
{
"extraData": {
"externalId": "123456789",
"some": "Custom Property"
},
"assetId": "USS3JKS01I00",
"amountCalled": 100000,
"expenses": 2000,
"temporaryDistributionAmount": 100000,
"permanentDistributionAmount": 2000,
"breakdown": [
{
"categoryId": "USS3JKS01I00",
"amount": 90000,
"extraData": {
"some": "Custom Data"
}
},
{
"categoryId": "USS3JKS01I01",
"amount": 10000
}
],
"settlementData": [
{
"date": "2024-09-12T00:00:00.000Z",
"status": "settled",
"amount": 1000
}
],
"status": "active"
}
]