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-consultar-doacao-faturada
Tabela de conteúdos
WebService Consultar Doação Faturada
|
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:
|
Exemplo de requisição para o sistema
Com as seguintes informações:
| URL | http://evolutiva.consensotec.com.br:8106 |
| key | j4iugjg94l-jg1ekgK9-Z9epV_SZSiL_CB_REQ1yFUi-0KSDcbeYlhj6xev5aBAC |
| cnpj | 05726909000145 |
| mesAnoReferencia | 05/2023 |
A Requisição Seria
Envio - JSON
{ "key": "fqzc36y8cv-jg1ekgK9-Z9epV_SZSiL_CB_REQ1yFUi-0KSDcbeYlhj6xev5aATX", "cnpj": "22690582000110", "mesAnoReferencia": "05/2023" }
Retorno com Sucesso - JSON
{ "key": "fqzc36y8cv-jg1ekgK9-Z9epV_SZSiL_CB_REQ1yFUi-0KSDcbeYlhj6xev5aATX", "qtd": 6, "resultado": { "motivo": "OK", "doacoes": [ { "matricula": "414000", "valor": "10,00", "nuParcela": "1", "refConta": "03/2023", "dtFaturamento": "01/03/2023", "dtVencimento": "25/03/2023", "dtPagamento": "02/05/2023" }, { "matricula": "414000", "valor": "10,00", "nuParcela": "1", "refConta": "03/2023", "dtFaturamento": "01/03/2023", "dtVencimento": "25/03/2023", "dtPagamento": "02/05/2023" }, { "matricula": "219908", "valor": "10,00", "nuParcela": "1", "refConta": "03/2023", "dtFaturamento": "08/03/2023", "dtVencimento": "15/03/2023", "dtPagamento": "20/04/2023" }, { "matricula": "219908", "valor": "10,00", "nuParcela": "1", "refConta": "03/2023", "dtFaturamento": "08/03/2023", "dtVencimento": "15/03/2023", "dtPagamento": "20/04/2023" }, { "matricula": "287300", "valor": "50,00", "nuParcela": "1", "refConta": "03/2023", "dtFaturamento": "04/03/2023", "dtVencimento": "12/03/2023", "dtPagamento": "10/03/2023" }, { "matricula": "287300", "valor": "50,00", "nuParcela": "1", "refConta": "03/2023", "dtFaturamento": "04/03/2023", "dtVencimento": "12/03/2023", "dtPagamento": "10/03/2023" } ] } }
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ódigo | Mensagem |
| 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-consultar-doacao-faturada.txt · Última modificação: 28/08/2023 13:13 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
