List portfolio transactions

Retrieves all the portfolio transactions for the given connection. Portfolio Transactions in Vumi Finlink are understood as those financial movements that are directly related to investments. Portfolio Transactions are related to a specific portfolio through its ID

List portfolio transactions for the given connection

Retrieve every portfolio transaction for the given connection

GEThttps://api.finlink.vumi.io/api/v1/queries/connections/{token}/portfolios/transactions

Authorization

bearerAuth

Path parameters

token*string

Token to identify the connection

Query parameters

Response

200401404500

Successfully retrieved all portfolio transactions

Body

application/json

itemsarray of TransactionDto (object)

List of items for the current page

limitinteger (int32)

Maximum number of items per page

pageinteger (int64)

Current page number starting from zero (0)

totalItemsinteger (int64)

Total number of items across all pages

Request

JavaScriptCurlPython

const response = await fetch('https://api.finlink.vumi.io/api/v1/queries/connections/{token}/portfolios/transactions', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200404

{
  "items": [
    {
      "transactionId": "123e4567-e89b-12d3-a456-426614174000",
      "portfolioId": "123e4567-e89b-12d3-a456-426614174000",
      "exchangeRate": 1.1809,
      "type": "BUY",
      "titles": 0,
      "amount": 1000,
      "amountBaseCurrency": 0,
      "commission": 0,
      "taxes": 0,
      "currency": "EUR",
      "localCurrency": "USD",
      "description": "text",
      "price": 0,
      "operationDateDay": "2024-11-21",
      "originalOperationDateDay": "2024-11-21",
      "valueDateDay": "2024-11-21",
      "originalValueDateDay": "2024-11-21",
      "operationDateHour": "text",
      "originalOperationDateHour": "text",
      "valueDateHour": "text",
      "originalValueDateHour": "text",
      "originalOperationDateTz": "text",
      "originalValueDateTz": "text",
      "investment": "123e4567-e89b-12d3-a456-426614174000",
      "relatedTransaction": "123e4567-e89b-12d3-a456-426614174000"
    }
  ]
}

Portfolio transaction types

Understanding portfolio transaction types is core to using Vumi Finlink API correctly. Below you can find a list with all the different types that you'll find when using the Finlink API. We have included a column to explain the impact of these types in the position of the user, meaning if they add shares (+), remove shares (-), or the share count indicates just the position size at the given time (=).

Type	Description	Share impact
BUY	Purchase of financial securities or assets	+
COMPENSATION	Compensation received due to a corporate event of an asset. A typical case is the cash associated to a forced sell, that was not indicated in the forced sell itself	=
COUPON	Periodic interest payment that a bondholder receives during the life of a bond. It represents a fixed percentage of the bond’s face (or par) value	=
DELISTING	Removal of a security from a stock exchange	-
DIVIDENDS	Distribution of a portion of a company's earnings to shareholders	=
EXPIRATION
INHERITANCE_OR_DONATION_TRANSFER_IN	Transfer of assets into an account due to a donation or inheritance	+
INHERITANCE_OR_DONATION_TRANSFER_OUT	Transfer of assets to another account due to a donation or inheritance	-
ISIN_CHANGE_BUY	Acquisition of securities as part of an isin change	+
ISIN_CHANGE_SELL	Sale of securities as part of an isin change	-
MERGER_BUY	Acquisition of securities as part of a merger	+
MERGER_SELL	Sale of securities as part of a merger	-
OFF_MARKET_BUY	Purchase of securities outside a formal exchange, or securities granted by an action not directly done by the holder	+
OFF_MARKET_SELL	Sale of securities outside a formal exchange, or due to an action not controlled by the holder	-
PRODUCT_CHANGE_BUY	Acquisition of securities as part of a product change. Product changes typically involve changing some aspects of the product, like the share class, without involving a full isin change	+
PRODUCT_CHANGE_SELL	Sale of securities as part of a product change. Product changes typically involve changing some aspects of the product, like the share class, without involving a full isin change	-
RIGHTS_CONVERSION_BUY	Receival of Stock as part of rights being converted. Typically associated to a scrip dividend or capital raise	+
RIGHTS_CONVERSION_SELL	Conversion of rights into shares. This is the sell part associated to the rights	-
RIGHTS_EXCLUSION	Sell of rights typically due to their exclusion from the stock market	-
RIGHTS_ISSUE	Emission of rights, typically due to a Scrip dividend or capital raise	+
SELL	Sale of financial securities or assets	-
SHARE_ISSUE_PREMIUM	Additional amount received over the par value of shares issued	=
SPINOFF	Grant of shares after the creation of an independent company from a parent company that is owned	+
SPLIT_BUY	Acquisition of securities as part of a split	+
SPLIT_SELL	Sale of securities as part of a split	-
TRANSFER_IN	Transfer of securities into an account	+
TRANSFER_OUT	Transfer of securities out of an account	-
UNKNOWN	Transactions that could not be correctly classified	=

Considerations

Handling unknown transactions

In some rare occassions, you can find transactions marked as UNKNOWN. This means that the specific transaction was found for the first time in that connection, and that we were unable to categorize it correctly. We value data quality as one of our core principles, so we took the decision of marking those cases as UNKNOWN instead of miscategorizing them.

Whenever a transaction is marked as UNKNOWN, we have internal processed in place to resolve the issue as soon as possible. Once the issue is resolved, you will be informed and the transaction should be correctly categorized after a new connection of the credential. We are currently working on a methodology to re-categorize UNKNOWN transactions without the need of reconnecting the full credential again.