Fazenda RS - Consulta de Débitos IPVA

O que é#

A Consulta de Débitos IPVA da FAZENDA RS é um serviço que permite verificar débitos relacionados ao Imposto sobre a Propriedade de Veículos Automotores (IPVA) de veículos registrados no estado do Rio Grande do Sul.

Sobre a requisição#

Método: POST

Endereço: https://api.plexi.com.br/api/maestro/fazenda-rs/veiculos/consulta-debitos-ipva

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
placa	string	Sim	Placa do veículo a ser pesquisado.
renavam	string	Sim	Renavam do veículo a ser pesquisado.

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

JSON

{
    "message": "Os dados fornecidos são inválidos.",
    "errors": {
        "placa": [
            "A placa deve estar em um formato válido (ex: ABC1234, ABC1A23)."
        ],
        "renavam": [
          "O RENAVAM deve conter entre 9 e 11 dígitos."
        ]
    }
}

Exemplos de retornos do resultado da pesquisa#

Resposta com registro encontrado

JSON

{
    "veiculo": {
        "placa": "ABC1234",
        "renavam": 123456789,
        "marca": "VOLKSWAGEN/GOL 1.0 2020",
        "marcaModelo": "VOLKSWAGEN/GOL 1.0 2020",
        "anoFabricacao": 2020,
        "indDebDat": "S"
    },
    "debitos": [
        {
            "valorDebito": 1250.75,
            "dataVencimento": "2020-01-01T00:00:00-03:00",
            "descricaoDebito": "Infrações de trânsito vencidas Novo CTB",
            "tipo": "MULTA",
            "detalhamento": null,
            "anoExercicio": null
        },
        {
            "valorDebito": 2850.50,
            "dataVencimento": "2020-01-01T00:00:00-03:00",
            "descricaoDebito": "IPVA em DAT - Quitação: R$2850,50",
            "tipo": "DAT",
            "detalhamento": [
                "2023: R$1425,25",
                "2024: R$1425,25"
            ],
            "anoExercicio": null
        }
    ],
    "proprietario": {
        "nome": "FULANO DE TAL",
        "tipoDocumento": "1",
        "cpfCnpj": "99999999999"
    },
    "orgao": {
        "nome": "DETRAN RS",
        "cnpj": "99.999.999/9999-99",
        "nomeServico": "Licenciamento de Veículo"
    },
    "resumo": {
        "totalDebitos": 2,
        "valorTotal": 4101.25,
        "dataConsulta": "2020-01-01T00:00:00+00:00"
    },
    "pdf": "JVBERi0xLjQKJcOkw7zDtsO..."
}

Resposta com erro

JSON

{
    "status": "erro",
    "mensagem": "Erro de autorização na consulta de débitos IPVA",
    "pdf": "JVBERi0xLjQKJcOkw7zDtsO..."
}