Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Current »

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.

Veja mais informações em nossa central de ajuda: Fazenda RS - Certidão de Situação Fiscal

Sobre a requisição:

Método: POST

Endereço: URL Base + /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.

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

Status 422

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

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

Exemplos de retornos do resultado da pesquisa

Valores possíveis do campo “status“

Status

Significado

indefinido

Não é possível informar se a pessoa ou empresa possui débitos relacionados ao documento pesquisado

negativo

NÃO foram encontrados débitos para o documento pesquisado

erro

Houve algum erro na geração da certidão

Respostas com registro encontrado

{
  "status": "negativo",
  "cpfCnpj": "02.012.862/0001-60",
  "nome": "EMPRESA S/A.",
  "numeroCertidao": "0021328705",
  "numeroAutenticacao": "0031364604",
  "dataValidade": "27/11/2022",
  "pdf": "JVBERi0xLjQKMSAwIG9iago8PAovVGl0bGUgKP7/..."
}
{
  "status": "indefinido",
  "pdf": "JVBERi0xLjQKMSAwIG9iago8PAovVGl0bGUgKP7/..."
}

Erro

{
  "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/..."
}
{
  "status": "erro",
  "mensagem": "Certidão em processamento.Consulte novamente em até 24 horas.",
  "pdf": "JVBERi0xLjQKMSAwIG9iago8PAovVGl0bGUgKP7/..."
}

  • No labels