--- title: "Retrieve a report" method: GET path: "/reports/{report_id}" tags: ["Reports"] --- # Retrieve a report `GET /reports/{report_id}` Retrieve a report for either a natural person or a business entity. ## Headers - `accept` 'application/json' | 'application/pdf' — Report format ## Response `200` Report - union - object - `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 - object - `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) - `business_id` string, uuid, required — Unique identifier for the business. - `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 - object - `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` 'ORDER_EX_ANTE_COST' | 'ORDER_EX_ANTE_COST_SAVINGS_PLAN', required — The type of report must be “ORDER_EX_ANTE_COST” or “ORDER_EX_ANTE_COST_SAVINGS_PLAN”. - `substituted_report_id` string, uuid, required — References report that has been replaced by this one. - `data` object — Contents of the order-ex-ante cost report for a user. - `holding_period` object — Holding period. - `unit` 'YEAR' — Unit of time. * YEAR - - `quantity` integer — Quantity of time units. - `instrument` object — Instrument details. - `isin` string — International securities identification number defined by [ISO 6166](https://en.wikipedia.org/wiki/International_Securities_Identification_Number). - `short_name` string — Instrument short name. - `venue` object — Venue details. - `name` string — Venue name. - `account` object — Account details. - `id` string, uuid — Account unique identifier. - `account_number` integer — The serial account number of the account in the account group. - `account_group` object — Account group details. - `id` string, uuid — Account group unique identifier. - `securities_account_number` string — Securities account number. - `user` object, required — User details. - `first_name` string — First name of the user. - `last_name` string — Last name of the user. - `salutation` '' | 'SALUTATION_MALE' | 'SALUTATION_FEMALE' | 'SALUTATION_FEMALE_MARRIED' | 'SALUTATION_DIVERSE' — Salutation of the user used in reports and statements. * (empty string) - * SALUTATION_MALE - * SALUTATION_FEMALE - * SALUTATION_FEMALE_MARRIED - * SALUTATION_DIVERSE - - `title` '' | 'DR' | 'PROF' | 'PROF_DR' | 'DIPL_ING' | 'MAGISTER' — Addressed user's title is used in reports and statements. * (empty string) - * DR - Doctor * PROF - Professor * PROF_DR - * DIPL_ING - Graduate engineer (Diplom-Ingenieur) * MAGISTER - - `address` object — User residential address. - `address_line1` string — First line of the address. - `address_line2` string — Second line of the address. - `postcode` string — Postal code (postcode, PIN or ZIP code) - `country` string — Country code. [ISO 3166 alpha-2 Codes](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). - `state` string — State, province, county. [ISO 3166 alpha-2 Codes](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). - `city` string - `order` object — Order details. - `user_id` string, uuid — The ID of the user. - `account_id` string, uuid — The ID of the account that owns the order. - `cash_amount` string — Cash amount for a nominal order. - `currency` 'EUR' | 'GBP' — The currency for the order. - `side` 'BUY' | 'SELL' — Side of the order. * BUY - * SELL - - `instrument_id` string — International securities identification number defined by [ISO 6166](https://en.wikipedia.org/wiki/International_Securities_Identification_Number). - `instrument_id_type` 'ISIN' — The type of the ID used in the request. * ISIN - - `order_type` 'MARKET' | 'LIMIT' | 'STOP' — Order type. * MARKET - * LIMIT - * STOP - - `quantity` string — Quantity of securities for the order. - `limit_price` string — The limit price for orders of the type 'limit'. - `stop_price` string — The stop price for orders of the type 'stop'. - `price` string — The estimated price for the order. In case of LIMIT or STOP order provided LIMIT/STOP price will be used. - `return_impact` object — Return impact. - `year_one` object - `cash_amount` string - `currency` 'EUR' | 'GBP' — Alphabetic three-letter [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code. * EUR - Euro * GBP - Pound Sterling - `as_percentage` string — The cost value represented as a percentage. - `year_two` object - `cash_amount` string - `currency` 'EUR' | 'GBP' — Alphabetic three-letter [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code. * EUR - Euro * GBP - Pound Sterling - `as_percentage` string — The cost value represented as a percentage. - `year_three` object - `cash_amount` string - `currency` 'EUR' | 'GBP' — Alphabetic three-letter [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code. * EUR - Euro * GBP - Pound Sterling - `as_percentage` string — The cost value represented as a percentage. - `total_cost` object — Aggregated totals of product costs, service costs and third party payments. - `product` object - `cash_amount` string - `currency` 'EUR' | 'GBP' — Alphabetic three-letter [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code. * EUR - Euro * GBP - Pound Sterling - `as_percentage` string — The cost value represented as a percentage. - `service` object - `cash_amount` string - `currency` 'EUR' | 'GBP' — Alphabetic three-letter [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code. * EUR - Euro * GBP - Pound Sterling - `as_percentage` string — The cost value represented as a percentage. - `third_party` object - `cash_amount` string - `currency` 'EUR' | 'GBP' — Alphabetic three-letter [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code. * EUR - Euro * GBP - Pound Sterling - `as_percentage` string — The cost value represented as a percentage. - `total` object - `cash_amount` string - `currency` 'EUR' | 'GBP' — Alphabetic three-letter [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code. * EUR - Euro * GBP - Pound Sterling - `as_percentage` string — The cost value represented as a percentage. - `product_cost` object — All costs and associated charges related to the financial instrument. - `one_off` object - `cash_amount` string - `currency` 'EUR' | 'GBP' — Alphabetic three-letter [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code. * EUR - Euro * GBP - Pound Sterling - `as_percentage` string — The cost value represented as a percentage. - `ongoing` object - `cash_amount` string - `currency` 'EUR' | 'GBP' — Alphabetic three-letter [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code. * EUR - Euro * GBP - Pound Sterling - `as_percentage` string — The cost value represented as a percentage. - `transaction` object - `cash_amount` string - `currency` 'EUR' | 'GBP' — Alphabetic three-letter [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code. * EUR - Euro * GBP - Pound Sterling - `as_percentage` string — The cost value represented as a percentage. - `incidental` object - `cash_amount` string - `currency` 'EUR' | 'GBP' — Alphabetic three-letter [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code. * EUR - Euro * GBP - Pound Sterling - `as_percentage` string — The cost value represented as a percentage. - `total` object - `cash_amount` string - `currency` 'EUR' | 'GBP' — Alphabetic three-letter [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code. * EUR - Euro * GBP - Pound Sterling - `as_percentage` string — The cost value represented as a percentage. - `service_cost` object — All costs and associated charges related to the investment service(s) and/or ancillary services. - `one_off` object - `cash_amount` string - `currency` 'EUR' | 'GBP' — Alphabetic three-letter [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code. * EUR - Euro * GBP - Pound Sterling - `as_percentage` string — The cost value represented as a percentage. - `ongoing` object - `cash_amount` string - `currency` 'EUR' | 'GBP' — Alphabetic three-letter [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code. * EUR - Euro * GBP - Pound Sterling - `as_percentage` string — The cost value represented as a percentage. - `transaction` object - `cash_amount` string - `currency` 'EUR' | 'GBP' — Alphabetic three-letter [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code. * EUR - Euro * GBP - Pound Sterling - `as_percentage` string — The cost value represented as a percentage. - `ancillary` object - `cash_amount` string - `currency` 'EUR' | 'GBP' — Alphabetic three-letter [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code. * EUR - Euro * GBP - Pound Sterling - `as_percentage` string — The cost value represented as a percentage. - `incidental` object - `cash_amount` string - `currency` 'EUR' | 'GBP' — Alphabetic three-letter [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code. * EUR - Euro * GBP - Pound Sterling - `as_percentage` string — The cost value represented as a percentage. - `total` object - `cash_amount` string - `currency` 'EUR' | 'GBP' — Alphabetic three-letter [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code. * EUR - Euro * GBP - Pound Sterling - `as_percentage` string — The cost value represented as a percentage. - `third_party_payments` object — Third-party payments associated with the investment service. - `total` object - `cash_amount` string - `currency` 'EUR' | 'GBP' — Alphabetic three-letter [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code. * EUR - Euro * GBP - Pound Sterling - `as_percentage` string — The cost value represented as a percentage. - `received_by_client` object - `cash_amount` string - `currency` 'EUR' | 'GBP' — Alphabetic three-letter [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code. * EUR - Euro * GBP - Pound Sterling - `as_percentage` string — The cost value represented as a percentage. - `received_by_upvest` object - `cash_amount` string - `currency` 'EUR' | 'GBP' — Alphabetic three-letter [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code. * EUR - Euro * GBP - Pound Sterling - `as_percentage` string — The cost value represented as a percentage. - object - `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) - `business_id` string, uuid, required — Unique identifier for the business. - `type` 'ORDER_EX_ANTE_COST', required — The type of report must be “ORDER_EX_ANTE_COST”. Savings plan ex-ante reports are not supported for business entities. - `substituted_report_id` string, uuid, required — References report that has been replaced by this one. - `data` object — Contents of the order ex-ante cost report for a business. - `holding_period` object — Holding period. - `unit` 'YEAR' — Unit of time. * YEAR - - `quantity` integer — Quantity of time units. - `instrument` object — Instrument details. - `isin` string — International securities identification number defined by [ISO 6166](https://en.wikipedia.org/wiki/International_Securities_Identification_Number). - `short_name` string — Instrument short name. - `venue` object — Venue details. - `name` string — Venue name. - `account` object — Account details. - `id` string, uuid — Account unique identifier. - `account_number` integer — The serial account number of the account in the account group. - `account_group` object — Account group details. - `id` string, uuid — Account group unique identifier. - `securities_account_number` string — Securities account number. - `business` object, required — Business details. - `company_name` string — Name of the company. - `address` object — Address. Must not be a P.O. box or c/o address. - `address_line1` string, required — First address line of the address. - `address_line2` string — Second address line of the address. - `postcode` string, required — Postal code (postcode, PIN or ZIP code) - `country` 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AO' | 'AQ' | 'AR' | 'AS' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FM' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GU' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MH' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MP' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PR' | 'PS' | 'PT' | 'PW' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VI' | 'VN' | 'VU' | 'WF' | 'WS' | 'XK' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW', required — Accepted country code. [ISO 3166-1 alpha-2 codes](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). - `state` string — State, province, county. [ISO 3166 alpha-2 Codes](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). - `city` string, required - `order` object — Order details. - `business_id` string, uuid — The ID of the business. - `account_id` string, uuid — The ID of the account that owns the order. - `cash_amount` string — Cash amount for a nominal order. - `currency` 'EUR' | 'GBP' — The currency for the order. - `side` 'BUY' | 'SELL' — Side of the order. * BUY - * SELL - - `instrument_id` string — International securities identification number defined by [ISO 6166](https://en.wikipedia.org/wiki/International_Securities_Identification_Number). - `instrument_id_type` 'ISIN' — The type of the ID used in the request. * ISIN - - `order_type` 'MARKET' | 'LIMIT' | 'STOP' — Order type. * MARKET - * LIMIT - * STOP - - `quantity` string — Quantity of securities for the order. - `limit_price` string — The limit price for orders of the type 'limit'. - `stop_price` string — The stop price for orders of the type STOP. - `price` string — The estimated price for the order. In case of LIMIT or STOP order provided LIMIT/STOP price will be used. - `return_impact` object — Return impact. - `year_one` object - `cash_amount` string - `currency` 'EUR' | 'GBP' — Alphabetic three-letter [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code. * EUR - Euro * GBP - Pound Sterling - `as_percentage` string — The cost value represented as a percentage. - `year_two` object - `cash_amount` string - `currency` 'EUR' | 'GBP' — Alphabetic three-letter [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code. * EUR - Euro * GBP - Pound Sterling - `as_percentage` string — The cost value represented as a percentage. - `year_three` object - `cash_amount` string - `currency` 'EUR' | 'GBP' — Alphabetic three-letter [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code. * EUR - Euro * GBP - Pound Sterling - `as_percentage` string — The cost value represented as a percentage. - `total_cost` object — Aggregated totals of product costs, service costs and third party payments. - `product` object - `cash_amount` string - `currency` 'EUR' | 'GBP' — Alphabetic three-letter [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code. * EUR - Euro * GBP - Pound Sterling - `as_percentage` string — The cost value represented as a percentage. - `service` object - `cash_amount` string - `currency` 'EUR' | 'GBP' — Alphabetic three-letter [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code. * EUR - Euro * GBP - Pound Sterling - `as_percentage` string — The cost value represented as a percentage. - `third_party` object - `cash_amount` string - `currency` 'EUR' | 'GBP' — Alphabetic three-letter [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code. * EUR - Euro * GBP - Pound Sterling - `as_percentage` string — The cost value represented as a percentage. - `total` object - `cash_amount` string - `currency` 'EUR' | 'GBP' — Alphabetic three-letter [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code. * EUR - Euro * GBP - Pound Sterling - `as_percentage` string — The cost value represented as a percentage. - `product_cost` object — All costs and associated charges related to the financial instrument. - `one_off` object - `cash_amount` string - `currency` 'EUR' | 'GBP' — Alphabetic three-letter [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code. * EUR - Euro * GBP - Pound Sterling - `as_percentage` string — The cost value represented as a percentage. - `ongoing` object - `cash_amount` string - `currency` 'EUR' | 'GBP' — Alphabetic three-letter [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code. * EUR - Euro * GBP - Pound Sterling - `as_percentage` string — The cost value represented as a percentage. - `transaction` object - `cash_amount` string - `currency` 'EUR' | 'GBP' — Alphabetic three-letter [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code. * EUR - Euro * GBP - Pound Sterling - `as_percentage` string — The cost value represented as a percentage. - `incidental` object - `cash_amount` string - `currency` 'EUR' | 'GBP' — Alphabetic three-letter [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code. * EUR - Euro * GBP - Pound Sterling - `as_percentage` string — The cost value represented as a percentage. - `total` object - `cash_amount` string - `currency` 'EUR' | 'GBP' — Alphabetic three-letter [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code. * EUR - Euro * GBP - Pound Sterling - `as_percentage` string — The cost value represented as a percentage. - `service_cost` object — All costs and associated charges related to the investment service(s) and/or ancillary services. - `one_off` object - `cash_amount` string - `currency` 'EUR' | 'GBP' — Alphabetic three-letter [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code. * EUR - Euro * GBP - Pound Sterling - `as_percentage` string — The cost value represented as a percentage. - `ongoing` object - `cash_amount` string - `currency` 'EUR' | 'GBP' — Alphabetic three-letter [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code. * EUR - Euro * GBP - Pound Sterling - `as_percentage` string — The cost value represented as a percentage. - `transaction` object - `cash_amount` string - `currency` 'EUR' | 'GBP' — Alphabetic three-letter [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code. * EUR - Euro * GBP - Pound Sterling - `as_percentage` string — The cost value represented as a percentage. - `ancillary` object - `cash_amount` string - `currency` 'EUR' | 'GBP' — Alphabetic three-letter [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code. * EUR - Euro * GBP - Pound Sterling - `as_percentage` string — The cost value represented as a percentage. - `incidental` object - `cash_amount` string - `currency` 'EUR' | 'GBP' — Alphabetic three-letter [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code. * EUR - Euro * GBP - Pound Sterling - `as_percentage` string — The cost value represented as a percentage. - `total` object - `cash_amount` string - `currency` 'EUR' | 'GBP' — Alphabetic three-letter [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code. * EUR - Euro * GBP - Pound Sterling - `as_percentage` string — The cost value represented as a percentage. - `third_party_payments` object — Third party payments associated with the investment service. - `total` object - `cash_amount` string - `currency` 'EUR' | 'GBP' — Alphabetic three-letter [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code. * EUR - Euro * GBP - Pound Sterling - `as_percentage` string — The cost value represented as a percentage. - `received_by_client` object - `cash_amount` string - `currency` 'EUR' | 'GBP' — Alphabetic three-letter [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code. * EUR - Euro * GBP - Pound Sterling - `as_percentage` string — The cost value represented as a percentage. - `received_by_upvest` object - `cash_amount` string - `currency` 'EUR' | 'GBP' — Alphabetic three-letter [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code. * EUR - Euro * GBP - Pound Sterling - `as_percentage` string — The cost value represented as a percentage. ## Other responses - `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/2c6bc192bc09/schema)