O que é#

A certidão de débitos tributários emitida pela Fazenda de Pernambuco tem como finalidade confirmar se uma pessoa física ou jurídica possui pendências financeiras relacionadas aos impostos no estado de Pernambuco.

Sobre a requisição#

  • Método: POST
  • Endereço: https://api.plexi.com.br/api/maestro/fazenda-pe/certidao-negativa-debitos

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.

Estrutura da resposta#

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 quando você faz a requisição#

Status 201

A consulta recebida com sucesso e será processada. Com o ID retornado você pode consultar se já houve resposta.

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

Status 422

Significa que ocorreu um erro de validação dos dados enviados.

JSON
{
  "message": "The given data was invalid.",
  "errors": {
    "cpf": [
      "O campo cpf é obrigatório."
    ],
    "nome": [
      "O campo nome é obrigatório."
    ]
  }
}

Exemplos de retornos do resultado da pesquisa#

Valores possíveis do campo "status"

Status Significado
positivo Foram encontrados débitos para o documento pesquisado
negativo NÃO foram encontrados débitos para o documento pesquisado

Respostas com registro encontrado

JSON
{
    "nome": null,
    "cpfCnpj": "99.999.999/9999-99",
    "numeroCertidao": "9999.999999999999-99",
    "status": "negativo",
    "numeroProcessos": 0,
    "endereco": null,
    "inscricaoEstadual": null,
    "cnaePrincipal": null,
    "processos": [],
    "dataEmissao": "01/01/2020",
    "dataValidade": "01/04/2020",
    "pdf": "JVBERi0xLjQKJeLjz9MKJVBERi0xLjQKJeLjz9MKMiAwIG/..."
}
JSON
{
    "nome": "EMPRESA EXEMPLO LTDA",
    "cpfCnpj": "99.999.999/9999-99",
    "numeroCertidao": "9999.999999999999-99",
    "status": "positivo",
    "numeroProcessos": 2,
    "endereco": {
        "logradouro": "PRACA EXEMPLO, 40",
        "bairro": "CENTRO",
        "municipio": "CIDADE",
        "cep": "99.999-999"
    },
    "inscricaoEstadual": "9999999-99",
    "cnaePrincipal": "4744-0/99",
    "processos": [
        {
            "tipo": "INSCRIÇÃO",
            "identificacao": "9999999-99",
            "processo": "9999.000000111222-33",
            "situacao": "PARCELAMENTO ESGOTADO",
            "inscricao": "99111222/22-0",
            "livro": "648",
            "folha": "201",
            "saldo": 36602.19
        },
        {
            "tipo": "INSCRIÇÃO",
            "identificacao": "9999999-99",
            "processo": "9999.000000111222-33",
            "situacao": "AGUARDANDO REGULARIZAÇÃO",
            "inscricao": "99111222/22-0",
            "livro": "647",
            "folha": "134",
            "saldo": 45899.67
        }
    ],
    "dataEmissao": "01/01/2020",
    "dataValidade": "01/04/2020",
    "pdf": "JVBERi0xLjQKJeLjz9MKJVBERi0xLjQKJeLjz9MKMyAwIG/..."
}