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

Diferenças

Aqui você vê as diferenças entre duas revisões dessa página.

Link para esta página de comparações

Próxima revisão
Revisão anterior
integracoes:web-services-dia-atual-vencimento [25/10/2025 23:39] – criada jefferson.araujointegracoes:web-services-dia-atual-vencimento [08/11/2025 22:45] (atual) – ajuste jefferson.araujo
Linha 3: Linha 3:
 ====== Web Service Dia Atual de 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. +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: São esperados os seguintes parâmetros:
Linha 9: Linha 9:
 |**Parâmetro** |**Valor** |**Tipo** | |**Parâmetro** |**Valor** |**Tipo** |
 |matricula|Matrícula do Imóvel|String| |matricula|Matrícula do Imóvel|String|
 +
 +Descrição dos Campos de Retorno:
 +
 +|**Campos** |**Tipo** |**Descrição** |
 +|dia|Inteiro|Representa o dia de vencimento atual. É obtido a partir do imóvel ou, caso não esteja definido, do grupo de faturamento.|
 +|mesesCarenciaAlteracao|Inteiro|Indica 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 == == Exemplo de Requisição ==
Linha 21: Linha 27:
 <columns> Com sucesso: <columns> Com sucesso:
  
-Caso imóvel exista e tenha um dia informado. +Caso imóvel **exista**.
 <code javascript> <code javascript>
-{ +{"body":{"dia":22,"mesesCarenciaAlteracao":5}}
-    "body": { +
-        "dia": +
-    } +
-} +
-</code>+
  
-Caso imóvel exista e **NÃO** tenha um dia informado. 
- 
-<code javascript> 
-{ 
-    "body": {} 
-} 
 </code> </code>
  
-Caso NÂO exista imóvel. +Caso **NÃO** exista imóvel.
 <code javascript> <code javascript>
 {} {}
 +
 </code> </code>
  
integracoes/web-services-dia-atual-vencimento.1761435569.txt.gz · Última modificação: 25/10/2025 23:39 por jefferson.araujo