AM/TA/Inv - Get Asset Capital Event Details

Throughout the API flows, an asset represents multiple shares, or a lot, of a given security.

Details

/external/v1/capital-events/assets

Synopsis

Get Asset Capital Event Details

get

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".

Required scopes

This endpoint requires the following scopes:

• : readCapitalEvent

Authorizations

oauth2

OAuth2clientCredentialsRequired

Token URL:

Query parameters

pageSizenumberOptional

The number of rows being retrieved. Must be a positive integer.

offsetnumberOptional

The offset (i.e. row start index). Must be a positive integer (or 0).

capitalEventCorrelationIdsFilterstringOptional

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.

Example: USCCWSF01I00,USCCWSF01I01

capitalEventCorrelationOrgIdstring · max: 12Optional

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.

capitalEventIdsFilterstringOptional

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.

Example: USCCWSF01I00,USCCWSF01I01

assetIdsFilterstringOptional

The 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.

Example: USCCWSF01I00,USCCWSF01I01

assetCorrelationIdsFilterstringOptional

The 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.

Example: 1234,5678,7890

assetCorrelationOrgIdstring · max: 12Optional

The 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.

assetCapitalEventStatusFilterstringOptional

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

Example: draft,active

Responses

200

Successfully extracted the capital event data

application/json

assetIdstringRequired

The unique id of the asset from which the capital is being called / distributed

Example: USS3JKS01I00

amountCallednumber · max: 999999999999999Optional

The total amount of capital being called against commitment. Must be provided if the capital event is of type "capitalCall". Up to 2 decimal cases can be provided. Should not be provided if the capital event is of type "distribution".

Example: 100000

expensesnumber · max: 999999999999999Optional

The total amount of capital being called for expenses (outside the commitment obligations from each investor). Must be provided if the capital event is of type "capitalCall". Up to 2 decimal cases can be provided. Should not be provided if the capital event is of type "distribution".

Example: 2000

temporaryDistributionAmountnumber · max: 999999999999999Optional

The total amount of capital being temporarily distributed back to the investor. This capital can be recalled on future capital calls. Must be provided if the capital event is of type "distribution". Up to 2 decimal cases can be provided. Should not be provided if the capital event is of type "capitalCall".

Example: 100000

permanentDistributionAmountnumber · max: 999999999999999Optional

The total amount of capital being permanently distributed back to the investor. Must be provided if the capital event is of type "distribution". Up to 2 decimal cases can be provided. Should not be provided if the capital event is of type "capitalCall".

Example: 2000

statusall ofRequired

The status of the capital event at the asset level

Example: active

string · enumOptional

The status of the capital event at the asset level

Possible values:

400

The following error codes can be returned: - CE0003 - GN0002 - TX0006 - GN0004 - GN0005 Please refer to the error code dictionary for the details of each error code.

application/json

401

The following error codes can be returned: - AU0001 Please refer to the error code dictionary for the details of each error code.

application/json

403

The following error codes can be returned: - AU0002 - CE0002 Please refer to the error code dictionary for the details of each error code.

application/json

get

/external/v1/capital-events/assets

HTTPcURLJavaScriptPython

GET /external/v1/capital-events/assets HTTP/1.1
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"
  }
]