Diferenças

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

--- integracoes:web-services-retornar-conta-json [28/02/2024 20:46] – denys.tavares
+++ integracoes:web-services-retornar-conta-json [29/02/2024 20:31] (atual) – vivianne.sousa
@@ Linha 8: / Linha 8: @@
 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 da conta.
 </columns>
 \\
@@ Linha 16: / Linha 17: @@
 Com as seguintes informações:
 |URL|http://evolutiva.consensotec.com.br:8106|
-|matricula|999999999|
+|value (matrícula)|101548922|
+|key|solicitar|
 \\
 ===== A Requisição Seria =====
-http://evolutiva.consensotec.com.br:8106/gsan/consultarXXXXXX
+http://evolutiva.consensotec.com.br:8106/gsan/obterDadosConta?key=XXXXXXXXXXXXXXXXXXXXXXXXXXXX&value=101548922
-===== Envio - JSON  =====
-<code javascript>
+===== Retorno com Sucesso - JSON =====
+<code>
 {
-    "key": "fqzc36y8cv-jg1ekgK9-Z9epV_SZSiL_CB_REQ1yFUi-0KSDcbeYlhj6xev5aATX",
+    "key": "xxxxxxxxxxxxxx",
-    "matricula": "999999999"
+    "error": 0,
+    "cc": [
+        {
+            "a": "101548922",
+            "b": "09/2022",
+            "c": "09/09/2022",
+            "d": "702.07"
+        }
+    ],
+    "dd": [],
+    "a": "101548922",
+    "b": "4944",
+    "c": "09/2022",
+    "d": "09/09/2022",
+    "e": "702.07",
+    "f": "27",
+    "h": "309.93",
+    "i": "302.07",
+    "j": "92.26",
+    "k": "2.19",
+    "l": "0.00",
+    "m": "100.00",
+    "n": "001.005.105.0303.000",
+    "o": "110",
+    "p": "33",
+    "q": "null",
+    "r": "COMERCIAL",
+    "s": "1",
+    "t": "4944",
+    "u": "JOSEVALDO FERNANDES BATISTA",
+    "v": "02/09/2022",
+    "w": "02/08/2022",
+    "x": "31",
+    "y": "5044",
+    "z": "5044",
+    "aa": "27",
+    "ba": "27",
+    "ca": "0",
+    "da": "MEDIA DO HIDROMETRO",
+    "ea": "826700000076020700100017000004944013092022300039",
+    "ka": "00020126460014BR.GOV.BCB.PIX0114091236540001870206DEBITO5204000053039865406702.075802BR5906CAGEPA6007PARAIBA62290525001000004944010920223000363047442"
 }
 </code>
-\\
+- Descrição das colunas
-===== Retorno com Sucesso - JSON =====
-===== Retorno em Caso de Sucesso =====
-<code javascript>
-{
-    "body": {
         "A": (String) Id da Conta,
         "B": (String) Id do Imóvel,
-        "V1": (String) Valor Total,
+        "C": (String) Referência,
-        "V2": (String) Valor do Débito,
+        "D": (String) Data de Vencimento,
-        "V3": (String) Valor do Serviço,
+        "E": (String) Valor Total
-        "V4": (String) Valor da Taxa,
+        "F": (String) Volume Faturado,
-        "V5": (String) Valor do Imposto,
+        "G": (String) Data Pagamento,
-        "V6": (String) Valor do Desconto,
+        "H": (String) Valor Agua,
-        "V7": (String) Valor do Acréscimo,
+        "I": (String) Valor Esgoto,
-        "C": (String) Data de Emissão,
+        "J": (String) Valor Débitos,
-        "D": (String) Data de Validade,
+        "K": (String) Valor Créditos,
-        "E": (String) Nome do Cliente,
+        "L": (String) Valor Impostos,
-        "F": (String) CPF/CNPJ,
+        "M": (String) Percentual Esgoto,
-        "G": (String) Endereço,
+        "N": (String) Inscrição,
-        "H": (String) Bairro,
+        "O": (String) Grupo,
-        "I": (String) Cidade,
+        "P": (String) Rota,
-        "J": (String) Cep,
+        "Q": (String) Seq Rota,
-        "K": (String) UF,
+        "R": (String) Categoria,
-        "L": (String) Inscrição,
+        "S": (String) Economias,
-        "M": (String) Perfil do Imóvel,
+        "T": (String) Id Cliente,
-        "N": (String) Situação de Água,
+        "U": (String) Nome Cliente,
-        "O": (String) Situação de Esgoto,
+        "V": (String) Data Leitura Atual,
-        "P": (String) Economias 1,
+        "W": (String) Data Leitura Anterior,
-        "Q": (String) Economias 2,
+        "X": (String) Dias Consumo,
-        "R": (String) Economias 3,
+        "Y": (String) Leitura Atual,
-        "S": (String) Economias 4,
+        "Z": (String) Leitura Anterior,
-        "T": (String) Código de Barras,
+        "AA": (String) Média Mes,
-        "U": (String) Código PIX,
+        "BA": (String) Consumo Faturado,
-  - No caso das contas visualizadas no extrato, o sistema traz os seguintes dados:
+        "CA": (String) Consumo Medido,
-        "A": (String) Id da Conta,
+        "DA": (String) Descriçao Consumo,
-        "B": (String) Referência,
+        "EA": (String) Código Barras,
-        "C": (String) Data de Vencimento,
+        "FA": (String) Endereço,
-        "D": (String) Valor
+        "GA": (String) Bairro,
+        "HA": (String) Municipio,
+        "IA": (String) UF,
+        "JA": (String) Cep,
+        "KA": (String) Código Pix,
-  - No caso dos documentos de pagamento visualizados no extrato, o sistema traz os seguintes dados:
-        "A": (String) Id,
-        "B": (String) Tipo,
-        "C": (String) Nome,
-        "D": (String) Valor,
-        "E": (String) Ano/Mês Referência,
-        "F": (String) Ano/Mês Cobrança,
-        "G": (String) Ano/Mês Contábil,
-        "H": (String) Número da Prestação,
-        "I": (String) Número de Prestações Cobradas,
-    }
-}
-</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.