Visão Geral

O objetivo desse serviço é simular valores de parcelas de contratos existentes, através de uma lista de parcelas a terem os valores simulados e uma lista de turmas disciplinas bem como em 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 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 cálculo.

A simulação de parcelas de contratos vinculados a uma matriz aplicada e contratos de matrícula livre (sem vínculo com matriz aplicada) poderá retornar valores diferentes para uma mesma turma disciplina com o parâmetro "Usar valor do crédito financeiro da matriz curricular do aluno", isto porque, se a simulação estiver sendo feita para a parcela do contrato com vínculo à matriz aplicada, o sistema buscará os valores de créditos da disciplina da matriz curricular do aluno e, no segundo caso (contrato sem vínculo à matriz aplicada), o sistema poderá buscar o valor de créditos da matriz curricular da turma disciplina (se a mesma estiver vinculada a uma matriz aplicada) ou da turma disciplina (caso seja uma turma livre - sem vínculo a uma matriz aplicada).

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.

Método SimularValoresContratoTurmaDisc

O método SimularValoresContratoTurmaDisc presente no webservice do TOTVS Educacional (wsEdu) realiza a simulação dos valores de parcelas de contratos baseados em 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, lista de parcelas, 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:

Validações feitas pelo serviço:

  1. Sistema não encontra as parcelas informadas: Caso não sejam encontradas parcelas com os identificadores de parcelas informados para o serviço será exibida a seguinte mensagem "Não foram encontrados registros a serem simulados" conforme abaixo


  2. Contexto do Educacional não informado: Caso o contexto do TOTVS Educacional não tenha sido informado será exibida a mensagem "Contexto do serviço deve ser informado." conforme abaixo:


  3. Lista de parcelas não informada: Caso não seja informada a lista de parcelas, será exibida a mensagem "Lista de parcelas deve ser informada." conforme abaixo:


  4. Lista de Turmas Disciplinas não informada: Será exibida a mensagem "Lista de turmas disciplinas deve ser informada." conforme abaixo:


  5. Código da situação de matrícula nas disciplinas (status) não informado: Será exibida a mensagem "Status de matrícula na disciplina deve ser informado." conforme abaixo:


  6. Erros devido a inconsistências diversas. Será exibida a mensagem conforme abaixo:

XML de retorno do serviço de simulação:

Conforme foi dito acima, o serviço SimularValoresContratoTurmaDisc 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.

Abaixo seguem alguns dados utilizados em uma simulação utilizando o serviço:

(CONTRATO)

(PARCELA)

(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>19335</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>
    <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.

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)