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-listar-faturas-pagas
no way to compare when less than two revisions

Diferenças

Aqui você vê as diferenças entre duas revisões dessa página.


integracoes:web-services-listar-listar-faturas-pagas [12/12/2019 18:37] (atual) – criada tadeu.sarmento
Linha 1: Linha 1:
 +{{ajuda:logo-gsan3.png?90|}}
  
 +
 +====== WebService Listar Faturas Pagas ======
 +
 +<columns>
 +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:
 +  - key, //String// contendo a chave de autenticação da empresa.
 +  - value, //String// contendo a matrícula que será usada como filtro.
 +  - ano, //Integer// ano que será usado como filtro.
 +</columns>
 +\\
 +
 +===== Exemplo de requisição para o sistema =====
 +
 +Com as seguintes informações:
 +|IP|192.168.64.111|
 +|Chave de autenticação|aBC123DEF|
 +|Matrícula|5101433|
 +|Ano|2019|
 +
 +\\
 +
 +===== A Requisição Seria =====
 +
 +http://192.168.64.111:8080/gsan/listarFaturasPagas?key=aBC123DEF&matricula=5101433&ano=2019
 +
 +\\
 +
 +===== Retorno em Caso de Sucesso =====
 +<code javascript>
 +{
 +   "key": (String) chave de autenticação recebida pelo WebService,
 +   "qtd": (Integer) quantidade de registros retornados,
 +   "resultado": [
 +      {
 +         "idPagamento": (Integer) id do pagamento,
 +         "idDocumento": (Integer) id do documento pago,
 +         "referencia": (Integer) referência no formato anoMês,
 +         "valorPago": (String) valor pago,
 +         "dataPagamento": (String) data no formato dd/MM/yyyy,
 +         "arrecadador": Código e nome do Arrecadador no formato: “código-nome”,
 +         "tipoDocumento": Tipo do Documento “CONTA” ou “GUIA”,
 +         "dataVencimentoDocumento": (String) data no formato dd/MM/yyyy
 +      }
 +   ]
 +
 +
 +</code>
 +\\
 +
 +**Exemplo**:
 +
 +<WRAP center round box 100%>
 +{{  :integracoes:pesquisar_faturas_pagas_json_1.jpg?nolink  |}}
 +</WRAP>
 +
 +\\
 +
 +===== Retorno em Caso de erro =====
 +<code javascript>
 +{
 + "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
 +}
 +
 +</code>
 +
 +**Exemplo**:
 +
 +\\
 +<WRAP center round box 100%>
 +{{  :integracoes:pesquisar_faturas_pagas_json_2.jpg?nolink  |}}
 +</WRAP>
 +
 +\\
 +
 +===== 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 **[[=treinamentos:integracoes|AQUI]]** para acessar outros serviços com os detalhes técnicos das integrações.
integracoes/web-services-listar-listar-faturas-pagas.txt · Última modificação: 12/12/2019 18:37 por tadeu.sarmento