Reports

List user reports

Changed on

Returns the list of reports generated for the end user identified by user_id.

Narrow the list with the type, instrument, start_date, and end_date query parameters, and page through results with offset and limit; meta.total_count gives the total number of matching reports. Subscribe to the REPORT.CREATED webhook event to be notified as reports are generated, rather than polling this endpoint.

See the accessing end user reports guide (TOL / BYOL) for the available report types and query parameters.

get/users/{user_id}/reports

Request

  • Base URL: https://sandbox.upvest.co
  • URL: https://sandbox.upvest.co/users/{user_id}/reports
  • Auth: OAuth 2 (client credentials, token URL https://sandbox.upvest.co/auth/token, scopes: reports:read, reports:admin)

Query parameters

type'ACCOUNT_CLOSING' | 'ACCOUNT_OPENING' | 'AD_HOC_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' | 'FEE_COLLECTION' | 'FRENCH_IFU' | 'GENERIC_COMMUNICATION' | 'INCOME_DISTRIBUTION' | 'LOSS_THRESHOLD' | 'MONTHLY_BILLING_STATEMENT' | 'ORDER_EX_ANTE_COST' | 'ORDER_EX_ANTE_COST_SAVINGS_PLAN' | 'QUARTERLY_ACCOUNT_STATEMENT' | 'REVOKED_ORDER' | 'SECURITIES_TRANSFER_INCOMING' | 'SECURITIES_TRANSFER_OUTGOING' | 'SELL_ORDER' | 'TAX_CONSOLIDATED_CERTIFICATE_UK' | 'TAX_PAYMENT' | 'TAX_PREPAYMENT_DE' | 'TAX_PREPAYMENT_DE_CANCELLATION' | 'TAX_REFUND'

Report type

  • ACCOUNT_CLOSING - Securities account closure
  • ACCOUNT_OPENING - Securities account opening
  • AD_HOC_ACCOUNT_STATEMENT - Ad hoc 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
  • FEE_COLLECTION - Intake of service fees
  • FRENCH_IFU - French tax statement (Imprimé fiscal unique)
  • GENERIC_COMMUNICATION - Generic communication
  • INCOME_DISTRIBUTION - Income distribution report
  • LOSS_THRESHOLD - Notification that a holding has depreciated by 10%, or a multiple thereof, against its purchase value
  • MONTHLY_BILLING_STATEMENT - Monthly billing activities statement
  • ORDER_EX_ANTE_COST - Ex-ante cost report for a single order
  • ORDER_EX_ANTE_COST_SAVINGS_PLAN - Ex-ante cost report for a savings plan order
  • 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_CONSOLIDATED_CERTIFICATE_UK - UK Consolidated Tax Certificate
  • TAX_PAYMENT - Tax payment document
  • TAX_PREPAYMENT_DE - German tax prepayment (Vorabpauschale)
  • TAX_PREPAYMENT_DE_CANCELLATION - German tax prepayment (Vorabpauschale) cancellation
  • TAX_REFUND - Tax refund document (after tax optimization)

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

string

An International Securities Identification Number in URN form, prefixed with isin:.

OR
string

A unique identifier in URN form, prefixed with uuid:.

Filters the list to only include reports concerning specified instrument

start_datestring date

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

end_datestring date

Returns reports generated up until this date (UTC)

sort'id' | 'type' | 'created_at'

Field of resource to sort by

order'ASC' | 'DESC'

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

limitinteger

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

offsetinteger

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

Response

Reports list

Changes

  • 65bf4621b0c6Revision changes
    • breaking

      the query request parameter type was restricted to a list of enum values

    • warning

      added the new ORDER_EX_ANTE_COST enum value to the // response property for the response status

    • warning

      added the new ORDER_EX_ANTE_COST_SAVINGS_PLAN enum value to the // response property for the response status

    • info

      added the new enum value ACCOUNT_CLOSING to the query request parameter type

    • info

      added the new enum value ACCOUNT_OPENING to the query request parameter type

    • info

      added the new enum value AD_HOC_ACCOUNT_STATEMENT to the query request parameter type

    • info

      added the new enum value ANNUAL_INCOME_STATEMENT to the query request parameter type

    • info

      added the new enum value ANNUAL_TAX_STATEMENT to the query request parameter type

    • info

      added the new enum value BANK_ACCOUNT_CONNECTED to the query request parameter type

    • info

      added the new enum value BUY_ORDER to the query request parameter type

    • info

      added the new enum value CANCELLED_ORDER to the query request parameter type

    • info

      added the new enum value CORPORATE_ACTION_CASH_TRANSACTION to the query request parameter type

    • info

      added the new enum value CORPORATE_ACTION_SECURITY_TRANSACTION to the query request parameter type

    • info

      added the new enum value DIRECT_DEBIT_MANDATE to the query request parameter type

    • info

      added the new enum value EX_POST_COST to the query request parameter type

    • info

      added the new enum value FEE_COLLECTION to the query request parameter type

    • info

      added the new enum value FRENCH_IFU to the query request parameter type

    • info

      added the new enum value GENERIC_COMMUNICATION to the query request parameter type

    • info

      added the new enum value INCOME_DISTRIBUTION to the query request parameter type

    • info

      added the new enum value LOSS_THRESHOLD to the query request parameter type

    • info

      added the new enum value MONTHLY_BILLING_STATEMENT to the query request parameter type

    • info

      added the new enum value ORDER_EX_ANTE_COST to the query request parameter type

    • info

      added the new enum value ORDER_EX_ANTE_COST_SAVINGS_PLAN to the query request parameter type

    • info

      added the new enum value QUARTERLY_ACCOUNT_STATEMENT to the query request parameter type

    • info

      added the new enum value REVOKED_ORDER to the query request parameter type

    • info

      added the new enum value SECURITIES_TRANSFER_INCOMING to the query request parameter type

    • info

      added the new enum value SECURITIES_TRANSFER_OUTGOING to the query request parameter type

    • info

      added the new enum value SELL_ORDER to the query request parameter type

    • info

      added the new enum value TAX_CONSOLIDATED_CERTIFICATE_UK to the query request parameter type

    • info

      added the new enum value TAX_PAYMENT to the query request parameter type

    • info

      added the new enum value TAX_PREPAYMENT_DE to the query request parameter type

    • info

      added the new enum value TAX_PREPAYMENT_DE_CANCELLATION to the query request parameter type

    • info

      added the new enum value TAX_REFUND to the query request parameter type

    • info

      for the query request parameter type, the type was generalized from no type to string

  • eb94c0091916Revision changes
    • warning

      added the new LOSS_THRESHOLD enum value to the // response property for the response status

    • info

      added the enum value LOSS_THRESHOLD to the property oneOf[subschema #1: Report type]/ of the query request parameter type