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#
| Property | Type | Optional | Description |
|---|---|---|---|
| id | string | No | Primary identifier of the investment transaction. |
| tradeDate | Date | Yes | The date when the transaction was settled. |
| date | Date | No | The date when the transaction was made. |
| quantity | number | Yes | Quantity of invested quotas. |
| value | number | Yes | Value at which it was acquired. |
| amount | number | Yes | The gross value of the operation. |
| type | InvestmentTransactionType | No | Type of movement of the transaction. |
| movementType | string | Yes | Cash-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). |
| description | string | Yes | Description of the transaction. |
| brokerageNumber | string | Yes | Number of the corresponding brokerage note. |
| netAmount | number | Yes | Value including expenses. |
| agreedRate | number | Yes | Agreed rate only available for TREASURY applications. |
| indexerPercentage | number | Yes | Maximum percentage of the indexer agreed at contracting (e.g. 110% of CDI). |
| priceFactor | number | Yes | B3 lot/price conversion factor, for variable income transactions. |
| expenses | Expenses | Yes | Taxes and charges described in the brokerage notes. Returned for Open Finance and Meu Pluggy connections; null for other connections. |
Investment Transaction Type#
| Value | Description |
|---|---|
| BUY | Application. |
| SELL | Withdrawal. |
| TAX | Taxes that decrease the investment size. |
| TRANSFER | Transfer between investments. |
| INTEREST | Income distributions: dividends, rental income (FIIs), interest on capital (JCP), coupon payments. |
| AMORTIZATION | Partial 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.
| Property | Type | Optional | Description |
|---|---|---|---|
| serviceTax | number | Yes | Service tax varies according to state (ISS). |
| brokerageFee | number | Yes | Commission charged by the brokerage for carrying out transactions on the stock market. |
| incomeTax | number | Yes | Income Tax Withholding is the amount paid to the Internal Revenue Service (IRRF). |
| other | number | Yes | Sum of other not defined expenses. |
| tradingAssetsNoticeFee | number | Yes | A fee of Notice of Trading in Assets (ANA). |
| maintenanceFee | number | Yes | Fees charged by BM&F Bovespa in negotiations. |
| settlementFee | number | Yes | Liquidation fee for the settlement of a position on the expiration date or the financial settlement of physical delivery. |
| clearingFee | number | Yes | Clearing fee charged by the clearing house. |
| stockExchangeFee | number | Yes | Fees charged by BM&F Bovespa as a source of operating income. |
| custodyFee | number | Yes | Fee charged by brokers to keep records in their home broker systems or on the trading desk. |
| operatingFee | number | Yes | Amount paid to the Operator for the intermediation service. |
| iof | number | Yes | Tax on financial operations (IOF) charged on the transaction. |
| iofProvision | number | Yes | Provisioned 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:
incomeTaxandiofare the ones filled most often.- The brokerage note fees —
brokerageFee,settlementFee,stockExchangeFee,clearingFee,custodyFee,tradingAssetsNoticeFeeandother— are filled only when the institution reports a brokerage note for the operation. serviceTax,maintenanceFee,operatingFeeandiofProvisionare not filled on Open Finance connections.
Example of a Transaction:
{
"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.
