# Listar investimentos

## ▶️ Uso

Com o método Listar Investimentos, você pode:

1. [Obrigatório] Listar investimentos relacionados a um link.id específico (usando o parâmetro de consulta link).
2. Obter os detalhes de um investment.id específico (usando o parâmetro de consulta id).

## 📖 Paginação

Este método retorna uma resposta paginada (padrão: 100 itens por página). Você pode usar o parâmetro de consulta page_size para aumentar o número de itens retornados até um máximo de 1000 itens. Você pode usar o parâmetro de consulta page para navegar pelos resultados. Para mais detalhes sobre como navegar pelas respostas paginadas da Belvo, consulte nosso artigo Dicas de Paginação.

## 🔦 Filtrando Respostas

Consulte a lista de consultas abaixo para ver uma lista de campos pelos quais você pode filtrar suas respostas. Para mais informações sobre como usar filtros, veja nosso artigo Filtrando respostas.

Endpoint: GET /api/br/investments/
Version: 1.223.0
Security: basicAuth

## Query parameters:

  - `link` (string, required)
    O link.id pelo qual você deseja filtrar.
    Example: "8848bd0c-9c7e-4f53-a732-ec896b11d4c4"

  - `page_size` (integer)
    Indica quantos resultados retornar por página. Por padrão, retornamos 100 resultados por página.

ℹ️ O número mínimo de resultados retornados por página é 1 e o máximo é 1000. Se você inserir um valor maior que 1000, nossa API usará o valor máximo por padrão (1000).
    Example: 100

  - `page` (integer)
    Um número de página dentro do conjunto de resultados paginados.
    Example: 1

  - `id` (string)
    Retorne informações apenas para este recurso id.
    Example: "24ccab1d-3a86-4136-a6eb-e04bf52b356f"

  - `id__in` (array)
    Retorne informações para esses ids de recurso.
    Example: ["6b3dea0f-be29-49d1-aabe-1a6d588642e6"]

  - `link__in` (array)
    Retorne resultados apenas para esses link.ids.
    Example: ["5722d0ba-69d7-42dc-8ff5-33767b83c5d6"]

  - `omit` (string)
    Omitir certos campos de serem retornados na resposta. Para mais informações, consulte nosso artigo Filtrando respostas no DevPortal.

  - `fields` (string)
    Retorne apenas os campos especificados na resposta. Para mais informações, consulte nosso artigo no DevPortal Filtrando respostas.

  - `type` (string)
    Retorne investimentos com este tipo. Pode ser BANCARIA, CREDITO, VARIABLE, FUND ou BOND.
    Example: "VARIABLE"

  - `type__in` (array)
    Retorno de investimentos deste tipo. Pode ser BANCARIA, CREDITO, VARIABLE, FUND ou BOND.
    Example: ["VARIABLE"]

  - `created_at` (string)
    Retorne itens que foram atualizados pela última vez no banco de dados da Belvo nesta data (no formato YYYY-MM-DD).
    Example: "2022-05-05"

  - `created_at__gt` (string)
    Retorne itens que foram atualizados pela última vez no banco de dados da Belvo após esta data (no formato YYYY-MM-DD).
    Example: "2022-05-05"

  - `created_at__gte` (string)
    Retorne itens que foram atualizados pela última vez no banco de dados da Belvo após ou nesta data (no formato YYYY-MM-DD).
    Example: "2022-05-04"

  - `created_at__lt` (string)
    Retorne itens que foram atualizados pela última vez no banco de dados da Belvo antes desta data (no formato YYYY-MM-DD).
    Example: "2022-04-01"

  - `created_at__lte` (string)
    Retorne itens que foram atualizados pela última vez no banco de dados da Belvo antes ou na data especificada (no formato YYYY-MM-DD).
    Example: "2022-03-30"

  - `created_at__range` (array)
    Retorne contas que foram atualizadas pela última vez no banco de dados do Belvo entre duas datas (no formato YYYY-MM-DD). O primeiro valor indica o início do intervalo e o segundo valor indica o final do intervalo.
    Example: ["2022-01-01","2022-12-31"]

## Response 200 fields (application/json):

  - `count` (integer)
    O número total de resultados na sua conta Belvo.
    Example: 130

  - `next` (string,null)
    A URL para a próxima página de resultados. Cada página consiste em até 100 itens. Se não houver resultados suficientes para uma página adicional, o valor será null.

Em nosso exemplo de documentação, usamos {endpoint} como um valor de espaço reservado. Em produção, esse valor será substituído pelo endpoint real que você está usando atualmente (por exemplo, accounts ou owners).
    Example: "https://sandbox.belvo.com/api/{endpoint}/?link=1bd948f7-245d-4313-b604-34d1044cb908page=2"

  - `previous` (string,null)
    A URL para a página anterior de resultados. Se não houver uma página anterior, o valor será null.

  - `results` (array)
    Array de objetos de investimento.

  - `results.id` (string)
    O identificador único criado pela Belvo usado para referenciar o investimento atual.
    Example: "5359ddc5-31fc-4346-934b-cc24630a8d06"

  - `results.type` (string)
    O tipo de investimento: Pode ser

  - FIXED_INCOME_BANKING (Renda Fixa Bancária)
  - FIXED_INCOME_CREDIT (Renda Fixa Crédito)
  - VARIABLE_INCOME (Renda Variável)
  - TREASURY_BOND (Tesouro Direto)
  - INVESTMENT_FUND (Fundos de Investimento)
    Example: "FIXED_INCOME_BANKING"

  - `results.issuer_id_number` (string,null)
    O número do CNPJ da instituição emissora. Para Fundos de Investimento, este é o CNPJ do fundo.

> 🚧 Não aplicável para investimentos TREASURY_BOND.
    Example: "10187609364567"

  - `results.isin_number` (string,null)
    O Número de Identificação de Valores Mobiliários Internacional (ISIN) ISO-6166 para o instrumento financeiro.
    Example: "BRCST4CTF001"

  - `results.currency` (string)
    O código de moeda de três letras (ISO-4217) do investimento. Por exemplo, BRL para Real Brasileiro.
    Example: "BRL"

  - `results.product_name` (string)
    O nome do produto de investimento.

- Para FIXED_INCOME_BANKING, pode ser: CDB, RDB, LCI ou LCA.
- Para FIXED_INCOME_CREDIT, pode ser: DEBÊNTURES, CRI ou CRA.
- Para INVESTMENT_FUND, será o nome do fundo. Por exemplo: CONSTELLATION MASTER FIA
- Para TREASURY_BOND, será o nome do título. Por exemplo: Tesouro Selic 2025.
- Para VARIABLE_INCOME_INCOME, será o nome da ação. Por exemplo, AAPL.
    Example: "CONSTELLATION MASTER FIA"

  - `results.is_tax_exempt` (boolean)
    Indica se o investimento é isento de impostos.

> 🚧 Aplicável apenas para investimentos FIXED_INCOME_CREDIT.

  - `results.clearing_code` (string,null)
    O código de compensação do investimento.

> 🚧 Aplicável apenas para FIXED_INCOME_BANKING e FIXED_INCOME_CREDIT.
    Example: "CDB421GPXXX"

  - `results.due_date` (string,null)
    A data de vencimento do instrumento financeiro.

> 🚧 Aplicável apenas para investimentos FIXED_INCOME_BANKING, FIXED_INCOME_CREDIT e TREASURY_BOND.
    Example: "2022-01-01"

  - `results.issue_date` (string,null)
    A data em que o instrumento financeiro foi emitido.

> 🚧 Aplicável apenas para FIXED_INCOME_BANKING e FIXED_INCOME_CREDIT.
    Example: "2021-01-01"

  - `results.purchase_date` (string,null)
    A data em que o instrumento financeiro foi adquirido.

> 🚧 Aplicável apenas para investimentos FIXED_INCOME_BANKING, FIXED_INCOME_CREDIT e TREASURY_BOND.
    Example: "2021-01-01"

  - `results.grace_period_date` (string,null)
    A data do período de carência do instrumento financeiro.

> 🚧 Aplicável apenas para FIXED_INCOME_BANKING e FIXED_INCOME_CREDIT.
    Example: "2021-01-01"

  - `results.issue_unit_price` (number,null)
    O preço unitário do instrumento financeiro no momento da emissão.

> 🚧 Aplicável apenas para FIXED_INCOME_BANKING e FIXED_INCOME_CREDIT.
    Example: 1000

  - `results.balance` (object)
    O saldo do instrumento de investimento, na data de reference_date.

  - `results.balance.reference_date` (string)
    A data e hora em que o saldo foi calculado para o instrumento de investimento, no formato YYYY-MM-DDTHH:MM:SSZ.
    Example: "2022-07-21T17:32:00Z"

  - `results.balance.gross_value` (number)
    O valor bruto do instrumento de investimento.
    Example: 1000

  - `results.balance.blocked_amount` (number)
    O montante do instrumento de investimento que está bloqueado ou indisponível para transações.
    Example: 100

  - `results.balance.quantity` (number)
    O número de unidades, cotas ou ativos mantidos na data de referência.
    Example: 100

  - `results.balance.gross_unit_price` (number,null)
    O valor bruto unitário atual do investimento na data de referência
    Example: 10

  - `results.balance.net_value` (number,null)
    O valor líquido do investimento após deduções de impostos, taxas e outros encargos, na data de referência.
    Example: 900

  - `results.balance.withheld_amount` (number,null)
    O valor do instrumento de investimento que foi retido ou deduzido do valor líquido.
    Example: 10

  - `results.balance.transaction_fee` (number,null)
    As taxas e impostos cobrados pela transação.
    Example: 5

  - `results.balance.purchase_unit_price` (number,null)
    O preço unitário no momento da compra do título ou ativo.
    Example: 10

  - `results.balance.pre_fixed_rate` (number,null)
    A taxa de remuneração prefixada para o produto de renda.
    Example: 0.05

  - `results.balance.post_fixed_rate` (number,null)
    A porcentagem do indexador pós-fixado para o produto de renda.
    Example: 0.05

  - `results.balance.penalty_fee` (number,null)
    A penalidade (multa) por atrasos nos pagamentos, conforme definido no contrato.
    Example: 10

  - `results.balance.late_payment_fee` (number,null)
    Os juros cobrados por pagamentos atrasados.
    Example: 10

  - `results.balance.closing_price` (number,null)
    O preço de fechamento do investimento na data de referência.
    Example: 10

  - `results.balance.unit_price_factor` (number,null)
    O fator usado para calcular o preço unitário.
    Example: 1

  - `results.remuneration` (object)
    Os detalhes de remuneração do instrumento de investimento.

  - `results.remuneration.pre_fixed_rate` (number,null)
    A taxa de juros fixa definida na emissão, expressa como um decimal (por exemplo, 0.150000 representa 15%).
    Example: 0.05

  - `results.remuneration.post_fixed_rate` (number,null)
    A taxa de juros pós-fixada definida na emissão, expressa como um decimal (por exemplo, 0.150000 representa 15%).
    Example: 0.05

  - `results.remuneration.rate_type` (string,null)
    O tipo de taxa de remuneração aplicada ao instrumento financeiro. Pode ser:
  - LINEAR
  - EXPONENCIAL
    Example: "LINEAR"

  - `results.remuneration.rate_periodicity` (string,null)
    A frequência com que a taxa de remuneração é aplicada ao instrumento financeiro. Pode ser:
  - DIARIO
  - MENSAL
  - ANUAL
  - SEMESTRAL
    Example: "MENSAL"

  - `results.remuneration.calculation_base` (string,null)
    Indica se o cálculo de remuneração ou juros é baseado em dias úteis (dias úteis) ou dias corridos (dias corridos).
- DIAS_UTEIS
  - DIAS_CORRIDOS
    Example: "DIAS_CORRIDOS"

  - `results.remuneration.indexer` (string,null)
    O índice usado como referência para calcular a rentabilidade ou retornos do instrumento financeiro. Pode ser um dos seguintes:
  - CDI 
  - DI 
  - TR 
  - IPCA 
  - IGP_M 
  - IGP_DI 
  - INPC 
  - BCP 
  - TLC 
  - SELIC 
  - PRE_FIXADO 
  - OUTROS
    Example: "CDI"

  - `results.remuneration.indexer_additional_info` (string,null)
    Informações adicionais sobre a taxa do indexer. Necessário quando indexer está definido como OUTROS.
    Example: "IPCA + 5%"

  - `results.classification_details` (object,null)
    Os detalhes de classificação do instrumento de investimento.

> 🚧 Aplicável apenas para investimentos do tipo INVESTMENT_FUND.
>
> Este objeto é aplicável apenas para investimentos do tipo INVESTMENT_FUND. Para todos os outros tipos de investimento, este objeto será null.

  - `results.classification_details.category` (string,null)
    A categoria do fundo de investimento, conforme definido pelos padrões de classificação da ANBIMA. Pode ser uma das seguintes:
  - RENDA_FIXA
  - ACOES
  - MULTIMERCADO
  - CAMBIAL
    Example: "ACOES"

  - `results.classification_details.class` (string,null)
    A classe dentro da categoria do fundo de investimento, conforme definido pelos padrões de classificação da ANBIMA.
    Example: "Ações Livre"

  - `results.classification_details.subclass` (string,null)
    A subclasse do fundo de investimento, conforme definido pelos padrões de classificação da ANBIMA.
    Example: "Ações Livre"

  - `results.voucher_payment_details` (object)
    Os detalhes do pagamento do voucher (também conhecido como pagamentos de cupom) do instrumento de investimento.

> 🚧 Aplicável apenas para investimentos do tipo FIXED_INCOME_CREDIT e TREASURY_BOND.
>
> Este objeto é aplicável apenas para investimentos do tipo FIXED_INCOME_CREDIT e TREASURY_BOND. Para todos os outros tipos de investimento, este objeto será null.

  - `results.voucher_payment_details.is_voucher_payment` (boolean)
    Indica se o instrumento financeiro paga juros periódicos (pagamentos de cupom).
    Example: true

  - `results.voucher_payment_details.periodicity` (string,null)
    A frequência com que os pagamentos de voucher são realizados. Necessário quando is_voucher_payment está definido como true. Pode ser um dos seguintes:
  - MENSAL 
  - TRIMESTRAL 
  - SEMESTRAL 
  - ANUAL 
  - IRREGULAR 
  - OUTROS
    Example: "MENSAL"

  - `results.voucher_payment_details.periodicity_additional_info` (string,null)
    Informações adicionais sobre a periodicidade do pagamento do voucher. Obrigatório quando periodicity está definido como OUTROS.
    Example: "30/360"

  - `results.debtor_details` (object,null)
    Os detalhes do devedor do instrumento de investimento.

> 🚧 Aplicável apenas para investimentos do tipo FIXED_INCOME_CREDIT.
>
> Este objeto é aplicável apenas para investimentos do tipo FIXED_INCOME_CREDIT. Para todos os outros tipos de investimento, este objeto será null.

  - `results.debtor_details.name` (string)
    O nome do devedor.
    Example: "Roberto Marino"

  - `results.debtor_details.id_document_number` (string)
    O número do documento de identificação do devedor (CNPJ).
    Example: 12345678901

## Response 403 fields (application/json):

  - `code` (string)
    Um código de erro único (access_to_resource_denied) que permite classificar e tratar o erro programaticamente.

ℹ️ Consulte nosso DevPortal para mais informações sobre como lidar com 403 access_to_resource_denied.
    Example: "access_to_resource_denied"

  - `message` (string)
    Uma breve descrição do erro.

Para erros access_to_resource_denied, a descrição é:

  - You don't have access to this resource..
    Example: "You don't have access to this resource."

  - `request_id` (string)
    Um ID único de 32 caracteres da solicitação (correspondente a um padrão regex de: [a-f0-9]{32}). Forneça este ID ao entrar em contato com a equipe de suporte da Belvo para acelerar as investigações.
    Example: "9e7b283c6efa449c9c028a16b5c249fb"

## Response 404 fields (application/json):

  - `code` (string)
    Um código de erro único (not_found) que permite classificar e lidar com o erro programaticamente.
    Example: "not_found"

  - `message` (string)
    Uma breve descrição do erro.

Para erros not_found, a descrição é:

  - Not found
    Example: "Not found"

  - `request_id` (string)
    Um ID único de 32 caracteres da solicitação (correspondente a um padrão regex de: [a-f0-9]{32}). Forneça este ID ao entrar em contato com a equipe de suporte da Belvo para acelerar as investigações.
    Example: "9e7b283c6efa449c9c028a16b5c249fb"

## Response 408 fields (application/json):

  - `code` (string)
    Um código de erro único (request_timeout) que permite classificar e lidar com o erro programaticamente.

ℹ️ Consulte nosso DevPortal para mais informações sobre como lidar com erros 408 request_timeout.
    Example: "request_timeout"

  - `message` (string)
    Uma breve descrição do erro.

Para erros de request_timeout, a descrição é:

  - The request timed out, you can retry asking for less data by changing your query parameters.
    Example: "The request timed out, you can retry asking for less data by changing your query parameters"

  - `request_id` (string)
    Um ID único de 32 caracteres da solicitação (correspondente a um padrão regex de: [a-f0-9]{32}). Forneça este ID ao entrar em contato com a equipe de suporte da Belvo para acelerar as investigações.
    Example: "9e7b283c6efa449c9c028a16b5c249fb"

## Response 500 fields (application/json):

  - `code` (string)
    Um código de erro único (unexpected_error) que permite classificar e tratar o erro de forma programática.

ℹ️ Consulte nosso DevPortal para mais informações sobre como lidar com erros 500 unexpected_error.
    Example: "unexpected_error"

  - `message` (string)
    Uma breve descrição do erro.

Para erros unexpected_error, a descrição é:

  - Belvo não consegue processar a solicitação devido a um problema interno do sistema ou a uma resposta não suportada de uma instituição.
    Example: "Belvo is unable to process the request due to an internal system issue or to an unsupported response from an institution"

  - `request_id` (string)
    Um ID único de 32 caracteres da solicitação (correspondente a um padrão regex de: [a-f0-9]{32}). Forneça este ID ao entrar em contato com a equipe de suporte da Belvo para acelerar as investigações.
    Example: "9e7b283c6efa449c9c028a16b5c249fb"