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-concluir-parcelamento

Web Service Concluir Parcelamento

O WebService recebe apenas requisições do tipo GET, e os parâmetros são passados via Query Parameter.

São esperados os seguintes parâmetros:

Parâmetro Valor Tipo
matricula Id do imóvelStringobrigatório
hash hash utilizado para identificar o parcelamentoStringobrigatório
email Email para onde será enviado a conclusão do parcelamentoStringopcional
parcelas Quantidade de parcelasStringobrigatório

Observação: Se o email for informado, o cliente recebe a guia de entrada e o termo de parcelamento por email.

Exemplo de Requisição
https://<URL_GSAN>:<porta>/gsan/concluirParcelamentoChatBot?matricula=70380627&hash=0195f2e1-22b9-1826-841d-6cc2823505c286cc&parcelas=1&email=teste@email.com
Retornos

Com sucesso: (retorna o ID do parcelamento)

{
    "body": 630042
}

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-concluir-parcelamento.txt · Última modificação: 15/09/2025 14:29 por vivianne.sousa