A fonte inteira, organizada e pronta para consultar: cada endpoint desta página responde em milissegundos. Cada resposta traz
as_of: o quão atuais são os dados. Como funcionam os datasets.Buscar dívidas
POST /br/pgfn/debts-search/v1 Dataset
Busca em todas as dívidas de empresas por qualquer combinação de nome, CNPJ ou
raiz, regime, estado, situação, papel, ajuizamento e valor.
as_of (o quão atuais são os dados), os filtros aplicados, total, page, per_page, total_pages, count e debts[], do maior para o menor valor.
Cada dívida traz regime (nao_previdenciario, previdenciario ou fgts), inscription_number, document_number (o CNPJ, 14 caracteres), document (12.345.678/0001-90), cnpj_root, debtor_name, debtor_type (principal, co_responsible ou joint), state, responsible_unit, registering_unit (FGTS), collecting_entity (pgfn ou caixa), status_type (in_collection, tax_benefit, guaranteed, suspended_by_court ou in_negotiation), status (a redação detalhada da PGFN), revenue_type, registered_on (yyyy-mm-dd), in_court, amount (reais, consolidado com os encargos legais) e reference_month (yyyy-mm da publicação).
Uma inscrição com vários devedores tem uma linha para cada um, e cada linha
traz o
amount da inscrição inteira. Some apenas as linhas principal; a
consulta de devedor abaixo faz isso por você.As dívidas de uma empresa
POST /br/pgfn/debtor/v1 Dataset
Soma o que uma empresa deve à União, por CNPJ ou por raiz.
found, document_number, as_of, reference_month, debtor_name, totals e debts[] (as 50 maiores).
totals traz debts (toda dívida em que a empresa aparece), principal_debts, principal_amount (o que a empresa deve como devedora principal, em reais), in_court_amount, by_regime ({ debts, amount } por tipo de dívida) e complete (false quando a empresa tem mais de 10.000 dívidas e só as maiores foram somadas). As dívidas corresponsáveis e solidárias contam em debts mas não nos valores, pois repetem o valor de outro devedor.
Uma empresa que não deve à União nada inscrito pela PGFN retorna
found: false com HTTP 200, não um erro.Referência completa
Esquemas, todos os campos de resposta e um playground interativo.