Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

O que é

Sobre a requisição:

Método: POST

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

...

Include Page
URL Base
URL Base

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

Include Page
Status 201
Status 201

...

Include Page
status 422
status 422

Exemplos de retornos do resultado da pesquisa

Valores possíveis do campo “status“

...

Code Block
languagejson
{
  "status": "cadastrado",
  "dataEmissao": "30/08/2021",
  "dataValidade": "28/11/2021",
  "numeroDocumento": "21.2021.002912714-81",
  "solicitante": "JOAOFULANO LUIZDA COUTINHO DRUMMONDSILVA (CPF 08999.375999.946999-5099)",
  "localImovel": {
    "endereco": "R DA CONSOLACAO, 26769999 - /26789999",
    "cep": "0141699999-000999"
  },
  "enderecoEntregaNotificacao": {
    "endereco": "R DA CONSOLACAO, 14009999 - 20 ANDAR SALA 1399 AGUA BRANCA SAO PAULO SP",
    "cep": "0130299999-001999"
  },
  "contribuintecontribuintes": [
    {
      "cpfCnpj": "1899.967999.840999/00019999-9399",
      "nome": "NOVA PAULISTA EMPR IMOBILIARIOS LTDACONSTRUTORA ANDALUZIA LTDA."
    },
    {
      "cpfCnpj": "99.999.999-99",
      "nome": "FULANO DA SILVA"
    }
  ],
  "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..."
}
Code Block
languagejson
{
  "status": "cadastrado",
  "dataEmissao": "30/08/2021",
  "dataValidade": "28/11/2021",
  "numeroDocumento": "21.2021.002912719-91",
  "solicitante": "JOAOFULANO LUIZDA COUTINHO DRUMMONDSILVA (CPF 08999.375999.946999-5099)",
  "localImovel": {
    "endereco": "R DA CONSOLACAO, 26429999 - /26449999 E 26469999",
    "cep": "0141699999-000999"
  },
  "enderecoEntregaNotificacao": {
    "endereco": "AVENIDA FRANCISCO MATARAZZOBRASIL, 14009999 - TORRE TORINO 20A AGUA BRANCA SAO PAULO",
    "cep": "0500199999-903999"
  },
  "contribuintecontribuintes": [
    {
      "cpfCnpj": "18999.967999.840/0001999-9399",
      "nome": "NOVAFULANO PAULISTADA EMPREENDIMENTOSILVA"
IMOBILIARIOS LTDA"   }
  ],
  "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..."
}

...