get_regime_previdenciario: Extrai dados do regime previdenciário 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 ao regime previdenciário a que pertence o RPPS utilizando a API do CADPREV cuja documentação pode ser consultada em https://apicadprev.economia.gov.br/api-docs/.

Usage

get_regime_previdenciario(...)

Arguments

...	Qualquer um dos parâmetros de consulta disponibilizados pela API para a consultas quanto ao regime previdenciário a que pertencem os RPPS.

Details

Embora a função aceite como parâmetros qualquer um dos que possam ser passados ao ponto de acesso RPPS_REGIME_PREVIDENCIARIO recomenda-se 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

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.

Value

Um data frame contendo os dados requisitados.

Examples

## Not run:  
# Obtém dados do regime previdenciário a que os Entes do RJ estão vinvulados
reg_prev_RJ <- get_regime_previdenciario(sg_uf="RJ") 

# Obtém dados do regime previdenciário ao qual o município de Quatis - RJ
# está vinculado
reg_prev_QuatisRJ <- get_regime_previdenciario(nr_cnpj_entidade = "39560008000148")

## End(Not run)

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