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-consultar-debitos-imovel-tipo-usuario-ws

WebService Listar Débitos do Imóvel por Cliente do Tipo Usuário no WS


O WebService recebe apenas requisições do tipo GET, e os parâmetros são passados via Query Parameter. Ele espera os seguintes parâmetros:

  1. key, String contendo a chave de autenticação da empresa.
  2. value, String contendo a matrícula do cliente que pretende pesquisar.


Exemplo de requisição para o sistema

Com as seguintes informações:

IP192.168.64.111
Chave de autenticaçãoaBC123DEF
Matrícula975530


A Requisição Seria

Retorno em Caso de Sucesso

{
   "key": "aBC123DEF",
   "error": (Integer) Valor 0,
   "qtd": (Integer) total de dados enviados nas duas coleções,
   "imoveis": [  (Collection) coleção de imóveis pertencentes ao cliente informado
        {
            "matriculaImovel": 235237,
   "cta": [
  {
 "a": (String) Id da Conta,
 "b": (String) anoMês de referência no formato “MM/yyyy”,
 "c": (String) data de vencimento no formato “dd/MM/yyyy”,
 "d": (String) valor do documento,
 "e": (String) situação da conta,
 "f": (String) Acréscimo dos juros de mora + atualização monetária
 "g": (String) Revisão: caso a conta esteja em revisão
  }
   ],
   "deb": [
  {
 "a": (String) Id do débito,
 "b": (String) id do tipo do débito,
 "c": (String) nome do tipo do débito,
 "d": (String) valor do débito,
 "e": (String) ano/Mês de referência no formato “yyyyMM”,
 "f": (String) ano/Mês de cobrança no formato “yyyyMM”,
 "g": (String) ano/Mês contábil no formato “yyyyMM”,
 "h": (String) número da Prestação,
 "i": (String) número de prestações cobradas.
 	 }
      ]
    }
  ]
}


Exemplo:

{
    "key": "aBC123DEF",
    "error": 0,
    "qtd": 3,
    "imoveis": [
        {
            "matriculaImovel": 22942,
            "cta": [],
            "deb": [
                {
                    "a": "17332800",
                    "b": "8149",
                    "c": "ALCALINIDADE - CARBONATOS",
                    "d": "25.00",
                    "e": "",
                    "f": "202404",
                    "g": "202404",
                    "h": "1",
                    "i": "0"
                }
            ]
        },
        {
            "matriculaImovel": 1487361,
            "cta": [
                {
                    "a": "22382734",
                    "b": "12/2023",
                    "c": "15/01/2024",
                    "d": "53.62",
                    "e": "NORMAL",
                    "f": "1.60",
                    "g": "SIM"
                },
                {
                    "a": "22959121",
                    "b": "01/2024",
                    "c": "15/02/2024",
                    "d": "92.45",
                    "e": "RETIFICADA",
                    "f": "1.84",
                    "g": "NAO"
                },
                {
                    "a": "22804666",
                    "b": "02/2024",
                    "c": "15/03/2024",
                    "d": "91.83",
                    "e": "NORMAL",
                    "f": "2.72",
                    "g": "NAO"
                },
                {
                    "a": "22932950",
                    "b": "03/2024",
                    "c": "15/04/2024",
                    "d": "92.57",
                    "e": "NORMAL",
                    "f": "1.81",
                    "g": "NAO"
                }
            ],
            "deb": []
        },
        {
            "matriculaImovel": 1487370,
            "cta": [
                {
                    "a": "22932956",
                    "b": "03/2024",
                    "c": "15/04/2024",
                    "d": "66.37",
                    "e": "NORMAL",
                    "f": "1.32",
                    "g": "NAO"
                }
            ],
            "deb": [
                {
                    "a": "17332801",
                    "b": "1132",
                    "c": "SUBSTITUICAO HID. A PEDIDO",
                    "d": "233.39",
                    "e": "",
                    "f": "202404",
                    "g": "202404",
                    "h": "2",
                    "i": "0"
                }
            ]
        }
    ]
}


Retorno em Caso de erro

{
"error": (Integer) Código de erro da requisição,
"msg": (String) Mensagem indicando o que houve, ou vazio em caso de erro 500,
"qtd": (Integer) sempre valor 0
}

Exemplo:


Exemplo:

{
    "key": "aBC123DEF",
    "error": 1,
    "msg": "Listar Débitos Por Matricula Cliente: Cliente sem imoveis associados",
    "qtd": 0,
    "imoveis": []
}


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

integracoes/web-services-consultar-debitos-imovel-tipo-usuario-ws.txt · Última modificação: 24/04/2024 18:32 por francisco.ferreira