Looking for the previous documentation?Go to v1.docs.pluggy.ai

Investment's Transactions

Each investment contains a list of transactions corresponding to Applications or Withdrawals. The transaction schema contains a set of details of that operation.

View as Markdown

Each investment contains a list of transactions corresponding to Applications or Withdrawals. The transaction schema contains a set of details of that operation.

Investment Transaction#

PropertyTypeOptionalDescription
idstringNoPrimary identifier of the investment transaction.
tradeDateDateYesThe date when the transaction was settled.
dateDateNoThe date when the transaction was made.
quantitynumberYesQuantity of invested quotas.
valuenumberYesValue at which it was acquired.
amountnumberYesThe gross value of the operation.
typeInvestmentTransactionTypeNoType of movement of the transaction.
movementTypestringYesCash-flow direction of the transaction from the holder's perspective: CREDIT when money goes into the position (default for BUY), DEBIT when it leaves it (default for every other type).
descriptionstringYesDescription of the transaction.
brokerageNumberstringYesNumber of the corresponding brokerage note.
netAmountnumberYesValue including expenses.
agreedRatenumberYesAgreed rate only available for TREASURY applications.
indexerPercentagenumberYesMaximum percentage of the indexer agreed at contracting (e.g. 110% of CDI).
priceFactornumberYesB3 lot/price conversion factor, for variable income transactions.
expensesExpensesYesTaxes and charges described in the brokerage notes. Returned for Open Finance and Meu Pluggy connections; null for other connections.

Investment Transaction Type#

ValueDescription
BUYApplication.
SELLWithdrawal.
TAXTaxes that decrease the investment size.
TRANSFERTransfer between investments.
INTERESTIncome distributions: dividends, rental income (FIIs), interest on capital (JCP), coupon payments.
AMORTIZATIONPartial return of principal (amortização de cotas, bond amortization).

Expenses#

When we buy an asset traded on a stock exchange, usually through a brokerage firm, the brokerage firm issues a commercial note called a brokerage note. The note contains the total value of the transaction, the assets bought and sold, the fees related to the stock exchange, the amount charged by the broker (brokerage fee), and the total sum. The brokerage note represents the daily status of an investor's operations in the financial market. All taxes charged in each operation are grouped in the Expenses object.

Availability

When listed through GET /investments/{id}/transactionsAPI, expenses is returned for investment transactions from Open Finance connections and from Meu Pluggy connections. For other connections the field is null. A transaction with no fees reported by the institution also returns null.

PropertyTypeOptionalDescription
serviceTaxnumberYesService tax varies according to state (ISS).
brokerageFeenumberYesCommission charged by the brokerage for carrying out transactions on the stock market.
incomeTaxnumberYesIncome Tax Withholding is the amount paid to the Internal Revenue Service (IRRF).
othernumberYesSum of other not defined expenses.
tradingAssetsNoticeFeenumberYesA fee of Notice of Trading in Assets (ANA).
maintenanceFeenumberYesFees charged by BM&F Bovespa in negotiations.
settlementFeenumberYesLiquidation fee for the settlement of a position on the expiration date or the financial settlement of physical delivery.
clearingFeenumberYesClearing fee charged by the clearing house.
stockExchangeFeenumberYesFees charged by BM&F Bovespa as a source of operating income.
custodyFeenumberYesFee charged by brokers to keep records in their home broker systems or on the trading desk.
operatingFeenumberYesAmount paid to the Operator for the intermediation service.
iofnumberYesTax on financial operations (IOF) charged on the transaction.
iofProvisionnumberYesProvisioned IOF: accrued for the transaction but not yet paid.

On Open Finance connections the breakdown comes from the regulated broker note, which reports the withheld income tax (IRRF) on its own. It arrives as incomeTax; every other tax charged on the operation — day-trade income tax included — is summed into other. The two never overlap, so adding them together gives the operation's full tax cost.

Which fees are filled on Open Finance connections depends on what the institution reports for each operation:

  • incomeTax and iof are the ones filled most often.
  • The brokerage note fees — brokerageFee, settlementFee, stockExchangeFee, clearingFee, custodyFee, tradingAssetsNoticeFee and other — are filled only when the institution reports a brokerage note for the operation.
  • serviceTax, maintenanceFee, operatingFee and iofProvision are not filled on Open Finance connections.

Example of a Transaction:

json
{
  "total": 1,
  "totalPages": 1,
  "page": 1,
  "results": [
    {
      "id": "0f4e3a57-6b1d-4c8e-9a2f-3d5b7c9e1a24",
      "type": "BUY",
      "movementType": "CREDIT",
      "description": "Aplicação Fundo de Investimento Premium",
      "quantity": 1.25,
      "value": 2,
      "amount": 5,
      "netAmount": 5.31,
      "date": "2022-03-24T03:00:00.000Z",
      "tradeDate": "2022-03-24T03:00:00.000Z",
      "brokerageNumber": "47078992",
      "agreedRate": null,
      "indexerPercentage": null,
      "priceFactor": null,
      "expenses": {
        "serviceTax": 0.05,
        "brokerageFee": 0.1,
        "incomeTax": 0.01,
        "other": 0.01,
        "tradingAssetsNoticeFee": 0,
        "maintenanceFee": 0,
        "settlementFee": 0.09,
        "clearingFee": 0,
        "stockExchangeFee": 0.05,
        "custodyFee": 0,
        "operatingFee": 0,
        "iof": 0,
        "iofProvision": 0
      }
    }
  ]
}

See Investment TransactionsAPI in our API reference for more information.

Was this page helpful?