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:


A Requisição Seria

Envio - JSON

{
    "key": "fqzc36y8cv-jg1ekgK9-Z9epV_SZSiL_CB_REQ1yFUi-0KSDcbeYlhj6xev5aATX",
    "matricula": "999999999"
}


Retorno com Sucesso - JSON

Retorno em Caso de Sucesso

{
    "body": {
        "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) Referência,
        "C": (String) Data de Vencimento,
        "D": (String) Valor
 
  - 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,
 
    }
}


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.1709153176.txt.gz · Última modificação: 28/02/2024 20:46 por denys.tavares