Diferenças

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

--- integracoes:web-services-retornar-conta-json [29/02/2024 18:03] – denys.tavares
+++ integracoes:web-services-retornar-conta-json [29/02/2024 20:31] (atual) – vivianne.sousa
@@ Linha 2: / Linha 2: @@
-====== WebService Retornar Extrato Json ======
+====== WebService Retornar Conta Json ======
 <columns>
@@ 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 22: / Linha 23: @@
 ===== A Requisição Seria =====
-http://evolutiva.consensotec.com.br:8106/gsan/obterDadosConta?key=XXXXXXXXXXXXXXXXXXXX&value=101548922
+http://evolutiva.consensotec.com.br:8106/gsan/obterDadosConta?key=XXXXXXXXXXXXXXXXXXXXXXXXXXXX&value=101548922
 ===== Retorno com Sucesso - JSON =====
+<code>
-  - Extrato
 {
-    "key": "skQcH2g7fvQ5A3nOo3P2fNPIVFvMm_Qj3VRkMaJzghVEoXS0Dzi6l0C-BuD-JunU",
+    "key": "xxxxxxxxxxxxxx",
     "error": 0,
     "cc": [
@@ Linha 42: / Linha 40: @@
     ],
     "dd": [],
-    "a": "33663642",
+    "a": "101548922",
     "b": "4944",
-    "v1": "702.07",
+    "c": "09/2022",
-    "v2": "702.07",
+    "d": "09/09/2022",
-    "v3": "0.00",
+    "e": "702.07",
-    "v4": "0",
+    "f": "27",
-    "v5": "",
+    "h": "309.93",
-    "v6": "0",
+    "i": "302.07",
-    "v7": "0.00",
+    "j": "92.26",
-    "c": "26/02/2024",
+    "k": "2.19",
-    "d": "04/03/2024",
+    "l": "0.00",
-    "e": "JOSEVALDO FERNANDES BATISTA",
+    "m": "100.00",
-    "f": "42432197453",
+    "n": "001.005.105.0303.000",
-    "g": "RUA GAMA E MELO - 110 -  - VARADOURO JOAO PESSOA PB 58010-450",
+    "o": "110",
-    "h": "VARADOURO",
+    "p": "33",
-    "i": "JOAO PESSOA",
+    "q": "null",
-    "j": "58010-450",
+    "r": "COMERCIAL",
-    "k": "PB",
+    "s": "1",
-    "l": "001.005.105.0303.000",
+    "t": "4944",
-    "m": "NORMAL",
+    "u": "JOSEVALDO FERNANDES BATISTA",
-    "n": "LIGADO",
+    "v": "02/09/2022",
-    "o": "LIGADA",
+    "w": "02/08/2022",
-    "q": "1",
+    "x": "31",
-    "t": "826600000077020700100017000004944039366364214150",
+    "y": "5044",
-    "u": "00020126460014BR.GOV.BCB.PIX0114091236540001870206DEBITO5204000053039865406702.075802BR5906CAGEPA6007PARAIBA62290525001000004944033663642141563048BBA"
+    "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
-        "A": (String) Id da Conta,
-        "B": (String) Id do Imóvel,
-        "V1": (String) Valor Total,
-        "V2": (String) Valor do Débito,
-        "V3": (String) Valor do Serviço,
-        "V4": (String) Valor da Taxa,
-        "V5": (String) Valor do Imposto,
-        "V6": (String) Valor do Desconto,
-        "V7": (String) Valor do Acréscimo,
-        "C": (String) Data de Emissão,
-        "D": (String) Data de Validade,
-        "E": (String) Nome do Cliente,
-        "F": (String) CPF/CNPJ,
-        "G": (String) Endereço,
-        "H": (String) Bairro,
-        "I": (String) Cidade,
-        "J": (String) Cep,
-        "K": (String) UF,
-        "L": (String) Inscrição,
-        "M": (String) Perfil do Imóvel,
-        "N": (String) Situação de Água,
-        "O": (String) Situação de Esgoto,
-        "P": (String) Economias 1,
-        "Q": (String) Economias 2,
-        "R": (String) Economias 3,
-        "S": (String) Economias 4,
-        "T": (String) Código de Barras,
-        "U": (String) Código PIX
-  - No caso das contas visualizadas no extrato, o sistema traz os seguintes dados:
         "A": (String) Id da Conta,
@@ Linha 140: / Linha 113: @@
         "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.