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.

Sobre a requisição#

Método: POST

Endereço: https://api.plexi.com.br/api/maestro/prefeitura-sp/extrato-debitos-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
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	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#

JSON

{
  "status": "negativo",
  "sql": "999.999.9999-9",
  "endereco": "AV EM ALGUM LUGAR , 99 AP 99 - CAMBUCI CEP: 99999-999",
  "sqlAscendente": [],
  "iptu": [],
  "pdf": "JVBERi0xLjQKMSAwIG9iago8..."
}

JSON

{
    "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",
            "porcentagemDivida": 1.22854
        }
    ],
    "iptu": [
        {
            "anoExercicio": 2021,
            "nl": "1",
            "valorDevidoAtualizado": 448.77,
            "situacao": "EM ABERTO",
            "parcelas": [
                {
                    "parcela": 1,
                    "nl": "1",
                    "vencimento": "10/02/2023",
                    "lancado": 140.28,
                    "atualizado": 140.28,
                    "situacao": "Parcela em Aberto"
                },
                {
                    "parcela": 2,
                    "nl": "1",
                    "vencimento": "10/03/2023",
                    "lancado": 140.28,
                    "atualizado": 140.28,
                    "situacao": "Parcela em Aberto"
                },
                {
                    "parcela": 3,
                    "nl": "1",
                    "vencimento": "10/04/2023",
                    "lancado": 140.28,
                    "atualizado": 140.28,
                    "situacao": "Parcela em Aberto"
                },
                {
                    "parcela": 4,
                    "nl": "1",
                    "vencimento": "10/05/2023",
                    "lancado": 140.28,
                    "atualizado": 140.28,
                    "situacao": "Parcela em Aberto"
                },
                {
                    "parcela": 5,
                    "nl": "1",
                    "vencimento": "10/06/2023",
                    "lancado": 140.28,
                    "atualizado": 140.28,
                    "situacao": "Parcela em Aberto"
                },
                {
                    "parcela": 6,
                    "nl": "1",
                    "vencimento": "10/07/2023",
                    "lancado": 140.28,
                    "atualizado": 140.28,
                    "situacao": "Parcela em Aberto"
                },
                {
                    "parcela": 7,
                    "nl": "1",
                    "vencimento": "10/08/2023",
                    "lancado": 140.28,
                    "atualizado": 140.28,
                    "situacao": "Parcela em Aberto"
                },
                {
                    "parcela": 8,
                    "nl": "1",
                    "vencimento": "10/09/2023",
                    "lancado": 140.28,
                    "atualizado": 140.28,
                    "situacao": "Parcela em Aberto"
                },
                {
                    "parcela": 9,
                    "nl": "1",
                    "vencimento": "10/10/2023",
                    "lancado": 140.28,
                    "atualizado": 140.28,
                    "situacao": "Parcela em Aberto"
                },
                {
                    "parcela": 10,
                    "nl": "1",
                    "vencimento": "10/11/2023",
                    "lancado": 140.28,
                    "atualizado": 140.28,
                    "situacao": "Parcela em Aberto"
                }
            ]
        },
        {
            "anoExercicio": 2020,
            "nl": "1",
            "valorDevidoAtualizado": null,
            "situacao": "DÍVIDA ATIVA",
            "parcelas": []
        }
    ]
}

Resposta com erro#

JSON

{
  "status": "erro",
  "mensagem": "Imóvel não encontrado",
  "pdf": "JVBERi0xLjQKMSAwIG9iago8..."
}