O que é#

Na certidão de situação fiscal e enfitêutica, você pode verificar se um determinado imóvel possui débitos perante a prefeitura.

Sobre a requisição#

Método: POST

Endereço: https://api.plexi.com.br/api/maestro/prefeitura-rj/certidao-situacao-fiscal-enfiteutica-imovel

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
inscricaoImobiliaria string Sim Número da inscrição imobiliária

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
encontrado O cadastro do imóvel foi encontrado.
erro Erro ao buscar informações, seja por documento ou outro dado incorreto

Resposta com status encontrado#

JSON
{
  "status": "encontrado",
  "numeroCertidao": "00-1.234.567/2023-1",
  "nome": "FULANO DE TAL",
  "dataEmissao": "01/01/2020",
  "folha": "01/01",
  "endereco": "RUA EXEMPLO, Nª 123 - CENTRO",
  "inscricaoImobiliaria": "1234567-9",
  "codigoLogradouro": "12345-6",
  "dividaAtiva": {
    "total": null,
    "debitos": [
      {
        "anoLoteGuia": "1998/01/00",
        "mp": null,
        "natureza": "JUDIC",
        "certidaoDividaAtiva": "01-123456-0000",
        "vara": "12",
        "tipoTrib": "PREDIA",
        "iptu": 150.00,
        "tcllpTcl": null,
        "tip": null,
        "tsd": null,
        "dividaApurada": 150.00,
        "valorPagar": null
      },
      {
        "anoLoteGuia": "1999/01/00",
        "mp": null,
        "natureza": "JUDIC",
        "certidaoDividaAtiva": "01-123456-0000",
        "vara": "12",
        "tipoTrib": "PREDIA",
        "iptu": 120.10,
        "tcllpTcl": 110.60,
        "tip": null,
        "tsd": null,
        "dividaApurada": 230.70,
        "valorPagar": null
      }
    ]
  },
  "dividasNaoInscritas": [
    {
      "descricao": "ANO DO CARNÊ 2020 GUIA 00 Nº COTAS 10",
      "tipo": "NORMAL",
      "status": "EM ABERTO",
      "totalLancado": 10000.00,
      "totalPagar": 9000.00,
      "dividas": [
        {
          "cota": "02",
          "dataVencimento": "07/03/2020",
          "valorHistorico": 1000.00,
          "valorPagar": 1000.00
        },
        {
          "cota": "03",
          "dataVencimento": "10/04/2020",
          "valorHistorico": 1000.00,
          "valorPagar": 1000.00
        },
        {
          "cota": "04",
          "dataVencimento": "08/05/2020",
          "valorHistorico": 1000.00,
          "valorPagar": 1000.00
        },
        {
          "cota": "05",
          "dataVencimento": "07/06/2020",
          "valorHistorico": 1000.00,
          "valorPagar": 1000.00
        },
        {
          "cota": "06",
          "dataVencimento": "07/07/2020",
          "valorHistorico": 1000.00,
          "valorPagar": 1000.00
        },
        {
          "cota": "07",
          "dataVencimento": "07/08/2020",
          "valorHistorico": 1000.00,
          "valorPagar": 1000.00
        },
        {
          "cota": "08",
          "dataVencimento": "08/09/2020",
          "valorHistorico": 1000.00,
          "valorPagar": 1000.00
        },
        {
          "cota": "09",
          "dataVencimento": "06/10/2020",
          "valorHistorico": 1000.00,
          "valorPagar": 1000.00
        },
        {
          "cota": "10",
          "dataVencimento": "08/11/2020",
          "valorHistorico": 1000.00,
          "valorPagar": 1000.00
        }
      ]
    }
  ],
  "informacoesComplementares": null,
  "situacaoEnfiteutica": "IMÓVEL REMIDO DE FORO (não será necessário pagar laudêmio)"
}

Resposta com status erro#

JSON
{
  "status": "erro",
  "mensagem": "Inscrição Imobiliária Inválida!",
  "pdf": "JVBERi0xLjQKMSAwIG9iago8..."
}