Endpoint Parameters

  • Request parameters

    Name Type Origin Description
    $skip Integer Query-String The number of entries to skip from the beginning of the collection
    $skiptoken String Query-String Specifies an entity id to start retrieving entries from. This is normally only used in generated nextlinks.
    $top Integer Query-String The number of entries to return from the beginning of the collection
    AccountGroupKey AccountGroupKey Query-String The key of the account group to which the resource belongs.
    AccountKey AccountKey Query-String The key of the account to which the resource belongs.
    ClientKey ClientKey Route The key of the client to which the resource belongs.
    FromDate Date Route From date
    MockDataId String Query-String Optional Mock Data Parameter
    ToDate Date Route To date
  • Response Parameters

    View Response Codes
    Name Type Description
    __count Number The total count of items in the feed.
    __next String The link for the next page of items in the feed.
    Data AggregatedAmount [] The collection of entities for this feed.
    MaxRows Number The maximum number of rows that can be returned (if applicable).
  • Request Example

    Request URL
    GET /cs/v1/reports/aggregatedAmounts/493b43a5-fe85-4d1f-9071-dd4a9d4e42a4/2016-10-10/2017-10-10?$skip=1&$skiptoken=B17D8890-3C7A-4A47-A9AA-01B022ED03A5&$top=1&AccountGroupKey=stringValue&AccountKey=01b64edf-da03-4145-bf33-ae21527d4c86&MockDataId={MockDataId}
  • Response Example

    Response body
    {
      "__next": "/openapi/....../?$top=1&$skip=1",
      "Data": [
        {
          "AccountCurrency": "DKK",
          "AffectsBalance": false,
          "Amount": 255.71,
          "AmountAccountCurrency": 255.71,
          "AmountClass": "NotAssigned",
          "AmountClientCurrency": 255.71,
          "AmountSubClass": "NotAssigned",
          "AmountTypeId": -3,
          "AmountTypeName": "Cash Balances",
          "AmountUSD": 41.2259276277075,
          "BookingAccountId": "179643INET",
          "ClientCurrency": "DKK",
          "Date": "2015-01-02T00:00:00Z",
          "InstrumentSectorName": "",
          "InstrumentSectorTypeId": 0,
          "InstrumentSubType": "None",
          "InstrumentSubTypeId": 0,
          "IsManual": false,
          "RootInstrumentSectorName": "",
          "RootInstrumentSectorTypeId": 0,
          "Uic": 0,
          "UnderlyingInstrumentSubType": "None",
          "UnderlyingInstrumentUic": 0
        },
        {
          "AccountCurrency": "DKK",
          "AffectsBalance": false,
          "Amount": 660,
          "AmountAccountCurrency": 4073.280255,
          "AmountClass": "NotAssigned",
          "AmountClientCurrency": 4073.280255,
          "AmountSubClass": "NotAssigned",
          "AmountTypeId": -6,
          "AmountTypeName": "Exposure",
          "AmountUSD": 660,
          "AssetType": "StockIndexOption",
          "BookingAccountId": "179643INET",
          "ClientCurrency": "DKK",
          "Date": "2015-01-02T00:00:00Z",
          "InstrumentDescription": "Volatility Index (VIX) Jan2015 15.000 C",
          "InstrumentSectorName": "",
          "InstrumentSectorTypeId": 0,
          "InstrumentSubType": "None",
          "InstrumentSubTypeId": 0,
          "InstrumentSymbol": "VIX/F15C15=xcbf",
          "IsManual": false,
          "RootInstrumentSectorName": "",
          "RootInstrumentSectorTypeId": 0,
          "Uic": 1012706,
          "UnderlyingInstrumentAssetType": "StockIndex",
          "UnderlyingInstrumentDescription": "CBOE Volatility Index",
          "UnderlyingInstrumentSubType": "None",
          "UnderlyingInstrumentSymbol": "VIX.I",
          "UnderlyingInstrumentUic": 10606
        }
      ]
    }