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 Conta 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

{

  "key": "skQcH2g7fvQ5A3nOo3P2fNPIVFvMm_Qj3VRkMaJzghVEoXS0Dzi6l0C-BuD-JunU",
  "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"

}

- Descrição das colunas

    
      "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,      

</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.1709234341.txt.gz · Última modificação: 29/02/2024 19:19 por denys.tavares