O objetivo desse serviço é simular valores de parcelas de contratos de alunos através da configuração de parcelas de planos de pagamentos e concessão de bolsas futuras, informando o plano de pagamento, período letivo, matriz aplicada e uma lista de turmas disciplinas bem como um determinado status de matrícula na disciplina.
Esse serviço possibilita ao usuário do mesmo simular os valores a serem pagos pelo aluno antes de efetuarem a matrícula nas disciplinas de determinadas turmas, ou seja, não é necessário ter matrícula nas disciplinas bem como não é necessário se ter contrato para que o cálculo das parcelas seja feito.
O cálculo dos valores de parcelas segue a mesma regra da simulação de parcelas de contratos, ao selecionar uma determinada parcela na visão de parcela e clicar no botão para simular o cálculo.
Dúvidas para exposição de webservices podem ser esclarecidas através do link:
Como Expor os Web Services do RM através do Host
Dúvidas para configuração do host podem ser esclarecidas através do link:
Ajuda na configuração do Host.
O método SimularValoresPlanoPgtoTurmaDisc presente no webservice do TOTVS Educacional (wsEdu) realiza a simulação dos valores de parcelas baseados no plano de pagamento informado, bem como suas turmas disciplinas e um status de matrícula a ser considerado. Como informações obrigatórias no XML, devem ser informados o contexto do TOTVS Educacional a ser considerado, RA do aluno, Código do Período Letivo, Código do Plano de pagamento, lista de turmas disciplinas e código do status de matrícula.
Segue abaixo uma descrição dos parâmetros a serem passados para a simulação de valores de parcelas:
Exemplo de parâmetros de simulação preenchidos (utilizando o aplicativo SOAPUI):
Na imagem acima observe que:
Código do status de matrícula na disciplina igual a 123.
O status ou situação de matrícula na disciplina, no caso de simulação de parcelas calculadas por valor de crédito, deverão ter a opção de contar como créditos financeiros (cobrança por crédito) marcada. Vide imagem abaixo: Caso essa opção não esteja marcada, o serviço retornará os valores zerados para as parcelas. |
Parcelas com valor fixo retornarão o seu próprio valor desconsiderando quaisquer valores de créditos ou informações contidas nas turmas disciplinas. |
Validações feitas pelo serviço:
Conforme foi dito acima, o serviço SimularValoresPlanoPgtoTurmaDisc de wsEdu retorna os valores simulados conforme regra de simulação de valores de parcelas de contratos da visão de parcelas sem dependência de quaisquer matrículas em disciplinas nem de contratos existentes.
Abaixo seguem alguns dados utilizados em uma simulação utilizando o serviço:
(PLANO DE PAGAMENTO)
(PARCELA DO PLANO)
(BOLSA)
(DESCONTO POR ANTECIPAÇÃO)
(ITEM DE DESCONTO 1)
(ITEM DE DESCONTO 2)
(ITEM DE DESCONTO 3)
Parâmetros passados para o serviço:
Após execução do serviço, o sistema retorna o seguinte XML:
<SIMULACAO> <PARCELA> <CODCOLIGADA>1</CODCOLIGADA> <IDPARCELA>111211</IDPARCELA> <PARCELA>1</PARCELA> <COTA>1</COTA> <VALORORIGINAL>600,00</VALORORIGINAL> <VLRDESCONTO>0,00</VLRDESCONTO> <VLRLIQUIDO>240,00</VLRLIQUIDO> <VLRBOLSACONDICIONAL>0</VLRBOLSACONDICIONAL> <VLRBOLSAINCONDICIONAL>60,00</VLRBOLSAINCONDICIONAL> <IDPERLET>104</IDPERLET> <CODPERLET>2018/2</CODPERLET> <CODSERVICO>1</CODSERVICO> <NOMESERVICO>Mensalidade</NOMESERVICO> <DTVENCIMENTO>30/11/2018</DTVENCIMENTO> <VALORAUTOMATICO>N</VALORAUTOMATICO> <DTCOMPETENCIA>01/11/2018</DTCOMPETENCIA> <VLRCREDRETROATIVO>0</VLRCREDRETROATIVO> <BOLSAS> <BOLSA> <CODBOLSA>37</CODBOLSA> <VALORBOLSA>60,00</VALORBOLSA> </BOLSA> </BOLSAS> <DESCONTOPORANTECIPACAO> <ITEMDESCONTO> <IDDESCONTO>62</IDDESCONTO> <VLRPGTOPORDESCPONTUAL>240,00</VLRPGTOPORDESCPONTUAL> <DTDESCPONTUAL>06/08/2018</DTDESCPONTUAL> <VALORDESCPONTUAL>300,00</VALORDESCPONTUAL> </ITEMDESCONTO> <ITEMDESCONTO> <IDDESCONTO>63</IDDESCONTO> <VLRPGTOPORDESCPONTUAL>480,00</VLRPGTOPORDESCPONTUAL> <DTDESCPONTUAL>10/08/2018</DTDESCPONTUAL> <VALORDESCPONTUAL>60,00</VALORDESCPONTUAL> </ITEMDESCONTO> <ITEMDESCONTO> <IDDESCONTO>64</IDDESCONTO> <VLRPGTOPORDESCPONTUAL>510,00</VLRPGTOPORDESCPONTUAL> <DTDESCPONTUAL>20/08/2018</DTDESCPONTUAL> <VALORDESCPONTUAL>30,00</VALORDESCPONTUAL> </ITEMDESCONTO> </DESCONTOPORANTECIPACAO> </PARCELA> </SIMULACAO> |
Abaixo segue uma explicação de cada tag do XML de retorno do serviço.
<SIMULACAO>Contém a marcação inicial e a marcação final do XML de retorno do serviço de simulação.</SIMULACAO>
<PARCELA>Contém a marcação inicial e a marcação final para os dados simulados de cada parcela</PARCELA>
<VALORORIGINAL>Valor original calculado para a parcela</VALORORIGINAL>
<VLRCREDRETROATIVO>Valor de crédito retroativo da parcela</VLRCREDRETROATIVO>
Essa tag VLRCREDRETROATIVO só estará visível se a base do cliente estiver parametrizada para utilizar o modelo de bolsa retroativa sem alteração de parcelas baixadas utilizando devolução para os créditos retroativos. |
Essa Tag BOLSAS exibirá os valores da bolsa referente ao primeiro vencimento do desconto por antecipação quando o desconto por calculado pelo sistema conforme as parametrizações realizadas |
<DESCONTOPORANTECIPACAO>Contém a marcação inicial e a marcação final do XML para os dados de descontos por antecipação</DESCONTOPORANTECIPACAO>
<ITEMDESCONTO>Contém a marcação inicial e a marcação final para cada item de desconto por antecipação calculado para a parcela<ITEMDESCONTO>
<IDDESCONTO>Identificador do item de desconto</IDDESCONTO>
<VLRPGTOPORDESCPONTUAL>Valor a ser pago para esse item de desconto (vencimento por antecipação)</VLRPGTOPORDESCPONTUAL>
<DTDESCPONTUAL>Data limite calculada para o item de desconto com base no dia informado no formato (dd/mm/yyyy)</DTDESCPONTUAL>
<VALORDESCPONTUAL>Valor do desconto calculado para o item de desconto</VALORDESCPONTUAL>
O número de casas decimais para os valores respeitará o parâmetro do TOTVS Gestão Financeira (Contas a Receber → Manutenção de Lançamentos → Opções Gerais → Nº Casas Decimais) |