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 |
Boas práticas
- Para montar um calendário, filtre por janela de tempo (ex.: 30/60/90 dias) usando
start_dateeend_date. - Use
current=truepara 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_typeeisin_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) | Data de pagamento do provento (quando definida). |
stock_type | string | Tipo de ação (CS, PS, PSA, PSB, PSC, PSD, UNIT). |
isin_code | string | ISIN da classe de ativo associada ao provento. |
value | number | Valor bruto do provento por ação/cota. |
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 do provento quando o pagamento é dividido em múltiplas datas. |
net_value | number | Valor líquido (descontado de impostos retidos na fonte, como 15% para JCP, quando aplicável). |
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 |
|---|---|---|
value | number | Valor bruto da parcela. |
net_value | number | Valor líquido da parcela (após retenções, quando aplicável). |
adjusted_value | number | Valor bruto da parcela ajustado por eventos corporativos historicamente. |
adjusted_net_value | number | Valor líquido da parcela ajustado por eventos corporativos historicamente. |
currency | string | Moeda da parcela. |
payment_date | string (ISO 8601) | Data de pagamento da parcela. |
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",
"value": 0.7491354635,
"name": "Dividendo",
"code": "62697",
"net_value": 0.7491354635,
"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",
"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",
"value": 0.5963326976,
"name": "Dividendo",
"code": "62133",
"net_value": 0.5963326976,
"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",
"name": "Dividendo (62133 - R$ 0.59633269760)"
}
}
]