Base de Conhecimento de Gestão Comercial de Saneamento

A maior base de documentação de GSAN do mercado mantida pela Consenso Tecnologia

Ferramentas do usuário

Ferramentas do site


integracoes:web-services-dia-atual-vencimento

Web Service Dia Atual de Vencimento

O WebService recebe apenas requisições do tipo GET, e os parâmetros são passados via Query Parameter. A funcionalidade irá buscar o dia de vencimento do imóvel informado.

São esperados os seguintes parâmetros:

Parâmetro Valor Tipo
matriculaMatrícula do ImóvelString

Descrição dos Campos de Retorno:

Campos Tipo Descrição
diaInteiroRepresenta o dia de vencimento atual. É obtido a partir do imóvel ou, caso não esteja definido, do grupo de faturamento.
mesesCarenciaAlteracaoInteiroIndica a quantidade de meses desde a última alteração do vencimento (carência). Esse valor é calculado com base na diferença entre a data atual e a data de implantação do último vencimento alternativo registrado para o imóvel. Serve para controlar se o cliente ainda está dentro do período mínimo antes de poder solicitar uma nova alteração de vencimento.
Exemplo de Requisição
https://<URL_GSAN>:<porta>/gsan/chatbot/diaAtualVencimento?matricula=9999999
Retornos

Com sucesso:

Caso imóvel exista.

{"body":{"dia":22,"mesesCarenciaAlteracao":5}}

Caso NÃO exista imóvel.

{}

Com erro:

{
    "error": {
        "parametrosMensagem": [],
        "detailMessage": "Erro de acesso ao banco de dados, favor contactar administrador do sistema.",
        "stackTrace": [],
        "suppressedExceptions": []
    }
}
Possíveis Códigos de Retorno
Código
200“OK”
500“Internal Server Error”
integracoes/web-services-dia-atual-vencimento.txt · Última modificação: 08/11/2025 22:45 por jefferson.araujo