PGFN - Lista de Devedores

O que é

Na consulta PGFN - Lista de Devedores - você verifica se uma pessoa ou empresa possui dívidas inscritas na dívida ativa da União e do FGTS, na condição de devedor principal.

Veja mais informações em nossa central de ajuda: PGFN - Lista de Devedores.

Sobre a requisição:

Método: POST

Endereço: URL Base + /api/maestro/pgfn/lista-devedores

URL Base:

Parâmetros do header

Nome

Tipo

Obrigatório?

Descrição

Nome

Tipo

Obrigatório?

Descrição

Authorization

String

Sim

Chave de API gerada no cadastro no Plexi, prefixada com Bearer

Callback

String

Não

URL para onde o resultado da requisição será enviado via HTTP POST.

Parâmetros do body

Nome

Tipo

Obrigatório?

Descrição

Nome

Tipo

Obrigatório?

Descrição

cpfCnpj

String

Sim

CPF ou CNPJ a ser pesquisado, com ou sem máscara. Exemplos: 99999999999 ou 999.999.999-99

Retornos possíveis da requisição

Status

Significado

Descrição

Informações retornadas

Status

Significado

Descrição

Informações retornadas

201

Created

Solicitação criada

Campo requestId, com o ID da requisição criada.

422

Unprocessable Entity

A solicitação contém erro

Em quais campos houve erro.

Exemplos de retornos

Status 201

1 2 3 {   "requestId": "1fdd4247-4f98-4113-887a-b182117b0e42" }

Status 422

1 2 3 4 5 6 7 8 9 10 11 {   "message": "The given data was invalid.",   "errors": {     "cpf": [       "O campo cpf é obrigatório."     ],     "nome": [       "O campo name é obrigatório."     ]   } }

 

Resultados da pesquisa ( retornados no callback ou fazendo requisição à API de respostas )

Valores possíveis do campo “status“

Status

Significado

Status

Significado

negativa

NÃO foram encontrados débitos para o documento pesquisado

positiva

Foram encontrados débitos relacionados ao documento pesquisado

Resposta com registro encontrado

CPF encontrado

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 { "id": "***382938**", "encodedId": "NrqaZZmcy2cKjKmGMHA%2Bog%3D%3D", "nome": "NOME DA PESSOA OU EMPRESA", "codmunicipio": 7777, "nomeMunicipio": "SAO PAULO", "uf": "SP", "totaldivida": 9999.99, "totaltributario": 9999.99, "naturezas": [ { "total": 9999.99, "debitos": [ { "valor": 9999.99, "numero": "99999999999" } ], "natureza": 1 } ], "status": "positiva" }
1 2 3 { "status": "negativa" }

CNPJ encontrado

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 { "id": "628583382918373", "encodedId": "Fhxpks1BD3kdlZxaTcuxUw%3D%3D", "nome": "NOME DA EMPRESA", "codmunicipio": 7181, "nomeMunicipio": "TATUI", "uf": "SP", "cnae": "0000 0000 0000 0000 0000", "descricaoCnae": "DESCRICAO CNAE", "totaldivida": 278649619.46, "totaltributario": 211001997.28, "totalprevidenciario": 45380159.4, "totalmultatrabalhista": 3035154.25, "totalnaotributario": 886917.43, "totalfgts": 18345391.1, "naturezas": [ { "total": 211001997.28, "debitos": [ { "valor": 2442037.64, "numero": "99999999999" }, { "valor": 235991.59, "numero": "99999999999" } ], "natureza": 1 }, { "total": 45380159.4, "debitos": [ { "valor": 925236.27, "numero": "99999999999" } ], "natureza": 2 }, { "total": 3035154.25, "debitos": [ { "valor": 12872, "numero": "99999999999" } ], "natureza": 3 }, { "total": 886917.43, "debitos": [ { "valor": 886917.43, "numero": "99999999999" } ], "natureza": 6 }, { "total": 18345391.1, "debitos": [ { "valor": 1087010.38, "numero": "FGSP999999999" }, { "valor": 17258380.72, "numero": "FGSP999999999" } ], "natureza": 7 } ], "status": "positiva" }