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 7 Next »

O que é

A certidão de débitos tributários da Fazenda de Minas Gerais atesta que a pessoa ou empresa tem ou não débitos tributários em Minas Gerais.

Veja mais informações em nossa central de ajuda: Fazenda MG - Certidão de Débitos Tributários

Sobre a requisição:

Método: POST

Endereço: URL Base + /api/maestro/fazenda-mg/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

uf

string

Sim

Unidade da federação. Este campo é preenchido com a sigla do estado ou Distrito Federal ( df )

cpfCnpj

string

Obrigatório caso o campo inscricaoEstadualMg não seja informado

CPF ou CNPJ a ser pesquisado, com ou sem máscara. Exemplos: 99999999999 ou 999.999.999-99

inscricaoEstadualMg

string

Obrigatório caso o campo cpfCnpj não seja informado

Inscrição Estadual a ser pesquisada, com ou sem máscara

cep

string

Sim

CEP da pessoa ou empresa, com ou sem máscara

numero

string

Não

Número do endereço

complemento

string

Não

Complemento do endereço

tipoComplemento

string

Obrigatório caso o parâmetro complemento seja utilizado

Tipo de complemento do endereço

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.

{
  "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."
    ]
  }
}

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

{
  "dataEmissao": "01/12/2020",
  "dataValidade": "01/03/2021",
  "nome": "FULANO DA SILVA",
  "cpfCnpj": "999.999.999-99",
  "logradouro": "AVENIDA CONTORNO",
  "numero": "123",
  "complemento": "",
  "bairro": "SANTA EFIGENIA",
  "cep": "30110915",
  "distrito": "",
  "municipio": "BELO HORIZONTE",
  "uf": "MG",
  "status": "negativo",
  "pdf": "JVBERi0xLjQKMSAwIG9iago8..."
}
{
  "status": "negativa",
  "pdf": "JVBERi0xLjQKMSAwIG9iago8..."
}

Resposta com erro

{
  "status": "erro",
  "mensagem": "Documento inexistente."
}
  • No labels