View Source

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.

Sobre a requisição:

Método: POST

Endereço: URL Base + /api/maestro/prefeitura-bh/certidao-negativa-debitos/iss

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 `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
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
indefinido	Situação em que o site informa que não foi possível emitir a certidão
erro	Ocorre quando o documento informado não existe

Resposta com registro encontrado

Certidão positiva:

{
    "endpoint": "prefeitura-bh-certidao-negativa-debitos-iss",
    "codigoControle": "AAAAAAAAAA",
    "numeroCertidao": "99.999.999",
    "anoCertidao":"2020",
    "dataExpedicao": "10/12/2020",
    "dataValidade": "09/01/2021",
    "horarioRequerimento": "11:46:43",
    "nome": "NOME DA PESSOA OU EMPRESA",
    "cpfCnpj": "99.999.999.0001.99",
    "pendencias": [
        {
            "tipo": "LANCAMENTO C/DEBITO",
            "tributo": "ISSQN AUTONOMO",
            "exercicio": "2015",
            "lancamento": "999999999999999", 
            "identificador": "9999999999"
        }
    ],
    "status": "positivo",
    "pdf": "..."
}

Certidão negativa:

{
    "endpoint": "prefeitura-bh-certidao-negativa-debitos-iss",
    "codigoControle": "ABKLIGPOPK",
    "numeroCertidao": "14.323.889",
    "anoCertidao":"2020",
    "dataExpedicao": "10/12/2020",
    "dataValidade": "09/01/2021",
    "horarioRequerimento": "11:46:43",
    "nome": "CRAWLY SOLUCOES E TECNOLOGIA LTDA",
    "cpfCnpj": "29.178.865.0001.24",
    "pendencias": [],
    "status": "negativo",
    "pdf": "..."
}

Resultado indefinido:

{
    "endpoint": "prefeitura-bh-certidao-negativa-debitos-iss",
    "status": "indefinido",
    "pdf": "..."
}

Resposta com erro

{
  "status": "erro",
  "mensagem": "Cpf ou cnpj inexistente."
}