O que é#

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

Sobre a requisição#

Método: POST

Endereço: https://api.plexi.com.br/api/maestro/fazenda-es/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
negativo NÃO foram encontrados débitos para o documento pesquisado
indefinido Não é possível informar se a pessoa ou empresa possui débitos relacionados ao documento pesquisado

Respostas com status negativo

JSON
{
  "cpfCnpj": "99.999.999/9999-99",
  "numeroCertidao": "123456789000123",
  "autenticacaoEletronica": "1234.5678.9012.3456",
  "status": "negativo",
  "dataEmissao": "01/05/2023",
  "dataValidade": "01/07/2023",
  "pdf": "JVBERi0xLjQKMSAwIG9iago8PAovVGl0bGUgKP7/..."
}

Respostas com status indefinido

JSON
{
  "status": "indefinido",
  "mensagem": "Não foi possível emitir a Certidão Negativa para o CNPJ 99.999.999\/9999-99. Se tiver cadastro na Agência Virtual, <a href=http:\/\/app.sefaz.es.gov.br\/AgenciaVirtual\/ target='_blank'>clique aqui<\/a> para acessar o site e tentar emitir uma Certidão Positiva com Efeito de Negativa. Caso contrário, procure a Agência da Receita Estadual de sua preferência.",
  "pdf": "JVBERi0xLjQKMSAwIG9iago8PAovVGl0bGUgKP7/..."
}