O que é#
A certidão de débitos tributários da Fazenda de Mato Grosso do Sul atesta que a pessoa ou empresa tem ou não débitos tributários em Mato Grosso do Sul.
Sobre a requisição#
Método: POST
Endereço: https://api.plexi.com.br/api/maestro/fazenda-ms/certidao-debitos-tributarios
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 | Obrigatório caso o campo inscricaoEstadual não seja informado | CPF ou CNPJ a ser pesquisado, com ou sem máscara. Exemplos: 99999999999 ou 999.999.999-99 |
| inscricaoEstadual | string | Obrigatório caso o campo cpfCnpj não seja informado | Inscrição Estadual a ser pesquisada, com ou sem máscara |
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 |
| indefinido | Não é possível informar se a pessoa ou empresa possui débitos relacionados ao documento pesquisado |
| erro | Ocorre quando o documento informado não existe |
Resposta com registro encontrado
JSON
{
"status": "negativo",
"cpfCnpj": "999.999.999-99",
"inscricaoEstadual": "99.999.999-9",
"dataHoraEmissao": "01/01/2020",
"numeroCertidao": "999999/2024",
"pdf": "JVBERi0xLjQKMSAwIG9iago8..."
}JSON
{
"status": "indefinido",
"cpfCnpj": "999.999.999-99",
"inscricaoEstadual": "99.999.999-9",
"dataHoraEmissao": "01/01/2020 10:40:47",
"mensagem": "Não foi possível a emissão da sua Certidão Negativa. Para verificar a existência de pendência, procure a Agência Fazendária mais próxima ou acesse o módulo de informações fiscais, através do Portal do ICMS Transparente: http://efazenda.servicos.ms.gov.br/e-fazenda/login.aspx.",
"pdf": "JVBERi0xLjQKMSAwIG9iago8PAovVGl0bGUgKP7/..."
}Resposta com erro
JSON
{
"status": "erro",
"mensagem": "Documento inexistente."
}
