Listar Investimentos

Lista todos os investimentos vinculados a um item específico.

Endpoint

Método e URL:

GET /v1/items/:itemId/investments

Parâmetros da URL:

• itemId (string, obrigatório): Identificador único do item

Campos da Resposta

• investments: Array contendo os investimentos
  • id: Identificador único do investimento
  • name: Nome do investimento
  • code: Código do investimento (no caso de fundos, o CNPJ do fundo). Pode ser null
  • number: Número do investimento. Pode ser null
  • type: Tipo/categoria do investimento (veja Tipos e Subtipos)
  • subtype: Subtipo do investimento. Pode ser null
  • status: Status do investimento (ACTIVE, PENDING, TOTAL_WITHDRAWAL, UNKNOWN)
  • rate: Taxa contratada (percentual). Pode ser null
  • rateType: Tipo/indexador da taxa (CDI, SELIC, DOLAR, EURO, IGPM, IPCA). Pode ser null
  • issuer: Emissor. Pode ser null
  • owner: Titular/dono do investimento. Pode ser null
  • isin: Identificador global ISIN. Pode ser null
  • lastMonthRate: Rentabilidade do último mês (percentual). Pode ser null
  • lastTwelveMonthsRate: Rentabilidade dos últimos 12 meses (percentual). Pode ser null
  • annualRate: Taxa anual (percentual). Pode ser null
  • amountOriginal: Valor originalmente investido. Pode ser null
  • amountProfit: Lucro líquido até o momento (pode ser negativo). Pode ser null
  • amountWithdrawal: Valor disponível para resgate. Pode ser null
  • currency: Código da moeda do investimento (ex: "BRL")
  • currentNetAmount: Valor líquido atual (descontados taxas e impostos)
  • currentGrossAmount: Valor bruto atual (com impostos). Pode ser null
  • currentDate: Data de referência da posição atual. Pode ser null
  • financialTaxes: Imposto financeiro aplicado. Pode ser null
  • incomeTaxes: Imposto de renda aplicado. Pode ser null
  • issuedAt: Data de emissão. Pode ser null
  • expiresAt: Data de vencimento. Pode ser null
  • updatedAt: Data da última atualização
  • createdAt: Data de criação

Resposta

Resposta de sucesso (200):

{
  "status": "success",
  "data": {
    "investments": [
      {
        "id": "uuid",
        "name": "string",
        "code": "string | null",
        "number": "string | null",
        "type": "FIXED_INCOME | SECURITY | MUTUAL_FUND | EQUITY | ETF | COE | OTHER",
        "subtype": "string | null",
        "status": "ACTIVE | PENDING | TOTAL_WITHDRAWAL | UNKNOWN",
        "rate": "string | null",
        "rateType": "CDI | SELIC | DOLAR | EURO | IGPM | IPCA | null",
        "issuer": "string | null",
        "owner": "string | null",
        "isin": "string | null",
        "lastMonthRate": "string | null",
        "lastTwelveMonthsRate": "string | null",
        "annualRate": "string | null",
        "amountOriginal": "string | null",
        "amountProfit": "string | null",
        "amountWithdrawal": "string | null",
        "currency": "string",
        "currentNetAmount": "string",
        "currentGrossAmount": "string | null",
        "currentDate": "timestamp | null",
        "financialTaxes": "string | null",
        "incomeTaxes": "string | null",
        "issuedAt": "timestamp | null",
        "expiresAt": "timestamp | null",
        "updatedAt": "timestamp",
        "createdAt": "timestamp"
      }
    ]
  }
}