docs

Fazenda PB - Certidão Negativa de Débitos Estaduais

v1Atualizado em

O que é#

A certidão negativa de débitos estaduais emitida pela Secretaria da Fazenda do Estado da Paraíba (SEFAZ-PB) tem como finalidade confirmar se uma pessoa física ou jurídica possui pendências financeiras relacionadas a tributos estaduais na Paraíba.

Sobre a requisição#

Método: POST

Endereço: https://api.plexi.com.br/api/maestro/fazenda-pb/certidao-negativa-debitos

URL Base: https://api.plexi.com.br/

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 Condicional* CPF ou CNPJ do contribuinte a ser pesquisado. Obrigatório caso inscricaoEstadual não seja informado.
inscricaoEstadual string Condicional* Inscrição Estadual do contribuinte na Paraíba. Obrigatório caso cpfCnpj não seja informado.
identidade string Condicional** Número da identidade do contribuinte. Obrigatório quando a consulta é realizada por CPF.
orgaoExpedidor string Condicional** Órgão expedidor da identidade (ex: SSP). Obrigatório quando a consulta é realizada por CPF.
uf string Condicional** UF do órgão expedidor da identidade (ex: PB, SP, MG). Obrigatório quando a consulta é realizada por CPF.

* É obrigatório informar ao menos um dos campos: cpfCnpj ou inscricaoEstadual. Caso ambos sejam enviados, o cpfCnpj terá precedência.

** Os campos identidade, orgaoExpedidor e uf são obrigatórios quando a consulta é realizada por CPF (pessoa física). Não são necessários para consultas por CNPJ ou Inscrição Estadual.

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#

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."
    ]
  }
}

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. Certidão emitida com sucesso.
positivo Não foi possível atender a solicitação. O contribuinte deve comparecer à repartição fiscal.
indefinido Não foi possível processar a consulta no momento.
erro Ocorreu um erro na consulta (serviço indisponível ou falha inesperada).

Resposta com status negativo#

JSON
{
    "status": "negativo",
    "mensagem": "Certidão Negativa de Débitos Estaduais emitida com sucesso",
    "pdf": "JVBERi0xLjQKMSAwIG9iago8PAovVGl0bGUgKP7/..."
}

Resposta com status positivo#

JSON
{
    "status": "positivo",
    "mensagem": "Não foi possível atender a sua solicitação. Favor comparecer a repartição fiscal.",
    "pdf": null
}

Resposta com status indefinido#

JSON
{
    "status": "indefinido",
    "mensagem": "Não foi possível processar a consulta. Tente novamente mais tarde.",
    "pdf": null
}

Resposta com status erro#

JSON
{
    "status": "erro",
    "mensagem": "Serviço indisponível no momento. Tente novamente mais tarde."
}