All pages
Powered by GitBook
1 of 1

Loading...

AM/FA/Inv - Get Capital Event Details By ID

Details

/external/v1/capital-events

Synopsis

Get Capital Event Details

get

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

Authorizations
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).

securityIdsFilterstringOptional

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.

Example: USCCWSF01I00,USCCWSF01I01
securityCorrelationIdsFilterstringOptional

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.

Example: USCCWSF01I00,USCCWSF01I01
capitalEventCorrelationIdsFilterstringOptional

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.

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 capital event records. Up to 100 records can be provided. Each record should not exceed 12 characters.

Example: USCCWSF01I00,USCCWSF01I01
capitalEventStatusFilterstringOptional

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

Example: draft,active
Responses
200
Successfully extracted the capital event data
application/json
400
The following error codes can be returned: - CE0003 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
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"
    }
  }
]