O que é#

A Certidão de Regularidade Fiscal da Prefeitura de Caxias do Sul informa se uma pessoa ou empresa possui débitos administrados pela Secretaria da Receita Municipal. A consulta retorna o PDF oficial emitido pela Prefeitura e os principais dados da certidão.

Sobre a requisição#

Método: POST

Endereço: https://api.plexi.com.br/api/maestro/prefeitura-caxias-do-sul/certidao-regularidade-fiscal

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 Sim CPF ou CNPJ a ser pesquisado (com ou sem formatação)

CNPJ alfanumérico

Esta consulta aceita CNPJ alfanumérico, com ou sem máscara, com letras maiúsculas ou minúsculas. Exemplos: 12.ABC.345/01DE-35 ou 12ABC34501DE35. Saiba mais em CNPJ alfanumérico.

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#

JSON
{
  "message": "The given data was invalid.",
  "errors": {
    "cpfCnpj": [
      "CPF ou CNPJ inválido"
    ]
  }
}

Exemplos de retornos do resultado da pesquisa#

Valores possíveis do campo "status"#

Status Significado
negativo NÃO constam débitos para o documento pesquisado. A Prefeitura emite a Certidão Negativa de Débito.
positivo Constam débitos para o documento pesquisado. A Prefeitura emite a Certidão Positiva.
positivo_negativo Certidão positiva com efeito de negativa. Constam débitos para o documento pesquisado, mas a certidão tem efeito de negativa.
erro A Prefeitura não emitiu a certidão. A mensagem exibida pela Prefeitura é retornada no campo mensagem, e não há PDF nem o objeto dados. Também é retornado quando a fonte recusa o CNPJ alfanumérico informado, com a mensagem A fonte desta consulta não aceita CNPJ alfanumérico..

Campos retornados#

Os campos abaixo são retornados nos status negativo, positivo e positivo_negativo. No status erro, somente status e mensagem estão presentes.

Nome Tipo Descrição
mensagem string Texto integral da declaração presente na certidão ("Certificamos que...").
pdf string Certidão oficial emitida pela Prefeitura, codificada em base64.
dados.nome string Nome ou razão social do contribuinte, conforme consta na certidão.
dados.cpfCnpj string CPF ou CNPJ do contribuinte, com formatação, conforme consta na certidão.
dados.tipoCertidao string Título da certidão: Certidão Negativa de Débito, Certidão Positiva com Efeito de Negativa ou Certidão Positiva.
dados.numeroCertidao string Número da certidão, no formato número/ano.
dados.dataEmissao string Data de emissão, no formato dd/mm/aaaa.
dados.dataValidade string Data de validade, no formato dd/mm/aaaa.
dados.codigoControle string Código de controle da certidão.
dados.numeroRequisicao string Número da requisição informado na certidão.

Resposta com status negativo#

JSON
{
    "status": "negativo",
    "mensagem": "Certificamos que, EMPRESA EXEMPLO LTDA, CNPJ 99.999.999/9999-99, está(ão) quite(s) com os tributos municipais, por não se acharem lançados para pagamento, ressalvando esta Receita Municipal o direito de efetuar a cobrança de débitos que porventura venham a ser apurados. A presente Certidão foi solicitada para fins de COMPROVAÇÃO, e terá validade por 180 dias de sua expedição, de conformidade com o art. 218, da Lei Complementar 701 de 30 de setembro de 2022.",
    "pdf": "JVBERi0xLjQKMSAwIG9iago8PAovVGl0bGUgKP7/...",
    "dados": {
        "nome": "EMPRESA EXEMPLO LTDA",
        "cpfCnpj": "99.999.999/9999-99",
        "tipoCertidao": "Certidão Negativa de Débito",
        "numeroCertidao": "12345/2020",
        "dataEmissao": "15/01/2020",
        "dataValidade": "13/07/2020",
        "codigoControle": "AAAA.BBBB.CCCC.DDDD",
        "numeroRequisicao": "999999"
    }
}

Resposta com status positivo#

JSON
{
    "status": "positivo",
    "mensagem": "Certificamos que em nome de EMPRESA EXEMPLO LTDA, CNPJ 99.999.999/9999-99, constam débitos administrados pela Secretaria da Receita Municipal. Ressaltando, ainda, o direito desta Receita Municipal de efetuar levantamento e cobrança de outros valores que porventura venham a ser apurados. A presente Certidão foi solicitada para fins de COMPROVAÇÃO e terá validade por 180 dias de sua expedição, de conformidade com o art. 218, da Lei Complementar 701 de 30 de Setembro de 2022.",
    "pdf": "JVBERi0xLjQKMSAwIG9iago8PAovVGl0bGUgKP7/...",
    "dados": {
        "nome": "EMPRESA EXEMPLO LTDA",
        "cpfCnpj": "99.999.999/9999-99",
        "tipoCertidao": "Certidão Positiva",
        "numeroCertidao": "12345/2020",
        "dataEmissao": "15/01/2020",
        "dataValidade": "13/07/2020",
        "codigoControle": "AAAA.BBBB.CCCC.DDDD",
        "numeroRequisicao": "999999"
    }
}

Resposta com status positivo_negativo#

JSON
{
    "status": "positivo_negativo",
    "mensagem": "Certificamos que, EMPRESA EXEMPLO LTDA, CNPJ 99.999.999/9999-99, constam débitos administrados pela Secretaria da Receita Municipal, ressalvando esta Receita Municipal o direito de efetuar a cobrança de valores que porventura venham a ser apurados. Inobstante o acima certificado, expede-se a presente certidão positiva com efeitos de negativa. A presente Certidão foi solicitada para fins de COMPROVAÇÃO, e terá validade por 180 dias de sua expedição, de conformidade com o art. 218, da Lei Complementar 701 de 30 de Setembro de 2022.",
    "pdf": "JVBERi0xLjQKMSAwIG9iago8PAovVGl0bGUgKP7/...",
    "dados": {
        "nome": "EMPRESA EXEMPLO LTDA",
        "cpfCnpj": "99.999.999/9999-99",
        "tipoCertidao": "Certidão Positiva com Efeito de Negativa",
        "numeroCertidao": "12345/2020",
        "dataEmissao": "15/01/2020",
        "dataValidade": "13/07/2020",
        "codigoControle": "AAAA.BBBB.CCCC.DDDD",
        "numeroRequisicao": "999999"
    }
}

Resposta com status erro#

Nesse caso, a Prefeitura não emite a certidão. O exemplo abaixo corresponde a um documento sem cadastro municipal.

JSON
{
    "status": "erro",
    "mensagem": "Não foram encontrados cadastros municipais perante os dados informados."
}

Quando a fonte recusa o CNPJ alfanumérico informado:

JSON
{
    "status": "erro",
    "mensagem": "A fonte desta consulta não aceita CNPJ alfanumérico."
}