Settlement reports

The settlement advice is a report that represents the net trading position at the end of the day and contains all transactions for which settlement must take place. As a general rule, Upvest will provide the settlement advice for each trading day. This also applies to the settlement advice of corporate action processing.

If the fee functionality of the Investment API is used, we will create a fee settlement report describing any fee collections that were conducted and transferred to the registered bank account.

INFO

The settlement advice is issued as of T+1 for net buy, T+2 for net sell days.
Sell order settlements delay for a net sell day, and will settled once Upvest has received cash for all orders.
Note that different settlement advice types are not netted (i.e., trading vs. corporate actions).

To be able to retrieve the reports for settlement via the Investment API, we provide the /files endpoint.

Go to the 'Retrieving settlement reports' chapter to find a detailed description of how to fetch reports.

Settlement report types

There are various settlement reports that can be accessed via the Investment API through fixed signed URLs. In this section we list the individual report types and their respective specifications.

Report type	Description
Corporate action cash settlement	For the settlement advice reports, the date in the file corresponds to the settlement date of the respective cash-based corporate actions.
Daily trades settlement	For trading activities, we expose one report per side of the respective trading day, the date is the expected settlement date for buy and sell reports.
Fee settlement	For the settlement advice reports, the date in the file corresponds to the settlement date of the respective fee collection amounts forwarded to the registered bank account.

Settlement report data

In the following tables you can see which data is included in a settlement report.

Corporate action data

Parameter	Example	Description
`corporate_action_transaction_id`	8fc84a40-3456-263d-8f34	Corporate action transaction ID. This ID can be used to fetch the transaction using the Investment API.
`transaction_date`	2023-06-29T00:00:00Z	The date when the corporate action was processed.
`tax_amount`	0.14	The tax amount on the corporate actions.
`settlement_amount`	0.62	The amount of funds that have to be transferred for the corporate action. It is a total income distribution for all units of this ISIN in ownership.
`gross_amount`	0.76	The amount incl. tax.
`instrument`	IE00B6YX5D40	ISIN
`currency`	EUR	The currency.
`type`	CASH_DIVIDEND	The corporate action type.
`payment_date`	2023-06-27T00:00:00Z	The custodian settlement date.
`settlement_date`	2023-06-29T00:00:00Z	The date when the corporate action was settled with the client.
`instrument_id`	2fc24a40-3456-263d-2f34	The instrument ID.

Buy/ sell data

Parameter	Example	Description
`order_execution_id`	2c5278f0-d5da-4d07-864c-0ab320f567f3	The ID of the order execution.
`order_id`	2563ea0f-22d5-4113-b8bb-496de345e2c1	The order ID.
`transaction_date`	2023-06-29T00:00:00Z	The date when the buy/ sell order was processed.
`tax_amount`	0.14	The tax amount on the corporate actions.
`settlement_amount`	0.62	The amount of funds that have to be transferred for the buy/ sell order.
`gross_amount`	0.76	The amount incl. tax.
`instrument`	IE00B6YX5D40	ISIN
`currency`	EUR	The currency.
`instrument_id`	2fc24a40-3456-263d-2f34	The instrument ID.

Fees data

Parameter	Example	Description
`fee_collection_id`	uuid	The ID of the fee collection.
`type`	SERVICE_FEE	The fee type.
`settlement_amount`	5	The amount of funds that have to be transferred for fees.
`currency`	EUR	The currency.
`transaction_date`	2023-06-29T00:00:00Z	The date when the fee was processed.

Next steps

After you have familiarised yourself with the different settlement reports and their characteristics, the next step is to learn how to retrieve them via the Investment API. For this purpose, go to 'Retrieving settlement reports'.