O que é
Na consulta Prefeitura BH - Certidão Negativa de Débitos - você verifica se uma pessoa possui débitos ou pendências fiscais em Belo Horizonte.
Veja mais informações em nossa central de ajuda: Prefeitura BH - Certidão Negativa de Débitos
Sobre a requisição:
Método: POST
Endereço: URL Base + /api/maestro/prefeitura-bh/certidao-negativa-debitos/iss-inss
...
Include Page | ||||
---|---|---|---|---|
|
Parâmetros do header
Nome | Tipo | Obrigatório? | Descrição |
---|---|---|---|
Authorization | String | Sim | Chave de API gerada no cadastro no Plexi, prefixada com |
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 |
---|---|---|---|
cpf | string | Sim | CPF 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 |
---|---|---|---|
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
|
Status 422
|
Resultados da pesquisa ( retornados no callback ou fazendo requisição à API de respostas )
Valores possíveis do campo “status“
Status | Significado |
---|---|
negativo | NÃO foram encontrados débitos para o documento pesquisado |
positivo | Foram encontrados débitos relacionados ao documento pesquisado |
erro | Ocorre quando o documento informado não existe |
Resposta com registro encontrado
Code Block | ||
---|---|---|
| ||
{ "status": "positiva", "pdf": "JVBERi0xLjQKMSAwIG9iago8..." } |
Code Block | ||
---|---|---|
| ||
{
"endpoint": "prefeitura-bh-certidao-negativa-debitos-iss-inss",
"codigoControle": "AAAAAAAAAA",
"numeroCertidao": "99.999.999",
"anoCertidao": "2020",
"dataExpedicao": "10/12/2020",
"dataValidade": "10/03/2021",
"horarioRequerimento": "12:43:15",
"nome": "NOME",
"cpf": "915.821.996.04",
"endereco": "RUA , 999 - COMPLEMENTO - BAIRRO - 99999-999 - CIDADE - MG",
"quitacoes": {
"inscricaoMunicipal": "99999999999",
"atividade": "ENGENHEIRO ARQUITETO",
"dataInicio": "30/12/2000",
"situacao": "BAIXADA",
"dataBaixa": "30/12/2002",
"exerciciosQuitados": [
"2000",
"2001",
"2002"
]
},
"status": "negativo",
"pdf": "..."
} |
...