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 Gets or sets the account group key filter.
    AccountKey AccountKey Query-String Gets or sets the account key filter.
    ClientKey ClientKey Route The key of the client to which the resource belongs.
    FilterType BookingRequestType Query-String Gets or sets the booking filter type.
    FilterValue String Query-String Gets or sets the filter value corresponding to .
    FromDate Date Query-String Gets or sets the from date in UTC.
    MockDataId String Query-String Gets or sets the optional mock data identifier (SIM environments only).
    ToDate Date Query-String Gets or sets the to date in UTC.
  • 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 Booking [] 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 /hist/v1/reports/bookings/AbSTLYSoo499JZpp|ckGFw==?$skip=1&$skiptoken=B17D8890-3C7A-4A47-A9AA-01B022ED03A5&$top=1&AccountGroupKey=stringValue&AccountKey=01b64edf-da03-4145-bf33-ae21527d4c86&FilterType=RelatedTradeId&FilterValue=stringValue&FromDate=2021-05-21&MockDataId=stringValue&ToDate=2021-05-21
  • Response Example

    Response body
    {
      "Data": [
        {
          "AccountCurrency": "stringValue",
          "AccountId": "stringValue",
          "Amount": 10,
          "AmountAccountCurrency": 10,
          "AmountClass": "OngoingPayment",
          "AmountClientCurrency": 10,
          "AmountSubClass": "ManagementFee",
          "AmountUSD": 10,
          "AssetType": "Etn",
          "BkAmountId": "stringValue",
          "BkAmountType": "stringValue",
          "BkAmountTypeId": "stringValue",
          "CaEventName": "stringValue",
          "CaMasterRecordId": "stringValue",
          "ClientCurrency": "stringValue",
          "ConversionRate": 10,
          "ConversionRateAccountCurrency": 10,
          "ConversionRateClientCurrency": 10,
          "ConversionRateUSD": 10,
          "CostClass": "TransactionCosts",
          "CostSubClass": "ServiceCosts",
          "Currency": "stringValue",
          "Date": "2021-05-21T00:00:00Z",
          "InstrumentDescription": "stringValue",
          "InstrumentSectorName": "stringValue",
          "InstrumentSectorTypeId": 99,
          "InstrumentSubType": "Forex",
          "InstrumentSymbol": "stringValue",
          "RelatedPositionId": "stringValue",
          "RelatedTradeId": "stringValue",
          "RootInstrumentSectorName": "stringValue",
          "RootInstrumentSectorTypeId": 99,
          "Uic": 99,
          "UnderlyingInstrumentAssetType": "Fund",
          "UnderlyingInstrumentDescription": "stringValue",
          "UnderlyingInstrumentSectorName": "stringValue",
          "UnderlyingInstrumentSubType": "Interests",
          "UnderlyingInstrumentSymbol": "stringValue",
          "UnderlyingInstrumentUic": 99,
          "UnderlyingType": "Basket",
          "ValueDate": "2021-05-21T00:00:00Z"
        }
      ],
      "MaxRows": 99
    }