# Lista de inversiones

## ▶️ Uso

Con el método List Investments, puedes:

1. [Requerido] Listar inversiones relacionadas con un link.id específico (usando el parámetro de consulta link).
2. Obtener los detalles de un investment.id específico (usando el parámetro de consulta id).

## 📖 Paginación

Este método devuelve una respuesta paginada (por defecto: 100 elementos por página). Puedes usar el parámetro de consulta page_size para aumentar el número de elementos devueltos hasta un máximo de 1000 elementos. Puedes usar el parámetro de consulta page para navegar a través de los resultados. Para más detalles sobre cómo navegar por las respuestas paginadas de Belvo, consulta nuestro artículo Consejos de Paginación.

## 🔦 Filtrado de Respuestas

Consulta la lista de campos a continuación para ver los campos por los que puedes filtrar tus respuestas. Para más información sobre cómo usar filtros, consulta nuestro artículo Filtrando respuestas.

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

## Query parameters:

  - `link` (string, required)
    El link.id por el que deseas filtrar.
    Example: "8848bd0c-9c7e-4f53-a732-ec896b11d4c4"

  - `page_size` (integer)
    Indica cuántos resultados devolver por página. Por defecto, devolvemos 100 resultados por página.

ℹ️ El número mínimo de resultados devueltos por página es 1 y el máximo es 1000. Si introduces un valor mayor que 1000, nuestra API usará por defecto el valor máximo (1000).
    Example: 100

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

  - `id` (string)
    Devuelve información solo para este recurso id.
    Example: "24ccab1d-3a86-4136-a6eb-e04bf52b356f"

  - `id__in` (array)
    Devuelve información para estos ids de recursos.
    Example: ["6b3dea0f-be29-49d1-aabe-1a6d588642e6"]

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

  - `omit` (string)
    Omite ciertos campos para que no se devuelvan en la respuesta. Para más información, consulta nuestro artículo del DevPortal Filtrando respuestas.

  - `fields` (string)
    Devuelve solo los campos especificados en la respuesta. Para obtener más información, consulta nuestro artículo del DevPortal Filtrando respuestas.

  - `type` (string)
    Devuelve inversiones con este tipo. Puede ser BANCARIA, CREDITO, VARIABLE, FUND o BOND.
    Example: "VARIABLE"

  - `type__in` (array)
    Devolución de inversiones de este tipo. Puede ser BANCARIA, CREDITO, VARIABLE, FUND o BOND.
    Example: ["VARIABLE"]

  - `created_at` (string)
    Devuelve los elementos que se actualizaron por última vez en la base de datos de Belvo en esta fecha (en formato YYYY-MM-DD).
    Example: "2022-05-05"

  - `created_at__gt` (string)
    Devuelve los elementos que se actualizaron por última vez en la base de datos de Belvo después de esta fecha (en formato YYYY-MM-DD).
    Example: "2022-05-05"

  - `created_at__gte` (string)
    Devuelve los elementos que se actualizaron por última vez en la base de datos de Belvo después o en esta fecha (en formato YYYY-MM-DD).
    Example: "2022-05-04"

  - `created_at__lt` (string)
    Devuelve los elementos que se actualizaron por última vez en la base de datos de Belvo antes de esta fecha (en formato YYYY-MM-DD).
    Example: "2022-04-01"

  - `created_at__lte` (string)
    Devuelve los elementos que se actualizaron por última vez en la base de datos de Belvo antes o en esta fecha (en formato YYYY-MM-DD).
    Example: "2022-03-30"

  - `created_at__range` (array)
    Devolver cuentas que fueron actualizadas por última vez en la base de datos de Belvo entre dos fechas (en formato YYYY-MM-DD). El primer valor indica el inicio del rango y el segundo valor indica el final del rango.
    Example: ["2022-01-01","2022-12-31"]

## Response 200 fields (application/json):

  - `count` (integer)
    El número total de resultados en tu cuenta de Belvo.
    Example: 130

  - `next` (string,null)
    La URL a la siguiente página de resultados. Cada página consta de hasta 100 elementos. Si no hay suficientes resultados para una página adicional, el valor es null.

En nuestro ejemplo de documentación, usamos {endpoint} como un valor de marcador de posición. En producción, este valor será reemplazado por el endpoint real que estás utilizando actualmente (por ejemplo, accounts o owners).
    Example: "https://sandbox.belvo.com/api/{endpoint}/?link=1bd948f7-245d-4313-b604-34d1044cb908page=2"

  - `previous` (string,null)
    La URL a la página anterior de resultados. Si no hay una página anterior, el valor es null.

  - `results` (array)
    Matriz de objetos de inversión.

  - `results.id` (string)
    El identificador único creado por Belvo utilizado para referenciar la inversión actual.
    Example: "5359ddc5-31fc-4346-934b-cc24630a8d06"

  - `results.type` (string)
    El tipo de inversión: Puede 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)
    El número de CNPJ de la institución emisora. Para los Fondos de Inversión, este es el CNPJ del fondo.

> 🚧 No aplicable para inversiones en TREASURY_BOND.
    Example: "10187609364567"

  - `results.isin_number` (string,null)
    El Número de Identificación de Valores Internacionales ISO-6166 (ISIN) para el instrumento financiero.
    Example: "BRCST4CTF001"

  - `results.currency` (string)
    El código de moneda de tres letras (ISO-4217) de la inversión. Por ejemplo, BRL para el Real Brasileño.
    Example: "BRL"

  - `results.product_name` (string)
    El nombre del producto de inversión.

- Para FIXED_INCOME_BANKING, puede ser: CDB, RDB, LCI o LCA.
- Para FIXED_INCOME_CREDIT, puede ser: DEBENTURES, CRI o CRA.
- Para INVESTMENT_FUND, será el nombre del fondo. Por ejemplo: CONSTELLATION MASTER FIA
- Para TREASURY_BOND, será el nombre del bono. Por ejemplo: Tesouro Selic 2025.
- Para VARIABLE_INCOME_INCOME, será el nombre de la acción. Por ejemplo AAPL.
    Example: "CONSTELLATION MASTER FIA"

  - `results.is_tax_exempt` (boolean)
    Indica si la inversión está exenta de impuestos.

> 🚧 Solo aplicable para inversiones de tipo FIXED_INCOME_CREDIT.

  - `results.clearing_code` (string,null)
    El código de compensación de la inversión.

> 🚧 Solo aplicable para FIXED_INCOME_BANKING y FIXED_INCOME_CREDIT.
    Example: "CDB421GPXXX"

  - `results.due_date` (string,null)
    La fecha de vencimiento del instrumento financiero.

> 🚧 Solo aplicable para inversiones en FIXED_INCOME_BANKING, FIXED_INCOME_CREDIT y TREASURY_BOND.
    Example: "2022-01-01"

  - `results.issue_date` (string,null)
    La fecha en que se emitió el instrumento financiero.

> 🚧 Solo aplicable para FIXED_INCOME_BANKING y FIXED_INCOME_CREDIT.
    Example: "2021-01-01"

  - `results.purchase_date` (string,null)
    La fecha en que se adquirió el instrumento financiero.

> 🚧 Solo aplicable para inversiones en FIXED_INCOME_BANKING, FIXED_INCOME_CREDIT y TREASURY_BOND.
    Example: "2021-01-01"

  - `results.grace_period_date` (string,null)
    La fecha del período de gracia del instrumento financiero.

> 🚧 Solo aplicable para FIXED_INCOME_BANKING y FIXED_INCOME_CREDIT.
    Example: "2021-01-01"

  - `results.issue_unit_price` (number,null)
    El precio unitario del instrumento financiero en el momento de la emisión.

> 🚧 Solo aplicable para FIXED_INCOME_BANKING y FIXED_INCOME_CREDIT.
    Example: 1000

  - `results.balance` (object)
    El saldo del instrumento de inversión, a partir de la reference_date.

  - `results.balance.reference_date` (string)
    La fecha y hora en que se calculó el saldo para el instrumento de inversión, en formato YYYY-MM-DDTHH:MM:SSZ.
    Example: "2022-07-21T17:32:00Z"

  - `results.balance.gross_value` (number)
    El valor bruto del instrumento de inversión.
    Example: 1000

  - `results.balance.blocked_amount` (number)
    La cantidad del instrumento de inversión que está bloqueada o no disponible para transacciones.
    Example: 100

  - `results.balance.quantity` (number)
    El número de unidades, cuotas o activos mantenidos en la fecha de referencia.
    Example: 100

  - `results.balance.gross_unit_price` (number,null)
    El valor bruto unitario actual de la inversión en la fecha de referencia
    Example: 10

  - `results.balance.net_value` (number,null)
    El valor neto de la inversión después de deducciones por impuestos, tarifas y otros cargos, a la fecha de referencia.
    Example: 900

  - `results.balance.withheld_amount` (number,null)
    La cantidad del instrumento de inversión que ha sido retenida o deducida del valor neto.
    Example: 10

  - `results.balance.transaction_fee` (number,null)
    Las tarifas e impuestos cobrados por la transacción.
    Example: 5

  - `results.balance.purchase_unit_price` (number,null)
    El precio unitario en el momento de la compra del valor o activo.
    Example: 10

  - `results.balance.pre_fixed_rate` (number,null)
    La tasa de remuneración prefijada para el producto de ingresos.
    Example: 0.05

  - `results.balance.post_fixed_rate` (number,null)
    El porcentaje del indexador post-fijado para el producto de ingresos.
    Example: 0.05

  - `results.balance.penalty_fee` (number,null)
    La penalización (multa) por retrasos en los pagos, tal como se define en el contrato.
    Example: 10

  - `results.balance.late_payment_fee` (number,null)
    El interés cobrado por pagos atrasados.
    Example: 10

  - `results.balance.closing_price` (number,null)
    El precio de cierre de la inversión en la fecha de referencia.
    Example: 10

  - `results.balance.unit_price_factor` (number,null)
    El factor utilizado para calcular el precio unitario.
    Example: 1

  - `results.remuneration` (object)
    Los detalles de la remuneración del instrumento de inversión.

  - `results.remuneration.pre_fixed_rate` (number,null)
    La tasa de interés fija definida en la emisión, expresada como un decimal (por ejemplo, 0.150000 representa el 15%).
    Example: 0.05

  - `results.remuneration.post_fixed_rate` (number,null)
    La tasa de interés post-fijada definida en la emisión, expresada como un decimal (por ejemplo, 0.150000 representa el 15%).
    Example: 0.05

  - `results.remuneration.rate_type` (string,null)
    El tipo de tasa de remuneración aplicada al instrumento financiero. Puede ser:
  - LINEAR
  - EXPONENCIAL
    Example: "LINEAR"

  - `results.remuneration.rate_periodicity` (string,null)
    La frecuencia con la que se aplica la tasa de remuneración al instrumento financiero. Puede ser:
  - DIARIO
  - MENSAL
  - ANUAL
  - SEMESTRAL
    Example: "MENSAL"

  - `results.remuneration.calculation_base` (string,null)
    Indica si el cálculo de la remuneración o de los intereses se basa en días hábiles (dias úteis) o días calendario (dias corridos).
- DIAS_UTEIS
  - DIAS_CORRIDOS
    Example: "DIAS_CORRIDOS"

  - `results.remuneration.indexer` (string,null)
    El índice utilizado como referencia para calcular la rentabilidad o los rendimientos del instrumento financiero. Puede ser uno de los siguientes:
  - CDI 
  - DI 
  - TR 
  - IPCA 
  - IGP_M 
  - IGP_DI 
  - INPC 
  - BCP 
  - TLC 
  - SELIC 
  - PRE_FIXADO 
  - OUTROS
    Example: "CDI"

  - `results.remuneration.indexer_additional_info` (string,null)
    Información adicional sobre la tasa de indexer. Requerido cuando indexer está configurado en OUTROS.
    Example: "IPCA + 5%"

  - `results.classification_details` (object,null)
    Los detalles de clasificación del instrumento de inversión.

> 🚧 Solo aplicable para inversiones de tipo INVESTMENT_FUND.
>
> Este objeto solo es aplicable para inversiones de tipo INVESTMENT_FUND. Para todos los demás tipos de inversión, este objeto será null.

  - `results.classification_details.category` (string,null)
    La categoría del fondo de inversión, según los estándares de clasificación de ANBIMA. Puede ser una de las siguientes:
  - RENDA_FIXA
  - ACOES
  - MULTIMERCADO
  - CAMBIAL
    Example: "ACOES"

  - `results.classification_details.class` (string,null)
    La clase dentro de la categoría del fondo de inversión, según los estándares de clasificación de ANBIMA.
    Example: "Ações Livre"

  - `results.classification_details.subclass` (string,null)
    La subclase del fondo de inversión, según los estándares de clasificación de ANBIMA.
    Example: "Ações Livre"

  - `results.voucher_payment_details` (object)
    Los detalles del pago del voucher (también conocido como pagos de cupón) del instrumento de inversión.

> 🚧 Solo aplicable para inversiones de tipo FIXED_INCOME_CREDIT y TREASURY_BOND.
>
> Este objeto solo es aplicable para inversiones de tipo FIXED_INCOME_CREDIT y TREASURY_BOND. Para todos los demás tipos de inversión, este objeto será null.

  - `results.voucher_payment_details.is_voucher_payment` (boolean)
    Indica si el instrumento financiero paga intereses periódicos (pagos de cupones).
    Example: true

  - `results.voucher_payment_details.periodicity` (string,null)
    La frecuencia con la que se realizan los pagos del voucher. Requerido cuando is_voucher_payment está configurado como true. Puede ser uno de los siguientes:
  - MENSAL 
  - TRIMESTRAL 
  - SEMESTRAL 
  - ANUAL 
  - IRREGULAR 
  - OUTROS
    Example: "MENSAL"

  - `results.voucher_payment_details.periodicity_additional_info` (string,null)
    Información adicional sobre la periodicidad del pago del vale. Requerido cuando periodicity está configurado como OUTROS.
    Example: "30/360"

  - `results.debtor_details` (object,null)
    Los detalles del deudor del instrumento de inversión.

> 🚧 Solo aplicable para inversiones de tipo FIXED_INCOME_CREDIT.
>
> Este objeto solo es aplicable para inversiones de tipo FIXED_INCOME_CREDIT. Para todos los demás tipos de inversión, este objeto será null.

  - `results.debtor_details.name` (string)
    El nombre del deudor.
    Example: "Roberto Marino"

  - `results.debtor_details.id_document_number` (string)
    El número del documento de identificación del deudor (CNPJ).
    Example: 12345678901

## Response 403 fields (application/json):

  - `code` (string)
    Un código de error único (access_to_resource_denied) que te permite clasificar y manejar el error de manera programática.

ℹ️ Consulta nuestro DevPortal para obtener más información sobre cómo manejar 403 access_to_resource_denied.
    Example: "access_to_resource_denied"

  - `message` (string)
    Una breve descripción del error.

Para los errores access_to_resource_denied, la descripción es:

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

  - `request_id` (string)
    Un ID único de 32 caracteres de la solicitud (que coincide con un patrón regex de: [a-f0-9]{32}). Proporcione este ID al contactar al equipo de soporte de Belvo para acelerar las investigaciones.
    Example: "9e7b283c6efa449c9c028a16b5c249fb"

## Response 404 fields (application/json):

  - `code` (string)
    Un código de error único (not_found) que te permite clasificar y manejar el error de manera programática.
    Example: "not_found"

  - `message` (string)
    Una breve descripción del error.

Para errores not_found, la descripción es:

  - Not found
    Example: "Not found"

  - `request_id` (string)
    Un ID único de 32 caracteres de la solicitud (que coincide con un patrón regex de: [a-f0-9]{32}). Proporcione este ID al contactar al equipo de soporte de Belvo para acelerar las investigaciones.
    Example: "9e7b283c6efa449c9c028a16b5c249fb"

## Response 408 fields (application/json):

  - `code` (string)
    Un código de error único (request_timeout) que te permite clasificar y manejar el error de manera programática.

ℹ️ Consulta nuestro DevPortal para obtener más información sobre cómo manejar errores 408 request_timeout.
    Example: "request_timeout"

  - `message` (string)
    Una breve descripción del error.

Para los errores de request_timeout, la descripción es:

  - 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)
    Un ID único de 32 caracteres de la solicitud (que coincide con un patrón regex de: [a-f0-9]{32}). Proporcione este ID al contactar al equipo de soporte de Belvo para acelerar las investigaciones.
    Example: "9e7b283c6efa449c9c028a16b5c249fb"

## Response 500 fields (application/json):

  - `code` (string)
    Un código de error único (unexpected_error) que te permite clasificar y manejar el error de manera programática.

ℹ️ Consulta nuestro DevPortal para obtener más información sobre cómo manejar errores 500 unexpected_error.
    Example: "unexpected_error"

  - `message` (string)
    Una breve descripción del error.

Para los errores unexpected_error, la descripción es:

- Belvo no puede procesar la solicitud debido a un problema interno del sistema o a una respuesta no soportada de una institución.
    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)
    Un ID único de 32 caracteres de la solicitud (que coincide con un patrón regex de: [a-f0-9]{32}). Proporcione este ID al contactar al equipo de soporte de Belvo para acelerar las investigaciones.
    Example: "9e7b283c6efa449c9c028a16b5c249fb"