get_draa_valores_compromissos: Extrai dados do DRAA da API do CADPREV

In marcosfs2006/ADPrev: Análise de Dados Previdenciários dos RPPS

Description

Função para a obtenção de dados relativos aos valores dos compromissos obtidos na avaliação atuarial anual do RPPS e registrados no Demonstrativo de Resultados da Avaliação Atuarial - DRAA, utilizando a API do CADPREV cuja documentação pode ser consultada em https://apicadprev.economia.gov.br/api-docs/.

Usage

get_draa_valores_compromissos(...)

Arguments

...	Qualquer um dos parâmetros de consulta disponibilizados pela API para a consulta aos dados de compromissos do DRAA.

Details

Embora a função aceite como parâmetros qualquer um dos que possam ser passados ao ponto de acesso DRAA_VALORES_COMPROMISSOS recomendamos utilizar os parâmtros abaixo elencados e depois realizar os filtros desejados.

• nr_cnpj_entidade caractere indicando o CNPJ do Ente a que pertence o RPPS

• no_ente caractere indicando o nome do Ente a que pertence o RPPS

• sg_uf caractere indicando a sigla da unidade da federação a que pertence o RPPS

• dt_exercicio inteiro indicando o ano do DRAA

A sigla da UF deve ser fornecida em letras maiúsculas.

O nome do Ente deve ser fornecido exatamente como consta da base de dados.

Para evitar erros devidos a incorreções no nome do Ente recomenda-se utilizar o CNPJ do Ente para consultas relativas a um RPPS específico.

O ano do DRAA (dt_exercicio) é o ano posterior ao ano da data base da avaliação atuarial.

Se a avaliação atuarial tem data base em 31/12/2019 o ano do DRAA é 2020.

Value

Um data frame contendo os dados requisitados.

Examples

## Not run:  
# Obtém dados dos valores dos compromissos dos DRAA  dos RPPS do RJ para todos
# os anos disponíveis na base de dados (2015 em diante)
draa_RJ <- get_draa_valores_compromissos(sg_uf="RJ") 

# Obtém dados dos valores dos compromissos do DRAA do RPPS de Quatis - RJ do ano de 2019
draa_QuatisRJ2019 <- get_draa_valores_compromissos(nr_cnpj_entidade = "39560008000148",
                                                   dt_exercicio=2019)

## End(Not run)

marcosfs2006/ADPrev documentation built on Dec. 21, 2021, 1:50 p.m.