Prefeitura SP - Certidão de Dados Cadastrais do Imóvel

O que é

Na consulta Prefeitura SP - Certidão de Dados Cadastrais do Imóvel - IPTU - você obtém a certidão de dados cadastrais de um imóvel (IPTU) registrado na Prefeitura de São Paulo.

Sobre a requisição:

Método: POST

Endereço: URL Base + /api/maestro/prefeitura-sp/certidao-dados-cadastrais-imovel-iptu

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 de login
senha	string	Sim	Senha para login
sql	string	Sim	Número do cadastro do imóvel (também chamado de número do contribuinte ou SQL)
anoExercicio	string	Sim	Ano de exercício do IPTU

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
cadastrado	Imóvel encontrado
erro	Erro ao buscar informações, seja por SQL inválido ou outro dado incorreto

Respostas com registro encontrado

JSON

{
  "status": "cadastrado",
  "dataEmissao": "01/01/2020",
  "dataValidade": "01/04/2020",
  "numeroDocumento": "1.2020.000000001-1",
  "solicitante": "FULANO DE TAL (CPF 999.999.999-99)",
  "localImovel": {
    "endereco": "RUA EXEMPLO, 999",
    "cep": "99999-999"
  },
  "enderecoEntregaNotificacao": {
    "endereco": "RUA EXEMPLO, 999 - SALA 99 BAIRRO EXEMPLO SAO PAULO SP",
    "cep": "99999-999"
  },
  "contribuintes": [
    {
      "cpfCnpj": "99.999.999/9999-99",
      "nome": "EMPRESA EXEMPLO LTDA"
    },
    {
      "cpfCnpj": "999.999.999-99",
      "nome": "FULANO DE TAL"
    }
  ],
  "dadosCadastraisTerreno": {
    "areaIncorporada": 171,
    "areaNaoIncorporada": 0,
    "areaTotal": 171,
    "testada": "7,39",
    "fracaoIdeal": "1,0000"
  },
  "dadosCadastraisConstrucao": {
    "mensagem": "Terreno sem construção",
    "dados": null
  },
  "valoresMetroQuadrado": {
    "terreno": 7417,
    "construcao": 0
  },
  "valoresCalculoIPTU": {
    "areaIncorporada": 1268307,
    "areaNaoIncorporada": 0,
    "construcao": 0,
    "baseCalculoIPTU": 1268307
  },
  "pdf": "JVBERi0xLjQKMSAwIG9iago8..."
}

JSON

{
  "status": "cadastrado",
  "dataEmissao": "01/01/2020",
  "dataValidade": "01/04/2020",
  "numeroDocumento": "1.2020.000000002-1",
  "solicitante": "FULANO DE TAL (CPF 999.999.999-99)",
  "localImovel": {
    "endereco": "RUA EXEMPLO, 999",
    "cep": "99999-999"
  },
  "enderecoEntregaNotificacao": {
    "endereco": "AVENIDA EXEMPLO, 999 - SALA 99 BAIRRO EXEMPLO SAO PAULO SP",
    "cep": "99999-999"
  },
  "contribuintes": [
    {
      "cpfCnpj": "999.999.999-99",
      "nome": "FULANO DE TAL"
    }
  ],
  "dadosCadastraisTerreno": {
    "areaIncorporada": 191,
    "areaNaoIncorporada": 0,
    "areaTotal": 191,
    "testada": "22,70",
    "fracaoIdeal": "1,0000"
  },
  "dadosCadastraisConstrucao": {
    "mensagem": "",
    "dados": {
      "areaConstruida": 250,
      "areaOcupadaConstrucao": 190,
      "anoConstrucaoCorrigido": 1970,
      "uso": "comercial",
      "padraoConstrucao": "3-B"
    }
  },
  "valoresMetroQuadrado": {
    "terreno": 7417,
    "construcao": 1726
  },
  "valoresCalculoIPTU": {
    "areaIncorporada": 1001712,
    "areaNaoIncorporada": 0,
    "construcao": 159655,
    "baseCalculoIPTU": 1161367
  },
  "pdf": "JVBERi0xLjQKMSAwIG9iago8..."
}

Resposta com erro

JSON

{
  "status": "erro",
  "mensagem": "Notificações de Lançamento inexistentes para os dados informados",
  "pdf": "JVBERi0xLjQKMSAwIG9iago8..."
}

JSON

{
  "status": "erro",
  "mensagem": "Número do cadastro do imóvel inválido",
  "pdf": "JVBERi0xLjQKMSAwIG9iago8..."
}

JSON

{
  "status": "erro",
  "mensagem": "Não é possível gerar o documento. Verifique o Número do Cadastro do Imóvel.",
  "pdf": "JVBERi0xLjQKMSAwIG9iago8..."
}