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-retornar-extrato-json

Diferenças

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

Link para esta página de comparações

Ambos lados da revisão anteriorRevisão anterior
Próxima revisão
Revisão anterior
integracoes:web-services-retornar-extrato-json [29/02/2024 19:19] denys.tavaresintegracoes:web-services-retornar-extrato-json [21/03/2024 19:13] (atual) vivianne.sousa
Linha 8: Linha 8:
  
 Os seguinte parâmetros são esperados: Os seguinte parâmetros são esperados:
-  - matricula (Obrigatório), //String// contendo o identificador do imóvel.+  - key (Obrigatório),//String// chave  
 +  - value (Obrigatório), //String// contendo o identificador do imóvel. 
 +  - iac (Obrigatório), //String// indicador de acréscimos por impontualidade. 
 +  - itx (Obrigatório), //String// indicador de geração de taxa de emissão. 
 +  - ret (Opcional), //String// retorno tipo (PDF caso retorno seja PDF, caso contrário JSON) 
 +  - cta (Obrigatório), //String// ids das contas para geração do extrato 
 +  - deb (Opcional), //String// ids dos debitos a cobrar para geração do extrato
 </columns> </columns>
 \\ \\
Linha 16: Linha 22:
 Com as seguintes informações: Com as seguintes informações:
 |URL|http://evolutiva.consensotec.com.br:8106| |URL|http://evolutiva.consensotec.com.br:8106|
-|value (matrícula)|101548922|+|value |101548922|
 |key|solicitar| |key|solicitar|
 +|iac|2 |
 +|itx|2 |
 +|cta|101548922 |
 \\ \\
  
 ===== A Requisição Seria ===== ===== A Requisição Seria =====
  
-http://evolutiva.consensotec.com.br:8106/gsan/gerarExtrato?key=XXXXXXXXXXXXXXXXXXXXX&value=4944&iac=2&itx=2&ret=1cta=101548922+http://evolutiva.consensotec.com.br:8106/gsan/gerarExtrato?key=XXXXXXXXXXXXXXXXXXXXX&value=4944&iac=2&itx=2&cta=101548922
  
  
 ===== Retorno com Sucesso - JSON ===== ===== Retorno com Sucesso - JSON =====
  
 +<code>
 { {
-    "key": "skQcH2g7fvQ5A3nOo3P2fNPIVFvMm_Qj3VRkMaJzghVEoXS0Dzi6l0C-BuD-JunU",+    "key": "xxxxxxxx",
     "error": 0,     "error": 0,
     "cc": [     "cc": [
Linha 67: Linha 76:
 } }
  
 +</code>
 - Descrição das colunas - Descrição das colunas
  
Linha 98: Linha 108:
         "U": (String) Código PIX          "U": (String) Código PIX 
  
-</code> 
-\\ 
  
-**Exemplo**: 
- 
-<code javascript> 
-  
-{ 
-    "body": { 
-        "referencia": "202111", 
-        "valorTotal": "888,24", 
-        "dataAtual": "23/11/2021", 
-        "valorDataAtual": "165,00" 
-    } 
-} 
-</code> 
-===== Retorno com Insucesso - JSON =====  
-<code javascript> 
-{ 
-    "key": "fqzc36y8cv-jg1ekgK9-Z9epV_SZSiL_CB_REQ1yFUi-0KSDcbeYlhj6xev5aATX", 
-    "error": 422, 
-    "qtd": 0, 
-    "resultado": { 
-        "motivo": "A pesquisa não retornou resultados." 
-    } 
-} 
-</code> 
-\\ 
- 
-===== Possíveis Códigos de Retorno ===== 
-|Código|Mensagem|Body 
-|200|"OK"| 
-|500|"Internal Server Error"| 
-|404|"Page not found"| 
-|422|"Unprocessable Entity"| 
- 
-\\ 
  
 Clique **[[=treinamentos:integracoes|AQUI]]** para acessar outros serviços com os detalhes técnicos das integrações. Clique **[[=treinamentos:integracoes|AQUI]]** para acessar outros serviços com os detalhes técnicos das integrações.
integracoes/web-services-retornar-extrato-json.1709234393.txt.gz · Última modificação: 29/02/2024 19:19 por denys.tavares