v1

latestOpenAPI 3.1.0MIT2026-07-2484155300.5 KB
Investment

List

Recovers all investments collected for the item provided

get/investments

Query parameters

itemIdstring uuid required

Item's primary identifier

type'COE' | 'EQUITY' | 'ETF' | 'FIXED_INCOME' | 'MUTUAL_FUND' | 'SECURITY' | 'OTHER'

Investment's type to filter

pageSizenumber double

Page size for the paging request, default: 500

pagenumber double

Page number for the paging request, default: 1

Response

Retrieve a list of all investments

pagenumber double
totalnumber double
totalPagesnumber double

Example response

{
  "results": [
    {
      "id": "f77eccf4-7714-498e-92a9-1bebe70335d9",
      "code": "12.345.678/0001-00",
      "name": "Bahia AM Advisory FIC de FIM",
      "balance": 1359.39,
      "currencyCode": "BRL",
      "type": "MUTUAL_FUND",
      "subtype": "MULTIMARKET_FUND",
      "lastMonthRate": 0.24,
      "annualRate": 3.24,
      "lastTwelveMonthsRate": 3,
      "itemId": "207f5bcd-312a-439c-abbe-166b6632c980",
      "value": 500,
      "quantity": 3,
      "amount": 1500,
      "taxes": 40.61,
      "taxes2": 100,
      "date": "2020-07-19T18:27:41.802Z",
      "owner": "John Doe",
      "number": null,
      "amountProfit": 310.5,
      "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",
          "movementType": "CREDIT"
        }
      ]
    }
  ]
}