AM/TA - Get Capital Event History

Details

/external/v1/capital-events/history

Synopsis

Get Capital Event History by Id

get

This route is used to get the history of 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".

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

blockNumbernumber · max: 2147483647Optional

The block number where the action was recorded on the ledger.

Example: 350

transactionIdstring · max: 500Optional

The transaction id where the action was recorded on the ledger.

Example: 456789OIJHGFCVGHJKLKJHGF67JHPattern: ^[a-zA-Z0-9-]*$

channelNamestring · max: 20Optional

The name of the channel where the action was recorded on the ledger.

Example: OG123Pattern: ^[a-zA-Z0-9-]*$

capitalEventCorrelationIdsFilterstringOptional

The comma delimited list of capital event correlation ids to filter the capital event history 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 history records. Up to 100 records can be provided. Each record should not exceed 12 characters.

Example: USCCWSF01I00,USCCWSF01I01

Responses

200

Successfully extracted the capital event history

application/json

timestampstring · date-timeRequired

The timestamp in which the action took place.

Example: 2024-09-12T00:00:00.000Z

blockNumbernumberRequired

The block number where this action was recorded on the ledger.

Example: 350

transactionIdstringRequired

The transaction id where this action was recorded on the ledger.

Example: 456789OIJHGFCVGHJKLKJHGF67JH

channelNamestringRequired

The name of the channel where this action was recorded on the ledger.

Example: OG123

eventall ofRequired

The type of capital event action.

Example: Created

string · enumOptional

The type of capital event action.

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/history

HTTPcURLJavaScriptPython

GET /external/v1/capital-events/history HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  {
    "signerData": {
      "name": "John Doe",
      "email": "[email protected]"
    },
    "timestamp": "2024-09-12T00:00:00.000Z",
    "blockNumber": 350,
    "transactionId": "456789OIJHGFCVGHJKLKJHGF67JH",
    "channelName": "OG123",
    "organization": {
      "name": "Test Organization",
      "orgId": "TEST1234"
    },
    "event": "Created",
    "update": {
      "type": "capitalCall",
      "endDate": "2024-09-12T00:00:00.000Z",
      "amountCalled": 100000,
      "expenses": 2000,
      "organization": {
        "orgId": "TEST1234",
        "name": "Test Organization"
      },
      "breakdown": [
        {
          "categoryId": "USS3JKS01I00",
          "amount": 9000
        },
        {
          "categoryId": "USS3JKS01I01",
          "amount": 10000
        },
        {
          "categoryId": "USS3JKS01I02",
          "amount": 2000,
          "extraData": {
            "other": "Fund Level Information"
          }
        }
      ],
      "status": "draft",
      "capitalEventId": "US9QIMAOAS1Q",
      "securityId": "USS3JKS01I00"
    }
  }
]