AM/TA - Get Breakdown Categories Details

Details

/external/v1/capital-events/categories

Synopsis

Get Breakdown Categories Details

get

This route is used to retrieve the details of breakdown categories, given a set of search filters. This endpoint is paginated, up to 100 records can be retrieved 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).

securityIdsFilterstringOptional

The comma delimited list of security ids to filter the breakdown category 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 breakdown category records. Up to 10 records can be provided. Each record should not exceed 100 characters.

Example: USCCWSF01I00,USCCWSF01I01

securityCorrelationOrgIdstring · max: 12Optional

The organization identifier linked to the correlation ids provided in the "securityCorrelationIdsFilter" property. If not provided the organization id will be inferred from the access token.

breakdownCategoryIdsFilterstringOptional

The comma delimited list of breakdown category ids to filter the category records. Up to 100 records can be provided. Each record should not exceed 12 characters.

Example: USCCWSF01I00,USCCWSF01I01

Responses

200

Successfully retrieved breakdown categories details

application/json

typeall ofRequired

The capital event transaction type (ILPA standard - please refer to the appendix of this document, section transaction type definitions: https://ilpa.org/wp-content/uploads/2018/03/ILPA-Best-Practices-Capital-Calls-Distribution-Notices_Version-1.1.pdf). Category should be consistent with the capital event type [capitalCall, distribution].

Example: deemedGPContribution

string · enumOptional

The capital event transaction type (ILPA standard - please refer to the appendix of this document, section transaction type definitions: https://ilpa.org/wp-content/uploads/2018/03/ILPA-Best-Practices-Capital-Calls-Distribution-Notices_Version-1.1.pdf). Category should be consistent with the capital event type [capitalCall, distribution].

Possible values:

typeNamestringOptional

Free text capital event transaction type. Must be provided if the capital event transaction type is equal to 'other'

Example: Other Expenses

flowTypeall ofRequired

The type of money flow - will come/go from/to commitment amount or as an expense. The flow type must be consistent with the capital event type. - [againstCommitment, expenses] should only be provided if the capital event is a capital call. - [temporaryDistribution, permanentDistribution] should only be provided if the capital event is a distribution

Example: againstCommitment

string · enumOptional

The type of money flow - will come/go from/to commitment amount or as an expense. The flow type must be consistent with the capital event type. - [againstCommitment, expenses] should only be provided if the capital event is a capital call. - [temporaryDistribution, permanentDistribution] should only be provided if the capital event is a distribution

Possible values:

descriptionstring · max: 1000Optional

The capital event transaction type description. Can be used to complement the type property.

Example: Call from LPs, on behalf of GP's share of a capital call (typically serves as an offset to future management fees)

securityIdstringRequired

The id that uniquely identifies the security on the ledger for which a capital event breakdown category was created.

Example: USS3JKS01I00

categoryIdstring · max: 12Required

The id that uniquely identifies a capital event breakdown category on the ledger.

Example: USS3JKS01I00

statusall ofRequired

The status of the capital event breakdown.

Example: published

string · enumOptional

The status of the capital event breakdown.

Possible values:

400

The following error codes can be returned: - GN0002 - 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 Please refer to the error code dictionary for the details of each error code.

application/json

get

/external/v1/capital-events/categories

HTTPcURLJavaScriptPython

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

[
  {
    "extraData": {
      "externalId": "123456789",
      "some": "Custom Property"
    },
    "type": "deemedGPContribution",
    "typeName": "Other Expenses",
    "flowType": "againstCommitment",
    "description": "Call from LPs, on behalf of GP's share of a capital call (typically serves as an offset to future management fees)",
    "securityId": "USS3JKS01I00",
    "categoryId": "USS3JKS01I00",
    "status": "published",
    "organization": {
      "orgId": "TEST1234",
      "name": "Test Organization"
    }
  }
]