Skip to main content

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.

Uma Dívida representa uma inscrição na dívida ativa federal. Existem três tipos: Dívida Ativa da União, FGTS e Previdenciária. Inscrições com o mesmo numero_inscricao são agrupadas como histórico de uma única dívida.

Tipagem

{
  "documento": "12345678901",
  "nome": "JOAO DA SILVA",
  "total": 1,
  "valor_total": 15420.50,
  "ajuizado": true,
  "dividas": [
    {
      "numero_inscricao": "80000000000001",
      "fonte": "ativa_uniao",
      "receita": "IRPF",
      "ajuizado": true,
      "data_inscricao": "2020-03-15",
      "valor_atual": 15420.50,
      "uf": "SP",
      "unidade_responsavel": "DRF CAMPINAS",
      "historico": [
        {
          "situacao": "Ativa Ajuizada",
          "valor": 15420.50,
          "data_inscricao": "2020-03-15"
        }
      ]
    }
  ]
}

Campos da resposta

CampoTipoDescrição
documentostringCPF ou CNPJ consultado
nomestring|nullNome ou razão social do devedor
totalintegerTotal de inscrições encontradas
valor_totalnumberSoma dos valores atuais em R$
ajuizadobooleanTrue se ao menos uma dívida foi ajuizada
dividasarrayLista de dívidas (ver abaixo)

Campos de cada dívida

CampoTipoDescrição
numero_inscricaostringNúmero da inscrição na dívida ativa
fontestringativa_uniao, fgts ou previdenciaria
receitastring|nullTipo de tributo (IRPF, CSLL, FGTS, etc.)
ajuizadobooleanSe foi ajuizado judicialmente
data_inscricaostring|nullData da inscrição mais recente
valor_atualnumber|nullValor consolidado mais recente em R$
ufstring|nullUF do devedor
unidade_responsavelstring|nullUnidade responsável pela inscrição
entidade_responsavelstring|nullEntidade responsável (somente FGTS)
historicoarrayHistórico de situações para o mesmo número de inscrição

Tipos

TipoDescrição
Ativa da UniãoTributos federais (IR, CSLL, PIS, COFINS)
FGTSDívidas do Fundo de Garantia
PrevidenciáriaContribuições previdenciárias (INSS)

Conexões

  • Pessoa — como devedor (CPF)
  • Empresa — como devedor (CNPJ)
  • Processo — dívidas ajuizadas geram execuções fiscais

Endpoints

RotaDescrição
GET /dividas/cpf/{cpf}Dívidas por CPF
GET /dividas/cnpj/{cnpj}Dívidas por CNPJ