Fazenda RS - Certidão de Situação Fiscal

O que é#

A certidão de débitos tributários da Fazenda do Rio Grande do Sul atesta que a pessoa ou empresa tem ou não débitos tributários do Rio Grande do Sul.

Sobre a requisição#

Método: POST

Endereço: https://api.plexi.com.br/api/maestro/fazenda-rs/certidao-situacao-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.

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
indefinido	Não foi possível determinar se a pessoa ou empresa possui débitos. Retornado em duas situações: (1) a SEFAZ/RS sinaliza que a certidão está em processamento; ou (2) o portal exibe o popup do e-CAC informando que existem certidões positivas ou positivas com efeito de negativa disponíveis apenas para o sujeito da certidão (neste caso, o contribuinte possui débitos, mas o portal exige autenticação para exibir a certidão correspondente).
negativo	NÃO foram encontrados débitos para o documento pesquisado
erro	Houve algum erro na geração da certidão

O status indefinido é retornado quando a SEFAZ/RS não permite determinar, de forma pública, se o documento pesquisado possui débitos. Isso ocorre nos cenários em que o portal informa que a certidão está em processamento ou quando apresenta o popup do e-CAC indicando que existem certidões positivas ou positivas com efeito de negativa disponíveis apenas para o sujeito da certidão. Nesses casos a resposta traz apenas os campos status e pdf, sem o campo mensagem.

Respostas com registro encontrado

JSON

{
  "status": "negativo",
  "cpfCnpj": "99.999.999/9999-99",
  "nome": "EMPRESA EXEMPLO LTDA",
  "numeroCertidao": "9999999999",
  "numeroAutenticacao": "9999999999",
  "dataValidade": "01/01/2020",
  "pdf": "JVBERi0xLjQKMSAwIG9iago8PAovVGl0bGUgKP7/..."
}

JSON

{
  "status": "indefinido",
  "pdf": "JVBERi0xLjQKMSAwIG9iago8PAovVGl0bGUgKP7/..."
}

Erro

JSON

{
  "status": "erro",
  "mensagem": "Dados disponíveis não geraram certidão negativa. Consulte o e-CAC ou o serviço Certidão de Situação Fiscal no site.",
  "pdf": "JVBERi0xLjQKMSAwIG9iago8PAovVGl0bGUgKP7/..."
}

JSON

{
  "status": "erro",
  "mensagem": "Certidão em processamento.Consulte novamente em até 24 horas.",
  "pdf": "JVBERi0xLjQKMSAwIG9iago8PAovVGl0bGUgKP7/..."
}