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-conta-json

Essa é uma revisão anterior do documento!


WebService Retornar Extrato Json

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

Os seguinte parâmetros são esperados:

  1. matricula (Obrigatório), String contendo o identificador do imóvel.


Exemplo de requisição para o sistema

Com as seguintes informações:

URLhttp://evolutiva.consensotec.com.br:8106
value (matrícula)101548922
keysolicitar


A Requisição Seria

Retorno com Sucesso - JSON

  1. Extrato

{

  "key": "skQcH2g7fvQ5A3nOo3P2fNPIVFvMm_Qj3VRkMaJzghVEoXS0Dzi6l0C-BuD-JunU",
  "error": 0,
  "cc": [
      {
          "a": "101548922",
          "b": "09/2022",
          "c": "09/09/2022",
          "d": "702.07"
      }
  ],
  "dd": [],
  "a": "33663642",
  "b": "4944",
  "v1": "702.07",
  "v2": "702.07",
  "v3": "0.00",
  "v4": "0",
  "v5": "",
  "v6": "0",
  "v7": "0.00",
  "c": "26/02/2024",
  "d": "04/03/2024",
  "e": "JOSEVALDO FERNANDES BATISTA",
  "f": "42432197453",
  "g": "RUA GAMA E MELO - 110 -  - VARADOURO JOAO PESSOA PB 58010-450",
  "h": "VARADOURO",
  "i": "JOAO PESSOA",
  "j": "58010-450",
  "k": "PB",
  "l": "001.005.105.0303.000",
  "m": "NORMAL",
  "n": "LIGADO",
  "o": "LIGADA",
  "q": "1",
  "t": "826600000077020700100017000004944039366364214150",
  "u": "00020126460014BR.GOV.BCB.PIX0114091236540001870206DEBITO5204000053039865406702.075802BR5906CAGEPA6007PARAIBA62290525001000004944033663642141563048BBA"

}

- 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,
      "B": (String) Id do Imóvel,
      "C": (String) Referência,
      "D": (String) Data de Vencimento,
      "E": (String) Valor Total
      "F": (String) Volume Faturado,
      "G": (String) Data Pagamento,
      "H": (String) Valor Agua,
      "I": (String) Valor Esgoto,
      "J": (String) Valor Débitos,
      "K": (String) Valor Créditos,
      "L": (String) Valor Impostos,
      "M": (String) Percentual Esgoto,
      "N": (String) Inscrição,
      "O": (String) Grupo,
      "P": (String) Rota,
      "Q": (String) Seq Rota,
      "R": (String) Categoria,
      "S": (String) Economias,
      "T": (String) Id Cliente,
      "U": (String) Nome Cliente,
      "V": (String) Data Leitura Atual,
      "W": (String) Data Leitura Anterior,
      "X": (String) Dias Consumo,
      "Y": (String) Leitura Atual,
      "Z": (String) Leitura Anterior,
      "AA": (String) Média Mes,
      "BA": (String) Consumo Faturado,
      "CA": (String) Consumo Medido,
      "DA": (String) Descriçao Consumo,
      "EA": (String) Código Barras,
      "FA": (String) Endereço,
      "GA": (String) Bairro,
      "HA": (String) Municipio,
      "IA": (String) UF,
      "JA": (String) Cep,
      "KA": (String) Código Pix,      
  1. 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:

{
    "body": {
        "referencia": "202111",
        "valorTotal": "888,24",
        "dataAtual": "23/11/2021",
        "valorDataAtual": "165,00"
    }
}

Retorno com Insucesso - JSON

{
    "key": "fqzc36y8cv-jg1ekgK9-Z9epV_SZSiL_CB_REQ1yFUi-0KSDcbeYlhj6xev5aATX",
    "error": 422,
    "qtd": 0,
    "resultado": {
        "motivo": "A pesquisa não retornou resultados."
    }
}


Possíveis Códigos de Retorno

CódigoMensagem
200“OK”
500“Internal Server Error”
404“Page not found”
422“Unprocessable Entity”


Clique AQUI para acessar outros serviços com os detalhes técnicos das integrações.

integracoes/web-services-retornar-conta-json.1709229822.txt.gz · Última modificação: 29/02/2024 18:03 por denys.tavares