O que é
Na consulta Prefeitura BH - Certidão Negativa de Débitos - você verifica se uma pessoa ou empresa 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/quitacao-plena
URL Base:
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 |
|---|---|---|---|
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 |
|---|---|---|---|
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
{
"requestId": "1fdd4247-4f98-4113-887a-b182117b0e42"
}
|
Status 422
{
"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 |
|---|---|
negativo | NÃO foram encontrados débitos para o documento pesquisado |
positivo | Foram encontrados débitos relacionados ao documento pesquisado |
Resposta com registro encontrado
{
"codigoControle": "ABCFNGNLGK",
"numeroCertidao": "13.477.213",
"anoCertidao": "2020",
"dataExpedicao": "01\/07\/2020",
"dataValidade": "31\/07\/2020",
"horarioRequerimento": "17:42:09",
"nome": "FULANO DA SILVA",
"cpfCnpj": "999.999.999.99",
"pendencias": [],
"status": "negativo",
"pdf": "JVBERi0xLjYNJeLjz9MNCjI0I..."
}
{
"codigoControle": "ABCHIOLLGK",
"numeroCertidao": "13.477.217",
"anoCertidao": "2020",
"dataExpedicao": "01\/07\/2020",
"dataValidade": "31\/07\/2020",
"horarioRequerimento": "17:42:34",
"nome": "FULANO DA SILVA",
"cpfCnpj": "999.999.999.99",
"pendencias": [
{
"tipo": "PAGTO EXERCICIO ATE PARCELA 0.00",
"tributo": "IMPOSTO PREDIAL E TERRITORIAL URBANO",
"exercicio": "2020",
"lancamento": "13001200166620",
"identificador": "108041 018 0014"
}
],
"status": "positivo",
"pdf": "JVBERi0xLjYNJeLjz9MNCjI0IDA..."
}