Cole no ChatGPT/Claude e peça para resumir/gerar SDK.

Calendário de proventos

GET

/companies/cash-corporate-actions

Retorna eventos corporativos em dinheiro (ex.: dividendos, JCP, restituições, amortizações) para todas as empresas disponíveis na Partnr API.

Esse endpoint é ideal para construir:

calendário de proventos (páginas e widgets de agenda)
alertas por data (ex.: pagamento amanhã)
automação de carteira (notificar o investidor quando um ativo anunciar/pagar proventos)
conciliação/auditoria com rastreabilidade por fonte oficial

Parâmetros de requisição

Parâmetro	Local	Descrição	Obrigatório
`current`	Query	Se `true`, retorna apenas a versão atual do evento. Padrão: `true`.	Opcional
`start_date`	Query	ISO 8601. Filtra por `payment_date` a partir desta data.	Opcional
`end_date`	Query	ISO 8601. Filtra por `payment_date` até esta data.	Opcional
`stock_type`	Query	Filtra por tipo de ação (CS, PS, PSA, PSB, PSC, PSD, UNIT, BDR).	Opcional
`bdr`	Query	Se `true`, retorna também os eventos de BDRs. Padrão: `false`.	Opcional

Boas práticas

Para montar um calendário, filtre por janela de tempo (ex.: 30/60/90 dias) usando start_date e end_date.
Use current=true para evitar duplicidade quando um evento tiver revisões/republicações ao longo do tempo.
O retorno pode conter múltiplas linhas para a mesma empresa quando houver proventos por classe de ação (ex.: ON/PN), diferenciadas por ticker, stock_type e isin_code.

Resposta

Código	Descrição
200	Retorna os eventos corporativos em dinheiro.
400	Parâmetros ausentes ou inválidos.
401	Não autorizado.
404	Empresa não encontrada.

Formato da resposta

A resposta é uma lista de objetos com os campos abaixo:

Campo	Tipo	Descrição
`company_id`	string	CNPJ/identificador da empresa que anunciou o provento.
`ticker`	string	Ticker da classe de ação associada ao provento.
`approval_date`	string (ISO 8601)	Data de aprovação do provento.
`prior_ex_date`	string (ISO 8601)	Data com/sem do provento (ex-date), usada para definição de elegibilidade.
`protocol`	string	Protocolo do provento na CVM.
`publish_date`	string (ISO 8601)	Data de publicação do evento.
`id`	string	ID único do provento na base da Partnr.
`payment_date`	string (ISO 8601) \| null	Data de pagamento do provento (quando definida).
`stock_type`	string	Tipo de ação (`CS`, `PS`, `PSA`, `PSB`, `PSC`, `PSD`, `UNIT`, `BDR`).
`isin_code`	string	ISIN da classe de ativo associada ao provento.
`declared_value`	number	Valor original do provento declarado pela companhia, sem correção monetária.
`monetary_correction`	number	Correção monetária deliberada pela companhia (ex.: SELIC, IPCA). `0` quando não aplicável.
`monetary_correction_start_date`	string (ISO 8601) \| null	Início do período de incidência da correção monetária. `null` quando não aplicável.
`monetary_correction_end_date`	string (ISO 8601) \| null	Fim do período de incidência da correção monetária. `null` quando não aplicável.
`value`	number	Valor bruto total do provento por ação (`declared_value` + `monetary_correction`).
`net_value`	number	Valor líquido efetivamente recebido pelo investidor, já descontados os impostos sobre a correção monetária e sobre o provento (ex.: 15% retidos na fonte em JCP).
`name`	string	Nome/tipo do provento (ex.: `Dividendo`, `Juros sobre capital próprio`).
`code`	string	Código do provento na CVM.
`installments`	array	Lista de parcelas quando o pagamento é dividido em múltiplas datas.
`adjusted_declared_value`	number	`declared_value` ajustado historicamente por eventos corporativos.
`adjusted_monetary_correction`	number	`monetary_correction` ajustada historicamente por eventos corporativos.
`adjusted_value`	number	`value` ajustado historicamente por eventos corporativos.
`adjusted_net_value`	number	`net_value` ajustado historicamente por eventos corporativos.
`adjustment_factor`	number	Fator de ajuste corporativo usado para converter valores históricos para base comparável atual.
`currency`	string	Moeda do valor retornado (ex.: `BRL`).
`source`	object	Metadados e links da fonte oficial do documento.

Estrutura de `installments[]`

Campo	Tipo	Descrição
`declared_value`	number	Valor declarado da parcela, sem correção monetária.
`monetary_correction`	number	Correção monetária da parcela.
`value`	number	Valor bruto da parcela (`declared_value` + `monetary_correction`).
`net_value`	number \| null	Valor líquido da parcela (após retenções, quando aplicável).
`adjusted_declared_value`	number \| null	`declared_value` da parcela ajustado por eventos corporativos.
`adjusted_monetary_correction`	number \| null	`monetary_correction` da parcela ajustada por eventos corporativos.
`adjusted_value`	number \| null	`value` da parcela ajustado por eventos corporativos.
`adjusted_net_value`	number \| null	`net_value` da parcela ajustado por eventos corporativos.
`currency`	string	Moeda da parcela.
`payment_date`	string (ISO 8601) \| null	Data de pagamento da parcela.

Sobre campos ajustados (adjusted_*)

Tudo que é adjusted é ajustado historicamente por eventos corporativos (como desdobramentos e grupamentos) para que o valor possa ser comparado de forma consistente com o preço atual da ação.

Exemplo

[
  {
    "company_id": "02421421000111",
    "ticker": "TIMS3",
    "approval_date": "2025-12-16T00:00:00.000Z",
    "prior_ex_date": "2025-12-19T22:00:00.000Z",
    "protocol": "1461573",
    "publish_date": "2025-12-26T00:00:00.000Z",
    "id": "6954870f409eb94a82a0a907",
    "payment_date": "2025-12-30T13:00:00.000Z",
    "stock_type": "CS",
    "isin_code": "BRTIMSACNOR5",
    "declared_value": 0.7491354635,
    "monetary_correction": 0,
    "monetary_correction_start_date": null,
    "monetary_correction_end_date": null,
    "value": 0.7491354635,
    "net_value": 0.7491354635,
    "name": "Dividendo",
    "code": "62697",
    "adjusted_declared_value": 0.7491354635,
    "adjusted_monetary_correction": 0,
    "adjusted_value": 0.7491354635,
    "adjusted_net_value": 0.7491354635,
    "adjustment_factor": 1,
    "currency": "BRL",
    "source": {
      "visualization_url": "https://www.rad.cvm.gov.br/ENET/frmExibirArquivoIPEExterno.aspx?NumeroProtocoloEntrega=1461573",
      "download_url": "https://www.rad.cvm.gov.br/ENET/frmExibirArquivoIPEExterno.aspx?NumeroProtocoloEntrega=1461573",
      "published_at": "2025-12-26T00:00:00.000Z",
      "retrieved_at": "2026-04-01T19:48:11.424Z",
      "name": "Dividendo (62697 - R$ 0.74913546350)"
    }
  },
  {
    "company_id": "07206816000115",
    "ticker": "MDIA3",
    "approval_date": "2025-12-16T00:00:00.000Z",
    "prior_ex_date": "2025-12-19T22:00:00.000Z",
    "protocol": "1458109",
    "publish_date": "2025-12-18T00:00:00.000Z",
    "id": "69489363409eb94a829c4318",
    "payment_date": "2025-12-30T13:00:00.000Z",
    "stock_type": "CS",
    "isin_code": "BRMDIAACNOR7",
    "declared_value": 0.5963326976,
    "monetary_correction": 0,
    "monetary_correction_start_date": null,
    "monetary_correction_end_date": null,
    "value": 0.5963326976,
    "net_value": 0.5963326976,
    "name": "Dividendo",
    "code": "62133",
    "adjusted_declared_value": 0.5963326976,
    "adjusted_monetary_correction": 0,
    "adjusted_value": 0.5963326976,
    "adjusted_net_value": 0.5963326976,
    "adjustment_factor": 1,
    "currency": "BRL",
    "source": {
      "visualization_url": "https://www.rad.cvm.gov.br/ENET/frmExibirArquivoIPEExterno.aspx?NumeroProtocoloEntrega=1458109",
      "download_url": "https://www.rad.cvm.gov.br/ENET/frmExibirArquivoIPEExterno.aspx?NumeroProtocoloEntrega=1458109",
      "published_at": "2025-12-18T00:00:00.000Z",
      "retrieved_at": "2026-04-01T19:48:11.424Z",
      "name": "Dividendo (62133 - R$ 0.59633269760)"
    }
  }
]

Parâmetros de requisição​

Resposta​

Formato da resposta​

Estrutura de installments[]​

Exemplo​

Parâmetros de requisição

Resposta

Formato da resposta

Estrutura de `installments[]`

Exemplo