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-listar-debitos

WebService Listar Débitos do Imóvel

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 imóvel que pretende pesquisar.


Exemplo de Requisição para o Sistema

Com as seguintes informações:

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


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,
   "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
      }
   ],
   "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:


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:


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

integracoes/web-services-listar-debitos.txt · Última modificação: 13/03/2020 14:20 por diego.ferreira