Prefeitura SP - Extrato de Débitos de IPTU
O que é
No extrato de débitos de IPTU você verifica se um imóvel possui débitos desta natureza.
Veja mais informações em nossa central de ajuda: Prefeitura SP - Extrato de Débitos de IPTU
Sobre a requisição:
Método: POST
Endereço: URL Base + /api/maestro/prefeitura-sp/extrato-debitos-iptu
URL Base:
Parâmetros do header
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
sql | string | Sim | SQL do imóvel. |
Estrutura da resposta
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
Status 422
Exemplos de retornos do resultado da pesquisa
Valores possíveis do campo “status“
positivo | Foram encontrados 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
1
2
3
4
5
6
7
8
{
"status": "negativo",
"sql": "999.999.9999-9",
"endereco": "AV EM ALGUM LUGAR , 99 AP 99 - CAMBUCI CEP: 99999-999",
"sqlAscendente": [],
"iptu": [],
"pdf": "JVBERi0xLjQKMSAwIG9iago8..."
}1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
{
"status": "positivo",
"sql": "999.999.9999-9",
"endereco": "AV EM ALGUM LUGAR , 99 AP 99 - CAMBUCI CEP: 99999-999",
"sqlAscendente": [
{
"sql": "*999.999.9999-9",
"nl": "01",
"anoExercicio": 2004,
"nivelAscendencia": "1",
"situacao": "DÍVIDA ATIVA PPI: 1501399",
"parcelasEmAberto": "",
"porcentagemDivida": 1.22854
},
{
"sql": "*999.999.9999-9",
"nl": "01",
"anoExercicio": 2003,
"nivelAscendencia": "1",
"situacao": "DÍVIDA ATIVA PPI: 1501399",
"parcelasEmAberto": "",
"porcentagemDivida": 1.22854
}
],
"iptu": [
{
"anoExercicio": 2021,
"nl": "1",
"valorLancado": 1205.5,
"valorDevidoAtualizado": 448.77,
"situacao": "EM ABERTO"
},
{
"anoExercicio": 2020,
"nl": "1",
"valorLancado": 109.56,
"valorDevidoAtualizado": null,
"situacao": "DÍVIDA ATIVA"
}
],
"pdf": "JVBERi0xLjQKMSAwIG9iago8..."
}
Resposta com erro
1
2
3
4
5
{
"status": "erro",
"mensagem": "Imóvel não encontrado",
"pdf": "JVBERi0xLjQKMSAwIG9iago8..."
}