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
Barra lateral
integracoes:web-services-listar-todas-faturas
Tabela de conteúdos
WebService Listar Todas as Faturas
|
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:
|
Exemplo de requisição para o sistema
Com as seguintes informações:
| IP | 192.168.64.111 |
| Chave de autenticação | aBC123DEF |
| matricula | 12345 |
| ano | 2020 |
A Requisição Seria
Retorno em Caso de Sucesso
{ "key": (String) Chave de autenticação recebida pelo Webservice, "qtd": (Integer) Número de dados retornados pelo Webservice, "resultado": Lista de objeto com informações da conta. [ "referencia": (String) Mês/Ano da Conta, "valorConta": (String) Valor da Conta, "dataVencimento": (String) Data de Vencimento da Conta, "paga": (String) Indicador de que a conta foi paga, "emRevisao": (String) Indicador de que a conta está em revisão, "situacao": (String) Situação da Conta. ] }
Exemplo:
{ "key": "skQcH2g7fvQ5A3nOo3P2fNPIVFvMm_Qj3VRkMaJzghVEoXS0Dzi6l0C-BuD-JunU", "qtd": 7, "resultado": [ { "referencia": "07/2020", "valorConta": "177,63", "dataVencimento": "03/08/2020", "paga": "Nao", "emRevisao": "Nao", "situacao": "RETIFICADA " }, { "referencia": "06/2020", "valorConta": "165,69", "dataVencimento": "17/06/2020", "valorPagamento": "165,69", "dataPagamento": "05/08/2020", "paga": "Sim", "emRevisao": "Nao", "situacao": "NORMAL " }, { "referencia": "05/2020", "valorConta": "149,20", "dataVencimento": "17/05/2020", "valorPagamento": "149,20", "dataPagamento": "07/07/2020", "paga": "Sim", "emRevisao": "Nao", "situacao": "NORMAL " }, { "referencia": "04/2020", "valorConta": "141,76", "dataVencimento": "17/04/2020", "valorPagamento": "141,76", "dataPagamento": "09/06/2020", "paga": "Sim", "emRevisao": "Nao", "situacao": "NORMAL " }, { "referencia": "03/2020", "valorConta": "150,48", "dataVencimento": "19/03/2020", "valorPagamento": "150,48", "dataPagamento": "05/05/2020", "paga": "Sim", "emRevisao": "Nao", "situacao": "NORMAL " }, { "referencia": "02/2020", "valorConta": "107,04", "dataVencimento": "16/02/2020", "valorPagamento": "107,04", "dataPagamento": "06/04/2020", "paga": "Sim", "emRevisao": "Nao", "situacao": "NORMAL " }, { "referencia": "01/2020", "valorConta": "142,97", "dataVencimento": "16/01/2020", "valorPagamento": "142,97", "dataPagamento": "27/02/2020", "paga": "Sim", "emRevisao": "Nao", "situacao": "NORMAL " } ] }
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:
{ "error": 404, "msg": "A consulta não trouxe resultados.", "qtd": 0 }
Possíveis Códigos de Retorno
| Código | Mensagem |
| 400 | “parâmetros inválidos” |
| 401 | “chave inválida” |
| 404 | “A consulta não trouxe resultados” |
| 500 | “” |
Clique AQUI para acessar outros serviços com os detalhes técnicos das integrações.
integracoes/web-services-listar-todas-faturas.txt · Última modificação: 07/10/2020 13:31 por hiroshi.goncalves
Exceto onde for informado ao contrário, o conteúdo neste wiki está sob a seguinte licença: CC Attribution-Noncommercial 4.0 International
