O que é#
A certidão de débitos tributários da Fazenda do Rio de Janeiro atesta que a pessoa ou empresa tem ou não débitos tributários no Rio de Janeiro.
Sobre a requisição#
Método: POST
Endereço: URL Base + /api/maestro/fazenda-rj/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. |
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 é 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 |
Respostas com registro encontrado
JSON
{
"status": "negativo",
"cpfCnpj": "99.999.999/9999-99",
"numeroCertidao": "2022.1.9999999-0",
"cadIcms": "Não inscrito",
"dataHoraEmissao": "01/01/2020 00:00",
"dataValidade": "01/04/2020",
"pdf": "JVBERi0xLjQKMSAwIG9iago8PAovVGl0bGUgKP7/..."
}JSON
{
"status": "indefinido",
"pdf": "JVBERi0xLjQKMSAwIG9iago8PAovVGl0bGUgKP7/..."
}
