O que é
Sobre a requisição:
Método: POST
Endereço: URL Base + /api/maestro/prefeitura-sp/certidao-dados-cadastrais-imovel-iptu
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 |
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.
{
"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."
]
}
}
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
{
"status": "cadastrado",
"dataEmissao": "30/08/2021",
"dataValidade": "28/11/2021",
"numeroDocumento": "2.2021.002912714-8",
"solicitante": "JOAO LUIZ COUTINHO DRUMMOND (CPF 089.375.946-50)",
"localImovel": {
"endereco": "R DA CONSOLACAO, 2676 - /2678",
"cep": "01416-000"
},
"enderecoEntregaNotificacao": {
"endereco": "R DA CONSOLACAO, 1400 - 20 ANDAR SALA 13 AGUA BRANCA SAO PAULO SP",
"cep": "01302-001"
},
"contribuinte": {
"cpfCnpj": "18.967.840/0001-93",
"nome": "NOVA PAULISTA EMPR IMOBILIARIOS LTDA"
},
"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..."
}
{
"status": "cadastrado",
"dataEmissao": "30/08/2021",
"dataValidade": "28/11/2021",
"numeroDocumento": "2.2021.002912719-9",
"solicitante": "JOAO LUIZ COUTINHO DRUMMOND (CPF 089.375.946-50)",
"localImovel": {
"endereco": "R DA CONSOLACAO, 2642 - /2644 E 2646",
"cep": "01416-000"
},
"enderecoEntregaNotificacao": {
"endereco": "AVENIDA FRANCISCO MATARAZZO, 1400 - TORRE TORINO 20A AGUA BRANCA SAO PAULO",
"cep": "05001-903"
},
"contribuinte": {
"cpfCnpj": "18.967.840/0001-93",
"nome": "NOVA PAULISTA EMPREENDIMENTO 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..."
}
Resposta com erro
{
"status": "erro",
"mensagem": "Notificações de Lançamento inexistentes para os dados informados",
"pdf": "JVBERi0xLjQKMSAwIG9iago8..."
}
{
"status": "erro",
"mensagem": "Número do cadastro do imóvel inválido",
"pdf": "JVBERi0xLjQKMSAwIG9iago8..."
}
{
"status": "erro",
"mensagem": "Não é possível gerar o documento. Verifique o Número do Cadastro do Imóvel.",
"pdf": "JVBERi0xLjQKMSAwIG9iago8..."
}