# Recuperar inversiones para un enlace

Recuperar inversiones para un enlace existente.

Endpoint: POST /api/br/investment-transactions/
Version: 1.223.0
Security: basicAuth

## Query parameters:

  - `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.

## Request fields (application/json):

  - `link` (string, required)
    El link.id para el que deseas recuperar información.
    Example: "c81a1dea-6dd6-4999-8b9f-541ee8197058"

  - `date_from` (string)
    La fecha desde la cual deseas comenzar a obtener datos, en formato YYYY-MM-DD.

⚠️ El valor de date_from no puede ser mayor que date_to.
    Example: "2020-08-05"

  - `date_to` (string)
    La fecha en la que deseas dejar de recibir datos, en formato YYYY-MM-DD.

⚠️ El valor de date_to no puede ser mayor que la fecha de hoy (en otras palabras, no se permiten fechas futuras).
    Example: "2020-10-05"

  - `save_data` (boolean)
    Indica si se debe o no persistir los datos en Belvo. Por defecto, esto está configurado en true y devolvemos una respuesta 201 Created.

Cuando se establece en false, los datos no se persistirán y devolvemos una respuesta 200 OK.
    Example: true

## Response 200 fields (application/json):

  - `id` (string)
    Identificador único de Belvo para el elemento actual.
    Example: "0d3ffb69-f83b-456e-ad8e-208d0998d71d"

  - `link` (string,null)
    El link.id al que pertenecen los datos.
    Example: "30cb4806-6e00-48a4-91c9-ca55968576c8"

  - `collected_at` (string)
    La marca de tiempo ISO-8601 cuando se recopiló el punto de datos.
    Example: "2022-02-09T08:45:50.406032Z"

  - `created_at` (string)
    La marca de tiempo ISO-8601 de cuando se creó el punto de datos en la base de datos de Belvo.
    Example: "2022-02-09T08:45:50.406032Z"

  - `investment` (object)

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

  - `investment.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"

  - `investment.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"

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

  - `investment.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"

  - `investment.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"

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

> 🚧 Solo aplicable para inversiones de tipo FIXED_INCOME_CREDIT.

  - `investment.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"

  - `investment.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"

  - `investment.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"

  - `investment.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"

  - `investment.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"

  - `investment.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

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

  - `investment.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"

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

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

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

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

  - `investment.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

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

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

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

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

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

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

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

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

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

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

  - `investment.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

  - `investment.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

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

  - `investment.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"

  - `investment.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"

  - `investment.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"

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

  - `investment.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.

  - `investment.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"

  - `investment.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"

  - `investment.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"

  - `investment.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.

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

  - `investment.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"

  - `investment.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"

  - `investment.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.

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

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

  - `internal_identification` (string)
    La identificación interna de la institución de la transacción de inversión.
    Example: "ABCD2126019929279212650822221989319253344"

  - `value_date` (string)
    La fecha en la que se liquidó la transacción, en formato YYYY-MM-DD.

> 📘 VARIABLE_INCOME
>
> Para inversiones de VARIABLE_INCOME, solo recibirás transacciones hasta la última fecha de negociación. Por ejemplo, si hoy es 19.11.2024, solo recibirás transacciones hasta el 18.11.2024.

> 📘 INVESTMENT_FUND
>
> Para inversiones de INVESTMENT_FUND, esta es la fecha en la que la transacción (compra o rescate) se procesa oficialmente en acciones o cuotas del fondo. Para compras, esta es la fecha en la que el dinero del inversor se aplica para adquirir acciones del fondo. Para rescates, esta es la fecha en la que las acciones del fondo se convierten oficialmente de nuevo en efectivo.
    Example: "2024-11-18"

  - `gross_value` (number)
    El valor bruto de la transacción.

> 🚧 No aplicable para inversiones de VARIABLE_INCOME.
    Example: 60

  - `net_value` (number)
    El valor neto de la transacción.

> 🚧 No aplicable para inversiones de VARIABLE_INCOME.
    Example: 60

  - `value` (number)
    El valor de la transacción.

Para inversiones de VARIABLE_INCOME, este es el valor de la operación ejecutada por el cliente. Si el cliente compra o vende acciones, este campo indica el valor total de la operación (por ejemplo, el precio por acción × cantidad).

Para inversiones de INVESTMENT_FUND, este es el valor solicitado por el cliente para una transacción de fondo.

> 🚧 Solo aplicable para inversiones de VARIABLE_INCOME y INVESTMENT_FUND.
    Example: 60

  - `unit_price` (number)
    El precio por una unidad o cuota individual.
    Example: 3

  - `price_factor` (number)
    El número de unidades (acciones) considerado al calcular el precio por acción o unidad para una transacción.

> 🚧 Solo aplicable para inversiones de VARIABLE_INCOME.
    Example: 1

  - `transaction_tax` (number)
    El Impuesto sobre Operaciones Financieras (Imposto sobre Operações Financeiras (IOF)) aplicado o retenido durante la transacción.

> 🚧 No aplicable para inversiones de VARIABLE_INCOME.

  - `income_tax` (number)
    El Impuesto sobre la Renta (Imposto de Renda (IR)) aplicado o retenido durante la transacción.

> 🚧 No aplicable para inversiones de VARIABLE_INCOME.

  - `quantity` (number)
    El número de unidades, cuotas o activos involucrados en una transacción.
    Example: 20

  - `type` (string)
    El tipo de transacción (INFLOW o OUTFLOW) desde la perspectiva de la inversión.
    Enum: "INFLOW", "OUTFLOW", "null"

  - `subtype` (string)
    El subtipo de transacción.

- Para FIXED_INCOME_BANKING: APLICACAO, RESGATE, CANCELAMENTO, VENCIMENTO, PAGAMENTO_JUROS, AMORTIZACAO, TRANSFERENCIA_TITULARIDADE, TRANSFERENCIA_CUSTODIA, OUTROS.
- Para FIXED_INCOME_CREDIT: COMPRA, VENDA, CANCELAMENTO, VENCIMENTO, PAGAMENTO_JUROS, AMORTIZACAO, PRÊMIO, TRANSFERENCIA_TITULARIDADE, TRANSFERENCIA_CUSTODIA, MULTA, MORA, OUTROS.
- Para VARIABLE_INCOME: COMPRA, VENDA, DIVIDENDOS, JCP, ALUGUEIS, TRANSFERENCIA_TITULARIDADE, OUTROS.
- Para INVESTMENT_FUND: AMORTIZACAO, TRANSFERENCIA_DE_COTAS, APLICACAO, RESGATE, COME_COTAS, OUTROS.
- Para TREASURY_BOND: COMPRA, VENDA, CANCELAMENTO, VENCIMENTO, PAGAMENTO_JUROS, AMORTIZACAO, TRANSFERENCIA_TITULARIDADE, TRANSFERENCIA_CUSTODIA, OUTROS.

  - `subtype_additional_info` (string)
    Información adicional sobre el subtipo de transacción. Este campo es obligatorio cuando el subtipo es OUTROS.

  - `indexer_percentage` (number)
    El porcentaje máximo del indexador para el contrato (Bancaria) o transacción (Crédito).

> 🚧 Solo aplicable para inversiones en FIXED_INCOME_BANKING y FIXED_INCOME_CREDIT.

  - `rate` (number)
    La tasa de remuneración aplicada a la transacción.

> 🚧 Solo aplicable para inversiones en FIXED_INCOME_BANKING, FIXED_INCOME_CREDIT y TREASURY_BOND.

  - `exit_fee` (number)
    La tarifa de salida se aplica a la transacción del Fondo de Inversión (Fundos de Investimento). Esta tarifa se cobra cuando un cliente rescata o sale del fondo.

> 🚧 Solo aplicable para inversiones de tipo INVESTMENT_FUND.

  - `broker_note_details` (object,null)
    Detalles sobre la nota de corretaje asociada con esta transacción. Este objeto solo se devuelve para transacciones que están asociadas con un tipo de inversión VARIABLE_INCOME.

> 📘 Info
>
> Una nota de corretaje (nota de corretagem) es un documento oficial emitido por una correduría que detalla las transacciones realizadas por un inversor en un día determinado. Incluye información sobre el valor bruto de todas las compras y ventas, comisiones de corretaje, tarifas de compensación y liquidación, tarifas de compensación y registro, tarifas de aviso de negociación de activos en bolsa, tarifas de bolsa, tarifas de custodia de compensación, impuestos y el impuesto sobre la renta retenido en la fuente.

  - `broker_note_details.broker_note_number` (string, required)
    El número de la nota del broker.
    Example: "1854009930314350"

  - `broker_note_details.gross_value` (number, required)
    El valor bruto de todas las compras y ventas del día.
    Example: 1000

  - `broker_note_details.brokerage_fee` (number, required)
    La tarifa total de corretaje cobrada por el día.
    Example: 10

  - `broker_note_details.clearing_settlement_fee` (number, required)
    La tarifa cobrada por la compensación y liquidación en custodia.
    Example: 2.5

  - `broker_note_details.clearing_registration_fee` (number, required)
    La tarifa cobrada por la compensación y el registro en custodia.
    Example: 1

  - `broker_note_details.stock_exchange_asset_trade_notice_fee` (number, required)
    La tarifa cobrada por la bolsa de valores por las notificaciones de comercio de activos.
    Example: 0.5

  - `broker_note_details.stock_exchange_fee` (number, required)
    La tarifa cobrada por la bolsa de valores por los servicios de registro.
    Example: 3

  - `broker_note_details.clearing_custody_fee` (number, required)
    La tarifa cobrada por las instituciones financieras por los servicios de custodia.
    Example: 1.5

  - `broker_note_details.taxes` (number, required)
    El monto total de los impuestos cobrados en la transacción del día, excluyendo el impuesto sobre la renta retenido en la fuente.
    Example: 10

  - `broker_note_details.income_tax` (number, required)
    El monto total del impuesto sobre la renta retenido en la fuente para el día.
    Example: 5

  - `broker_note_details.net_value` (number, required)
    El valor neto de la nota del corredor después de deducir los gastos por comisiones de corretaje, tarifas de liquidación de compensación, tarifas de registro, tarifas de ANA, emolumentos, tarifas de custodia, impuestos y IRRF.
    Example: 980

## Response 202 fields (application/json):

  - `request_id` (string)
    El ID único para esta solicitud. Recomendamos que almacene este valor para identificar más tarde qué evento de webhook se relaciona con una solicitud asincrónica.
    Example: "b5d0106ac9cc43d5b36199fe831f6bbe"

## 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"


