Investment

The Investment entity is recovered from not only Brokers (XP, Orama, Rico) but also from retail and business Bank institutions.

The list of investments from an institution can be differentiated based on the type of the investment. Each type of investment has a set of fields that relate to the specific investment type.

 

Property

Description

name

Name on the provider.

code

Investment associated code.
In the case of Mutual Funds it's the CNPJ of the Fund.

isin

12-character ISIN, a globally unique identifier.

number

Investment number, not always provided.

owner

Owner/beneficiary associated with the investment.

currencyCode

Currency iso code of the transaction, ie USD .

type

Investment type.

subtype

Investment's subtype

lastMonthRate

The interest rate for the last month.

lastTwelveMonthsRate

Annual interest for the last 12 months.

annualRate

Annual interest for the last year.

date

Value quota date.

value

Quota's current value at date

quantity

Quantity of quota at disposal.

amount

Gross amount of the investment (tax included).

taxes

Income taxes applied to the investment

taxes2

Financial taxes applied to the investment.

balance

The current net balance amount of the investment.
After fees & taxes were applied.

rate

Fixed rate percentage applied to the investment.

rateType

Type of fixed-rate (example: CDI).

fixedAnnualRate

Fixed income annual rate (Example: 10.50).

issuer

The entity that issued the investment.

issueDate

The date that the entity issued the investment.

amountProfit

Profit to date over the investment.

amountWithdrawal

The amount available to withdraw.

amountOriginal

Amount originally invested.

status

Current status of the investment.
ACTIVE, PENDING & TOTAL_WITHDRAWAL

institution

Broker or Financial Institution holder of the investment.
This is only returned in CEI B3 Connector.

transactions

List of Investments Transactions associated with Applications or Withdrawals, that affect the amount invested

 

Investment Types & Subtypes

To understand the nature of an investment you can relay on the investment type & subtype fields that have accurate relation on the types of investments available in Pluggy.

Type

Subtype

Description

FIXED_INCOME

CRI
CRA
LCI
LCA
LC
TREASURY
DEBENTURES
CDB

Real Estate Receivables Certificate
Agricultural Receivables Certificate
Real State Credit Bill
Agricultural Credit Bill
Bill of Exchange
National Treasury
Corporate Debt
Certificate of Deposit

SECURITY

RETIRMENT

Previdencia Privada

MUTUAL_FUND

INVESTMENT_FUND

Investment Funds

EQUITY

STOCK
BDR
REAL_ESTATE_FUND
DERIVATIVES

Shares, Stocks
Brazilian Depositary Receipt
Real State Funds
Derivatives

ETF

ETF

Exchange-Traded Funds

COE

STRUCTURED_NOTE

[
  {
    "id": "f77eccf4-7714-498e-92a9-1bebe70335d9",
    "number": null,
    "name": "Bahia AM Advisory FIC de FIM",
    "balance": 1359.39,
    "currencyCode": "BRL",
    "type": "MUTUAL_FUND",
    "subtype": "INVESTMENT_FUND",
    "lastMonthRate": 0.24,
    "annualRate": 3.24,
    "lastTwelveMonthsRate": 3,
    "itemId": "207f5bcd-312a-439c-abbe-166b6632c980",
    "code": "12.345.678/0001-00",
    "value": 500,
    "quantity": 3,
    "amount": 1500,
    "taxes": 40.61,
    "taxes2": 100,
    "date": "2020-07-19T18:27:41.802Z",
    "owner": "John Doe",
    "amountProfit": null,
    "amountWithdrawal": 1310.5,
    "amountOriginal": 1000,
    "status": "ACTIVE",
    "transactions": [
      {
        "tradeDate": "2020-10-01T00:00:00.000Z",
        "date": "2020-10-01T00:00:00.000Z",
        "description": "Aplicação Fondo de Investimento Premium",
        "quantity": 1.25,
        "value": 2,
        "amount": 5,
        "type": "BUY"
      }
    ]
  },
  {
    "id": "2a96b873-53bb-4d16-a3d8-385a57e78d7e",
    "number": null,
    "name": "CDB1194KL0Z - BANCO MAXIMA S/A",
    "balance": 2000,
    "currencyCode": "BRL",
    "type": "FIXED_INCOME",
    "subtype": "CDB",
    "itemId": "207f5bcd-312a-439c-abbe-166b6632c980",
    "code": "0001-02",
    "amount": 2500,
    "taxes": null,
    "taxes2": null,
    "date": "2020-07-19T18:27:41.802Z",
    "owner": "John Doe",
    "rate": 30,
    "rateType": "CDI",
    "fixedAnnualRate": 10.5,
    "amountProfit": null,
    "amountWithdrawal": 2000,
    "amountOriginal": 1000,
    "issuer": "Pluggy",
    "issueDate":"2020-07-19T18:27:41.802Z",
    "status": "ACTIVE"
  },
  {
    "id": "ded7d2f1-6b90-44a8-9ace-de747b9f5bfe",
    "number": "123456-2",
    "name": "Pluggy PREVIDENCIA",
    "balance": 1359.39,
    "currencyCode": "BRL",
    "type": "SECURITY",
    "subtype": "RETIREMENT",
    "annualRate": 3.24,
    "itemId": "207f5bcd-312a-439c-abbe-166b6632c980",
    "code": null,
    "value": 500,
    "quantity": 3,
    "amount": 1500,
    "taxes": 0,
    "taxes2": 0,
    "date": "2020-07-19T18:27:41.802Z",
    "owner": "John Doe",
    "amountProfit": 359.39,
    "amountWithdrawal": 1310.5,
    "status": "ACTIVE",
    "institution": {
      "name": "BANCO BTG PACTUAL S/A",
      "number": "30306294000145"
    }
  }
]

📘

See Investment in our API reference for more information.