Documentation Index
Fetch the complete documentation index at: https://docs.sherlocker.com.br/llms.txt
Use this file to discover all available pages before exploring further.
Um Benefício Social representa um pagamento de programa social do governo federal vinculado a um CPF, ou uma renúncia fiscal vinculada a um CNPJ.
Programas disponíveis
| Programa | Descrição |
|---|
| Auxílio Brasil | Programa de transferência de renda (substituto do Bolsa Família) |
| Bolsa Família | Programa histórico de transferência de renda |
| Auxílio Emergencial | Pagamentos durante a pandemia (2020-2021) |
| BPC | Benefício de Prestação Continuada (idosos e deficientes) |
Resposta
{
"documento": "918.050.406-00",
"tipo_documento": "CPF",
"beneficios": {
"auxilio_brasil": [],
"bolsa_familia": [],
"auxilio_emergencial": [
{
"mes": "2020-04",
"parcela": 1,
"uf": "MG",
"municipio": "Belo Horizonte",
"enquadramento": "EXTRACAD",
"observacao": null,
"valor": 1200.00
}
],
"bpc": []
}
}
Auxílio Brasil / Bolsa Família
Ambos compartilham o mesmo formato.
{
"nome_favorecido": "Maria da Silva",
"mes_competencia": "2023-01",
"mes_referencia": "2023-01",
"uf": "MG",
"municipio": "Belo Horizonte",
"valor_parcela": 600.00
}
| Campo | Tipo | Descrição |
|---|
nome_favorecido | string | Nome do beneficiário (Title Case) |
mes_competencia | string | Mês de competência (YYYY-MM) |
mes_referencia | string | Mês de referência (YYYY-MM) |
uf | string | UF |
municipio | string | Nome do município (Title Case) |
valor_parcela | number | Valor da parcela em R$ |
Auxílio Emergencial
{
"mes": "2020-04",
"parcela": 1,
"uf": "MG",
"municipio": "Belo Horizonte",
"enquadramento": "EXTRACAD",
"observacao": null,
"valor": 1200.00
}
| Campo | Tipo | Descrição |
|---|
mes | string | Mês de disponibilização (YYYY-MM) |
parcela | number | null | Número da parcela (1, 2, 3…) |
uf | string | UF |
municipio | string | Nome do município (Title Case) |
enquadramento | string | Enquadramento (EXTRACAD, CADÚNICO) |
observacao | string | null | Observações (null quando não há) |
valor | number | Valor do benefício em R$ |
BPC (Benefício de Prestação Continuada)
{
"mes_competencia": "2023-01",
"uf": "MG",
"municipio": "Belo Horizonte",
"numero_beneficio": "1234567890",
"judicial": false,
"valor_parcela": 1320.00
}
| Campo | Tipo | Descrição |
|---|
mes_competencia | string | Mês de competência (YYYY-MM) |
uf | string | UF |
municipio | string | Nome do município (Title Case) |
numero_beneficio | string | null | Número do benefício |
judicial | boolean | Se foi concedido judicialmente |
valor_parcela | number | Valor da parcela em R$ |
Renúncias Fiscais (Pessoa Jurídica)
{
"ano_calendario": "2023",
"cnpj": "12345678000199",
"razao_social": "Empresa Ltda",
"nome_fantasia": "Empresa",
"codigo_cnae": "64221",
"cnae": "Bancos múltiplos, com carteira comercial",
"municipio": "São Paulo",
"uf": "SP",
"tipo_renuncia": "Declarado pelo Contribuinte para Apuração do IRPJ e da CSLL",
"beneficio_fiscal": "Empresa Cidadã",
"fundamento_legal": "Lei 11.770/2008",
"descricao": "Salário-maternidade/paternidade estendido",
"tributo": "IRPJ",
"forma_tributacao": "Lucro Real",
"valor_renuncia_fiscal": "50000.00"
}
| Campo | Tipo | Descrição |
|---|
ano_calendario | string | Ano-base da renúncia |
cnpj | string | CNPJ da empresa beneficiária |
razao_social | string | Razão social |
nome_fantasia | string | Nome fantasia |
codigo_cnae | string | null | Código CNAE |
cnae | string | null | Descrição CNAE |
municipio | string | Município |
uf | string | null | UF |
tipo_renuncia | string | Tipo da renúncia |
beneficio_fiscal | string | Nome do benefício fiscal |
fundamento_legal | string | Base legal |
descricao | string | Descrição detalhada |
tributo | string | Tributo afetado (IRPJ, CSLL, PIS, COFINS) |
forma_tributacao | string | null | Regime de tributação |
valor_renuncia_fiscal | string | Valor em R$ |
Endpoints
| Rota | Descrição |
|---|
GET /beneficios/cpf/{cpf} | Benefícios sociais por CPF |
GET /beneficios/cnpj/{cnpj} | Renúncias fiscais por CNPJ |
