Base de Conhecimento de Gestão Comercial de Saneamento

Essa página está em modo somente de leitura. Você pode visualizar a fonte, mas não alterá-la. Informe-se com o administrador do Wiki, caso você ache que isso está incorreto.
{{ajuda:logo-gsan3.png?90|}}


====== WebService Consultar Doação Faturada ======

<columns>
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:
  - key (Obrigatório), //String// contendo a chave de autenticação da empresa.
  - cnpj (Obrigatório), //String// contendo o CNPJ (apenas números) da entidade beneficente que receberá a doação.
  - mesAnoReferencia (Obrigatório), //String// contendo a referência da conta no formato "mm/aaaa".
  - matricula (Opcional), //String// contendo o identificador do imóvel.
</columns>
\\

===== 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|03/2023 (referência da conta)|
\\

===== A Requisição Seria =====

http://evolutiva.consensotec.com.br:8106/gsan/consultarDoacaoFaturada

===== Envio - JSON  ===== 

<code javascript>
{
    "key": "fqzc36y8cv-jg1ekgK9-Z9epV_SZSiL_CB_REQ1yFUi-0KSDcbeYlhj6xev5aATX",
    "cnpj": "22690582000110",
    "mesAnoReferencia": "03/2023"
}
</code>
\\

===== Retorno com Sucesso - JSON =====

<code javascript>
{
    "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"
            }
        ]
    }
}
</code>
\\

===== Retorno com Insucesso - JSON ===== 
<code javascript>
{
    "key": "fqzc36y8cv-jg1ekgK9-Z9epV_SZSiL_CB_REQ1yFUi-0KSDcbeYlhj6xev5aATX",
    "error": 422,
    "qtd": 0,
    "resultado": {
        "motivo": "A pesquisa não retornou resultados."
    }
}
</code>
\\

===== Possíveis Códigos de Retorno =====
|Código|Mensagem|Body
|200|"OK"|
|500|"Internal Server Error"|
|404|"Page not found"|
|422|"Unprocessable Entity"|

\\

Clique **[[=treinamentos:integracoes|AQUI]]** para acessar outros serviços com os detalhes técnicos das integrações.