Prefeitura SP - Certidão Conjunta de Débitos de Tributos Imobiliários

O que é#

Na Certidão conjunta de débitos de tributos imobiliários você verifica se um imóvel possui débitos desta natureza.

Sobre a requisição#

Método: POST

Endereço: https://api.plexi.com.br/api/maestro/prefeitura-sp/certidao-tributaria-imobiliario

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
sql	string	Sim	SQL do imóvel.

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
positivo	O imóvel possui débitos
negativo	NÃO foram encontrados débitos
erro	Erro ao buscar informações, seja por documento ou outro dado incorreto

Respostas com registro encontrado

JSON

{
  "status": "negativo",
  "numeroCertidao": "9999999999-2020",
  "numeroContribuinte": "999.999.9999-9",
  "nomeContribuinte": "INFORMAÇÃO PROTEGIDA POR SIGILO FISCAL",
  "localImovel": "RUA EXEMPLO 00000-000",
  "cepImovel": "00000-000",
  "dataLiberacao": "01/01/2020",
  "dataValidade": "01/04/2020",
  "pdf": "JVBERi0xLjQKMSAwIG9iago8..."
}

JSON

{
  "status": "positivo",
  "numeroCertidao": null,
  "numeroContribuinte": null,
  "nomeContribuinte": null,
  "localImovel": null,
  "cepImovel": null,
  "dataLiberacao": null,
  "dataValidade": null,
  "pdf": "JVBERi0xLjQKMSAwIG9iago8..."
}

Resposta com erro

JSON

{
  "status": "erro",
  "mensagem": "SQL informado não existe na Base. Informe um SQL válido",
  "pdf": "JVBERi0xLjQKMSAwIG9iago8..."
}