get_aliquota: Extrai dados de alíquotas da API do CADPREV

Description Usage Arguments Details Value Examples

View source: R/get_aliquota.R

Description

Função para a obtenção de dados relativos às alíquotas praticadas pelos RPPS, utilizando a API do CADPREV cuja documentação pode ser consultada em https://apicadprev.economia.gov.br/api-docs/.

Usage

1

Arguments

...

Qualquer um dos parâmetros de consulta disponibilizados pela API para a consulta às alíquotas praticadas pelo(s) RPPS.

Details

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

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

1
2
3
4
5
6
7
8
## Not run:  
# Obtém dados das alíquotas praticadas pelos RPPS do RJ
aliquotas_RJ <- get_aliquota(sg_uf="RJ") 

# Obtém dados das alíquotas praticadas pelo RPPS de Quatis - RJ
aliquotas_QuatisRJ <- get_aliquota(nr_cnpj_entidade = "39560008000148")

## End(Not run)

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