API status
  • Reporting

Reports

All reports related paths.

get

List user reports

List user reports

typeOne Of

Filters the list to only show reports of a certain type (e.g. only buy order confirmations)

Example
"BUY_ORDER"

Must match one of

Report type

  • ACCOUNT_CLOSING - Securities account closure
  • ACCOUNT_OPENING - Securities account opening
  • AD_HOC_ACCOUNT_STATEMENT - Ad hoc account statement
  • ANNUAL_ACCOUNT_STATEMENT - Annual account statement
  • ANNUAL_INCOME_STATEMENT - Annual tax income statement ("Erträgnisaufstellung")
  • ANNUAL_TAX_STATEMENT - Annual tax reporting
  • BANK_ACCOUNT_CONNECTED - Connect reference bank account
  • BUY_ORDER - Buy order
  • CANCELLED_ORDER - Cancelled buy or sell order (not yet executed, user cancels or trading venue cancelled)
  • CORPORATE_ACTION_CASH_TRANSACTION - cash transaction document (after corporate action)
  • CORPORATE_ACTION_SECURITY_TRANSACTION - security transaction document (after corporate action)
  • DIRECT_DEBIT_MANDATE - Creation of SEPA direct debit mandate
  • EX_POST_COST - Ex-post cost report
  • FUND_COMMUNICATION - Generic fund communication
  • GENERAL_MEETING_NOTIFICATION - General meeting notification
  • GENERIC_COMMUNICATION - Generic communication
  • INCOME_DISTRIBUTION - Income distribution report
  • INCOME_REINVESTMENT - Reinvestment billing report (accumulating funds)
  • MONTHLY_BILLING_STATEMENT - Monthly billing activities statement
  • QUARTERLY_ACCOUNT_STATEMENT - Quarterly account statement
  • REVOKED_ORDER - Revoked buy or sell order ("Storno")
  • SECURITIES_TRANSFER_INCOMING - Securities are transferred in
  • SECURITIES_TRANSFER_OUTGOING - Securities are being transferred out
  • SELL_ORDER - Sell order
  • TAX_EXEMPTION_CREATION - Creation of exemption order ("Freistellungsauftrag")
  • TAX_PAYMENT - Tax payment document
  • TAX_PREPAYMENT_DE - German tax prepayment (Vorabpauschale)
  • TAX_REFUND - Tax refund document (after tax optimization)
Enum
  • ACCOUNT_CLOSING
  • ACCOUNT_OPENING
  • AD_HOC_ACCOUNT_STATEMENT
  • ANNUAL_ACCOUNT_STATEMENT
  • ANNUAL_INCOME_STATEMENT
  • ANNUAL_TAX_STATEMENT
  • BANK_ACCOUNT_CONNECTED
  • BUY_ORDER
  • CANCELLED_ORDER
  • CORPORATE_ACTION_CASH_TRANSACTION
  • CORPORATE_ACTION_SECURITY_TRANSACTION
  • DIRECT_DEBIT_MANDATE
  • EX_POST_COST
  • FUND_COMMUNICATION
  • GENERAL_MEETING_NOTIFICATION
  • GENERIC_COMMUNICATION
  • INCOME_DISTRIBUTION
  • INCOME_REINVESTMENT
  • MONTHLY_BILLING_STATEMENT
  • QUARTERLY_ACCOUNT_STATEMENT
  • REVOKED_ORDER
  • SECURITIES_TRANSFER_INCOMING
  • SECURITIES_TRANSFER_OUTGOING
  • SELL_ORDER
  • TAX_EXEMPTION_CREATION
  • TAX_PAYMENT
  • TAX_PREPAYMENT_DE
  • TAX_REFUND
instrumentOne Of

Filters the list to only include reports concerning specified instrument

Must match one of

International securities identification number, prefixed with string 'isin:'

Pattern
^isin:[A-Z]{2}[A-Z0-9]{9}[0-9]$
start_datestring

Returns reports generated starting from and including this date (UTC)

Format
date
Example
"2020-08-21"
end_datestring

Returns reports generated up until this date (UTC)

Format
date
Example
"2020-09-25"
sortstring

Field of resource to sort by

Default
"created_at"
Enum
  • id
  • type
  • created_at
Example
"id"
orderstring

Sort order of the result list if the sort parameter is specified. Use ASC for ascending or DESC for descending sort order.

Default
"ASC"
Enum
  • ASC
  • DESC
limitint

Use the limit argument to specify the maximum number of items returned.

Format
int32
Default
100
Min
0
Max
1000
offsetint

Use the offset argument to specify where in the list of results to start when returning items for a particular query.

Format
int32
Min
0

Responses

Response examples

Reports list

{
  "meta": {
    "offset": 0,
    "limit": 100,
    "count": 1,
    "total_count": 1,
    "sort": "id",
    "order": "ASC"
  },
  "data": [
    {
      "id": "b96b1ee7-d491-43eb-b5e4-4833af9c9c2f",
      "created_at": "2020-08-24T14:15:22Z",
      "user_id": "d1a4be99-8bb6-4e78-b897-8168f6823ab5",
      "type": "CORPORATE_ACTION_CASH_TRANSACTION",
      "substituted_report_id": null,
      "data": {
        "account": {
          "id": "a9a4ad54-6dd1-419a-a98d-ab48f9f23bc8"
        },
        "references": [
          {
            "id": "b96b1ee7-d491-43eb-b5e4-4833af9c9c2f",
            "type": "CORPORATE_ACTION_TRANSACTION_ID"
          }
        ]
      }
    }
  ]
}
post

Create a user report

Create a user report

typestring

required

The type of report must be “ORDER_EX_ANTE_COST”.

Default
"ORDER_EX_ANTE_COST"
orderobject

required

Order details.

user_idstring

required

The ID of the user.

Format
uuid
account_idstring

required

The ID of the account that owns the order.

Format
uuid
cash_amountstring

Cash amount for a nominal order.

Pattern
^[0-9]{1,9}(\.[0-9]{2})?$
currencystring

required

The currency for the order.

Default
"EUR"
Enum
  • EUR
sidestring

required

Side of the order.

  • BUY -
  • SELL -
Enum
  • BUY
  • SELL
instrument_idstring

required

International securities identification number defined by ISO 6166.

Pattern
^[A-Z]{2}[A-Z0-9]{9}[0-9]$
instrument_id_typestring

required

The type of the ID used in the request.

  • ISIN -
Default
"ISIN"
Enum
  • ISIN
order_typestring

required

Type of the order.

  • MARKET -
  • LIMIT -
  • STOP -
Enum
  • MARKET
  • LIMIT
  • STOP
quantitystring

Quantity of securities for the order.

Pattern
^[0-9]{0,63}(\.[0-9]{1,27})?$
limit_pricestring

The limit price for orders of the type 'limit'.

Pattern
^[0-9]{0,63}(\.[0-9]{1,27})?$
stop_pricestring

The stop price for orders of the type 'stop'.

Pattern
^[0-9]{0,63}(\.[0-9]{1,27})?$
feesarray

Client fees.

Must match one of

inducementsarray

Client inducements.

value_typestring

required

The type of inducement value must be “ABSOLUTE”.

Default
"ABSOLUTE"
cash_amountstring

required

Pattern
^-?[0-9]{1,9}(\.[0-9]{2})?$
currencystring

required

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
Default
"EUR"
Enum
  • EUR

Responses

Request examples

{
  "type": "ORDER_EX_ANTE_COST",
  "order": {
    "user_id": "d1a4be99-8bb6-4e78-b897-8168f6823ab5",
    "account_id": "c5034305-c441-4711-adbf-93cfbc13a695",
    "order_type": "MARKET",
    "side": "BUY",
    "instrument_id": "LU0274208692",
    "instrument_id_type": "ISIN",
    "currency": "EUR",
    "quantity": "15"
  },
  "fees": [
    {
      "type": "TRANSACTION_FEE_BUY",
      "value_type": "ABSOLUTE",
      "cash_amount": "0.80",
      "currency": "EUR"
    },
    {
      "type": "TRANSACTION_FEE_SELL",
      "value_type": "ABSOLUTE",
      "cash_amount": "0.95",
      "currency": "EUR"
    },
    {
      "type": "ANNUAL_AUM_BASED_FEE",
      "value_type": "RELATIVE",
      "bps": "37"
    }
  ],
  "inducements": [
    {
      "value_type": "ABSOLUTE",
      "cash_amount": "0.10",
      "currency": "EUR"
    }
  ]
}

Response examples

Report

{
  "id": "b96b1ee7-d491-43eb-b5e4-4833af9c9c2f",
  "created_at": "2023-08-24T14:15:22Z",
  "user_id": "d1a4be99-8bb6-4e78-b897-8168f6823ab5",
  "type": "ORDER_EX_ANTE_COST",
  "substituted_report_id": null,
  "data": {
    "account": {
      "id": "c5034305-c441-4711-adbf-93cfbc13a695",
      "account_number": 1
    },
    "account_group": {
      "id": "9d95820d-4333-46b6-98de-04ab7512e76f",
      "securities_account_number": "123456789"
    },
    "user": {
      "salutation": "SALUTATION_MALE",
      "title": "DR",
      "first_name": "Karl",
      "last_name": "Schmidt",
      "address": {
        "address_line1": "Rosenweg 221",
        "address_line2": "apt. 33",
        "postcode": "45678",
        "city": "Berlin",
        "country": "DE"
      }
    },
    "instrument": {
      "isin": "LU0274208692",
      "short_name": "XTR.MSCI WORLD SWAP 1C"
    },
    "venue": {
      "name": "Tradegate"
    },
    "order": {
      "user_id": "d1a4be99-8bb6-4e78-b897-8168f6823ab5",
      "instrument_id": "LU0274208692",
      "instrument_id_type": "ISIN",
      "account_id": "c5034305-c441-4711-adbf-93cfbc13a695",
      "order_type": "MARKET",
      "side": "BUY",
      "quantity": "15",
      "cash_amount": "1220.85",
      "currency": "EUR",
      "price": "81.39"
    },
    "holding_period": {
      "unit": "YEAR",
      "quantity": 3
    },
    "total_cost": {
      "product": {
        "cash_amount": "17.48",
        "currency": "EUR",
        "as_percentage": "1.43"
      },
      "service": {
        "cash_amount": "6.88",
        "currency": "EUR",
        "as_percentage": "0.56"
      },
      "third_party": {
        "cash_amount": "0.70",
        "currency": "EUR",
        "as_percentage": "0.06"
      },
      "total": {
        "cash_amount": "25.06",
        "currency": "EUR",
        "as_percentage": "2.05"
      }
    },
    "product_cost": {
      "one_off": {
        "cash_amount": "0.20",
        "currency": "EUR",
        "as_percentage": "0.02"
      },
      "ongoing": {
        "cash_amount": "16.48",
        "currency": "EUR",
        "as_percentage": "1.35"
      },
      "transaction": {
        "cash_amount": "0.80",
        "currency": "EUR",
        "as_percentage": "0.07"
      },
      "incidental": {
        "cash_amount": "0.00",
        "currency": "EUR",
        "as_percentage": "0.00"
      },
      "total": {
        "cash_amount": "17.48",
        "currency": "EUR",
        "as_percentage": "1.43"
      }
    },
    "service_cost": {
      "one_off": {
        "cash_amount": "0.49",
        "currency": "EUR",
        "as_percentage": "0.04"
      },
      "ongoing": {
        "cash_amount": "4.39",
        "currency": "EUR",
        "as_percentage": "0.36"
      },
      "transaction": {
        "cash_amount": "2.00",
        "currency": "EUR",
        "as_percentage": "0.16"
      },
      "ancillary": {
        "cash_amount": "0.00",
        "currency": "EUR",
        "as_percentage": "0.00"
      },
      "incidental": {
        "cash_amount": "0.00",
        "currency": "EUR",
        "as_percentage": "0.00"
      },
      "total": {
        "cash_amount": "6.88",
        "currency": "EUR",
        "as_percentage": "0.56"
      }
    },
    "third_party_payments": {
      "total": {
        "cash_amount": "0.70",
        "currency": "EUR",
        "as_percentage": "0.06"
      },
      "received_by_client": {
        "cash_amount": "0.35",
        "currency": "EUR",
        "as_percentage": "0.03"
      },
      "received_by_upvest": {
        "cash_amount": "0.35",
        "currency": "EUR",
        "as_percentage": "0.03"
      }
    },
    "return_impact": {
      "year_one": {
        "cash_amount": "9.05",
        "currency": "EUR",
        "as_percentage": "0.74"
      },
      "year_two": {
        "cash_amount": "6.96",
        "currency": "EUR",
        "as_percentage": "0.57"
      },
      "year_three": {
        "cash_amount": "8.36",
        "currency": "EUR",
        "as_percentage": "0.68"
      }
    }
  }
}
get

Retrieve a user report

Retrieve a user report

report_idstring

required

Report unique identifier.

Format
uuid

Responses

Response examples

Report

{
  "id": "b96b1ee7-d491-43eb-b5e4-4833af9c9c2f",
  "created_at": "2020-08-24T14:15:22Z",
  "user_id": "d1a4be99-8bb6-4e78-b897-8168f6823ab5",
  "type": "BUY_ORDER",
  "substituted_report_id": null,
  "data": {
    "account": {
      "id": "a9a4ad54-6dd1-419a-a98d-ab48f9f23bc8"
    }
  }
}
webhook

User reports events

idstring

required

Event unique identifier

Format
uuid
created_atstring

required

Date and time when the event was created. RFC 3339-5, ISO8601 UTC

Format
date-time
typestring

required

Event type

Default
"REPORT.CREATED"
Enum
  • REPORT.CREATED
objectAny Of

required

Must match one of

idstring

required

Report unique identifier.

Format
uuid
created_atstring

required

Date and time when the resource was created. RFC 3339-5, ISO8601 UTC

Format
date-time
user_idstring

required

User unique identifier.

Format
uuid
typestring

required

Report type

  • ACCOUNT_CLOSING - Securities account closure
  • ACCOUNT_OPENING - Securities account opening
  • AD_HOC_ACCOUNT_STATEMENT - Ad hoc account statement
  • ANNUAL_ACCOUNT_STATEMENT - Annual account statement
  • ANNUAL_INCOME_STATEMENT - Annual tax income statement ("Erträgnisaufstellung")
  • ANNUAL_TAX_STATEMENT - Annual tax reporting
  • BANK_ACCOUNT_CONNECTED - Connect reference bank account
  • BUY_ORDER - Buy order
  • CANCELLED_ORDER - Cancelled buy or sell order (not yet executed, user cancels or trading venue cancelled)
  • CORPORATE_ACTION_CASH_TRANSACTION - cash transaction document (after corporate action)
  • CORPORATE_ACTION_SECURITY_TRANSACTION - security transaction document (after corporate action)
  • DIRECT_DEBIT_MANDATE - Creation of SEPA direct debit mandate
  • EX_POST_COST - Ex-post cost report
  • FUND_COMMUNICATION - Generic fund communication
  • GENERAL_MEETING_NOTIFICATION - General meeting notification
  • GENERIC_COMMUNICATION - Generic communication
  • INCOME_DISTRIBUTION - Income distribution report
  • INCOME_REINVESTMENT - Reinvestment billing report (accumulating funds)
  • MONTHLY_BILLING_STATEMENT - Monthly billing activities statement
  • QUARTERLY_ACCOUNT_STATEMENT - Quarterly account statement
  • REVOKED_ORDER - Revoked buy or sell order ("Storno")
  • SECURITIES_TRANSFER_INCOMING - Securities are transferred in
  • SECURITIES_TRANSFER_OUTGOING - Securities are being transferred out
  • SELL_ORDER - Sell order
  • TAX_EXEMPTION_CREATION - Creation of exemption order ("Freistellungsauftrag")
  • TAX_PAYMENT - Tax payment document
  • TAX_PREPAYMENT_DE - German tax prepayment (Vorabpauschale)
  • TAX_REFUND - Tax refund document (after tax optimization)
Enum
  • ACCOUNT_CLOSING
  • ACCOUNT_OPENING
  • AD_HOC_ACCOUNT_STATEMENT
  • ANNUAL_ACCOUNT_STATEMENT
  • ANNUAL_INCOME_STATEMENT
  • ANNUAL_TAX_STATEMENT
  • BANK_ACCOUNT_CONNECTED
  • BUY_ORDER
  • CANCELLED_ORDER
  • CORPORATE_ACTION_CASH_TRANSACTION
  • CORPORATE_ACTION_SECURITY_TRANSACTION
  • DIRECT_DEBIT_MANDATE
  • EX_POST_COST
  • FUND_COMMUNICATION
  • GENERAL_MEETING_NOTIFICATION
  • GENERIC_COMMUNICATION
  • INCOME_DISTRIBUTION
  • INCOME_REINVESTMENT
  • MONTHLY_BILLING_STATEMENT
  • QUARTERLY_ACCOUNT_STATEMENT
  • REVOKED_ORDER
  • SECURITIES_TRANSFER_INCOMING
  • SECURITIES_TRANSFER_OUTGOING
  • SELL_ORDER
  • TAX_EXEMPTION_CREATION
  • TAX_PAYMENT
  • TAX_PREPAYMENT_DE
  • TAX_REFUND
substituted_report_idOne Of

required

Must match one of

dataobject (Report Data)

Contents of the report.

webhook_idstring

required

Webhook unique identifier.

Format
uuid

Responses

Request examples

{
  "id": "8962b496-8d42-4560-bfab-10490dd1a721",
  "created_at": "2021-07-21T14:10:00.00Z",
  "type": "REPORT.CREATED",
  "object": {
    "id": "b96b1ee7-d491-43eb-b5e4-4833af9c9c2f",
    "created_at": "2020-08-24T14:15:22Z",
    "user_id": "d1a4be99-8bb6-4e78-b897-8168f6823ab5",
    "type": "CORPORATE_ACTION_CASH_TRANSACTION",
    "substituted_report_id": null,
    "data": {
      "account": {
        "id": "a9a4ad54-6dd1-419a-a98d-ab48f9f23bc8"
      },
      "references": [
        {
          "id": "b96b1ee7-d491-43eb-b5e4-4833af9c9c2f",
          "type": "CORPORATE_ACTION_TRANSACTION_ID"
        }
      ]
    }
  },
  "webhook_id": "9df39835-be87-4243-9018-f2500b39cee6"
}

Response examples

Request has been processed successfully.

Empty response

Was this page helpful?