Totais dos Lançamentos de Investimentos

Retorna os totais aplicados, resgatados e de rendimento do conjunto de lançamentos que atende aos filtros, junto com o valor atual dos investimentos consultados.

Endpoint

Método e URL:

GET /api/v1/companies/:companyId/accounting/investments/entries/meta

Parâmetros da URL:

• companyId (uuid, obrigatório): Identificador da empresa

Parâmetros de query:

• investmentId (uuid, obrigatório, repetível): Investimentos a consultar — todos devem pertencer à empresa, caso contrário 404
• from, to (data YYYY-MM-DD ou data-hora ISO 8601, opcionais): Período sobre placedAt, ambos inclusivos — veja Período
• filters (JSON, opcional): Condições sobre os campos filtráveis dos lançamentos
• joinOperator (opcional): and (padrão) ou or
• search (texto, opcional): Mesma busca da listagem

Exemplo

Totais do primeiro semestre de 2026:

curl -G "https://api-business.openi.com.br/api/v1/companies/{companyId}/accounting/investments/entries/meta" \
  -H "Authorization: Bearer oak_368ba506f7b2_9f2c..." \
  --data-urlencode 'investmentId=9e8d7c6b-5a4f-4e3d-2c1b-0a9f8e7d6c5b' \
  --data-urlencode 'from=2026-01-01' \
  --data-urlencode 'to=2026-06-30'

Resposta

{
  "status": "success",
  "data": {
    "currentValue": "12350.00",
    "totalApplied": "10000.00",
    "totalRedeemed": "0.00",
    "yieldValue": "350.00",
    "periodVariation": "10350.00"
  }
}

• totalApplied: soma de netValue dos lançamentos BUY filtrados
• totalRedeemed: soma de netValue dos lançamentos SELL filtrados
• yieldValue: soma de netValue dos lançamentos com origin SYNTHETIC_EVENT (rendimentos derivados dos snapshots)
• periodVariation: totalApplied − totalRedeemed + yieldValue
• currentValue: valor líquido atual dos investimentos em investmentId — não é afetado por filters
• Valores como strings decimais com duas casas