O que é
Na Certidão conjunta de débitos de tributos imobiliários você verifica se um imóvel possui débitos desta natureza.
Veja mais informações em nossa central de ajuda: Prefeitura SP - Certidão Conjunta de Débitos de Tributos Imobiliários
Sobre a requisição:
Método: POST
Endereço: URL Base + /api/maestro/prefeitura-sp/certidao-tributaria-mobiliaria
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 |
---|---|---|---|
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.
{ "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 |
---|---|
positivo | O imóvel possui 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
{ "status": "negativo", "numeroCertidao": "0001074181-2021", "numeroContribuinte": "010.074.0041-2", "nomeContribuinte": "INFORMAÇÃO PROTEGIDA POR SIGILO FISCAL", "localImovel": "R DA CONSOLACAO 01416-000", "cepImovel": "01416-000", "dataLiberacao": "06/10/2021", "dataValidade": "04/04/2022", "pdf": "JVBERi0xLjQKMSAwIG9iago8..." }
{ "status": "positivo", "numeroCertidao": null, "numeroContribuinte": null, "nomeContribuinte": null, "localImovel": null, "cepImovel": null, "dataLiberacao": null, "dataValidade": null, "pdf": "JVBERi0xLjQKMSAwIG9iago8..." }
Resposta com erro
{ "status": "erro", "mensagem": "SQL informado não existe na Base. Informe um SQL válido", "pdf": "JVBERi0xLjQKMSAwIG9iago8..." }