--- title: "List user reports" method: GET path: "/users/{user_id}/reports" tags: ["Reports"] --- # List user reports `GET /users/{user_id}/reports` List user reports ## Query parameters - `type` union - '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' | 'GENERIC_COMMUNICATION' | 'INCOME_DISTRIBUTION' | 'MONTHLY_BILLING_STATEMENT' | 'QUARTERLY_ACCOUNT_STATEMENT' | 'REVOKED_ORDER' | 'SECURITIES_TRANSFER_INCOMING' | 'SECURITIES_TRANSFER_OUTGOING' | 'SELL_ORDER' | 'TAX_PAYMENT' | 'TAX_PREPAYMENT_DE' | 'TAX_PREPAYMENT_DE_CANCELLATION' | 'TAX_REFUND' | 'FRENCH_IFU' | 'TAX_CONSOLIDATED_CERTIFICATE_UK' | 'FEE_COLLECTION' | 'LOSS_THRESHOLD' — 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 * GENERIC_COMMUNICATION - Generic communication * INCOME_DISTRIBUTION - Income distribution report * 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_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) * FRENCH_IFU - French tax statement (Imprimé fiscal unique) * TAX_CONSOLIDATED_CERTIFICATE_UK - UK Consolidated Tax Certificate * FEE_COLLECTION - Intake of service fees * LOSS_THRESHOLD - Notification that a holding has depreciated by 10%, or a multiple thereof, against its purchase value - 'ORDER_EX_ANTE_COST' | 'ORDER_EX_ANTE_COST_SAVINGS_PLAN' — The type of report must be “ORDER_EX_ANTE_COST” or “ORDER_EX_ANTE_COST_SAVINGS_PLAN”. - `instrument` union - string — International securities identification number, prefixed with string 'isin:' - string — Unique identifier, prefixed with string 'uuid:' - `start_date` string, date — Returns reports generated starting from and including this date (UTC) - `end_date` string, date — Returns reports generated up until this date (UTC) - `sort` 'id' | 'type' | 'created_at' - `order` 'ASC' | 'DESC' - `limit` integer - `offset` integer ## Response `200` Reports list - object - `meta` object, required - `offset` integer, required — Amount of resource to offset in the response. - `limit` integer, required — Total limit of the response. - `count` integer, required — Count of the resources returned in the response. - `total_count` integer, required — Total count of all the resources. - `sort` string, required — The field that the list is sorted by. - `order` 'ASC' | 'DESC', required — The ordering of the response. * ASC - Ascending order * DESC - Descending order - `data` object[], required - `id` string, uuid, required — Report unique identifier. - `created_at` string, date-time, required — Date and time when the resource was created. [RFC 3339-5](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), [ISO8601 UTC](https://www.iso.org/iso-8601-date-and-time-format.html) - `user_id` string, uuid, required — User unique identifier. - `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' | 'GENERIC_COMMUNICATION' | 'INCOME_DISTRIBUTION' | 'MONTHLY_BILLING_STATEMENT' | 'QUARTERLY_ACCOUNT_STATEMENT' | 'REVOKED_ORDER' | 'SECURITIES_TRANSFER_INCOMING' | 'SECURITIES_TRANSFER_OUTGOING' | 'SELL_ORDER' | 'TAX_PAYMENT' | 'TAX_PREPAYMENT_DE' | 'TAX_PREPAYMENT_DE_CANCELLATION' | 'TAX_REFUND' | 'FRENCH_IFU' | 'TAX_CONSOLIDATED_CERTIFICATE_UK' | 'FEE_COLLECTION' | 'LOSS_THRESHOLD', required — 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 * GENERIC_COMMUNICATION - Generic communication * INCOME_DISTRIBUTION - Income distribution report * 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_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) * FRENCH_IFU - French tax statement (Imprimé fiscal unique) * TAX_CONSOLIDATED_CERTIFICATE_UK - UK Consolidated Tax Certificate * FEE_COLLECTION - Intake of service fees * LOSS_THRESHOLD - Notification that a holding has depreciated by 10%, or a multiple thereof, against its purchase value - `substituted_report_id` string, uuid, required — References report that has been replaced by this one. - `data` object — Contents of the report. - `account` object — Account information. - `id` string, uuid — Account unique identifier. - `references` object[] - `id` string, uuid - `type` 'CORPORATE_ACTION_TRANSACTION_ID' | 'ACCOUNT_GROUP_ID' | 'ACCOUNT_ID' | 'ORDER_ID' — Report reference type * CORPORATE_ACTION_TRANSACTION_ID - Corporate action transaction identifier * ACCOUNT_GROUP_ID - Account group identifier * ACCOUNT_ID - Account identifier * ORDER_ID - Order identifier ## Other responses - `400` — Bad Request. The incoming request had a malformed parameter/object. - `401` — Unauthorized. The caller has not been authenticated. - `403` — Forbidden. The caller has been authenticated but is not allowed to take the requested action. - `404` — Not Found. The requested resource could not be found. - `406` — Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. "Accept" header defined unsupported value. - `429` — Too Many Requests. The caller has exceeded their quota for the time period and has been throttled. - `500` — Internal Server Error. The service encountered an unexpected error. - `503` — Service Unavailable. The service handling for this request cannot be reached at this time. - `504` — Gateway Timeout. The service gateway has reached its internal timeout. --- [API](https://skmtc.net/upvest/apis/upvest-investment-api.md) · [All operations](https://skmtc.net/upvest/apis/upvest-investment-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/upvest/upvest-investment-api/revisions/eb94c0091916/schema)