Histórico da Página
...
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.
Informações |
---|
É possível parametrizar o TOTVS Educacional para que ao criar as parcelas no contrato do aluno a partir do plano de pagamento, sejam consideradas do plano de pagamento somente as parcelas com vencimento a partir do mês da inclusão do plano de pagamento no contrato. Para saber mais clique aqui. |
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
...
- contextoSrv: Contexto do TOTVS Educacional a ser executada a simulação. Possui o seguinte formato: [coligada],[código da filial],[Código do nível de ensino].
Exemplo: 1,1,1 (coligada = 1, código da filial = 1, código do nível de ensino = 1) - ra: Registro acadêmico do aluno
- codPerLetidPerLet: Código Id. do período letivo Exemplo: 2018/2
- codPlanoPgto: Código do plano de pagamento
- idHabilitacaoFilial: Identificador da matriz aplicada que será vinculada ao contrato do aluno após matrícula.Necessário SOMENTE para simulação de valores de parcelas por crédito, ou seja, o mesmo não é obrigatório para a simulação de valores baseados em planos de pagamentos de parcelas fixas.
- strListaIdTurmaDisc: Lista contendo os identificadores de turmas disciplinas a serem consideradas separadas por vírgula.
Exemplo: <IdTurmaDisc1>,<IdTurmaDisc2> - consideraDescontoAntecipacao: Parâmetro opcional. Indica se descontos por antecipação deverão ser considerados na simulação de valores de parcelas.
Os descontos por antecipação considerados serão aqueles informados no campus / polo da matriz aplicada informada ou na matriz aplicada caso existam descontos por antecipação vinculados à matriz aplicada e não existam no campus / polo dessa matriz aplicada.
Poderá ter os valores (S - Considera valores de descontos por antecipação, N - Desconsidera valores de descontos por antecipação).
Caso não seja informado ou seja passado um valor vazio, o valor default para o mesmo é "S" - consideraDescontoAntecipacaoBolsa: Parâmetro opcional. Indica , indica se descontos por antecipação deverão ser considerados no cálculo de valores de bolsas na simulação de valores de parcelas, para bolsa do tipo somar bolsa ou Aplicar somente a maior Bolsa.
Poderá ter os valores (S - Considera valores de descontos por antecipação no cálculo de valores de bolsas, N - Desconsidera valores de descontos por antecipação no cálculo de valores de bolsas).
Caso não seja informado ou seja passado um valor vazio, o valor default para o mesmo é "N" - tipoBolsaContrato: Parâmetro opcional. Comportamento das bolsas no contrato.
Poderá ter os valores (S - Somar Bolsas, C - Aplicar bolsas em cascata, M - Aplicar somente a maior bolsa).
Caso não seja informado ou seja passado um valor vazio, o valor default para o mesmo é "S" - codStatusMatriculaDisc: Código de status de matrícula na disciplina a ser considerado na simulação de valores.
Exemplo de parâmetros de simulação preenchidos (utilizando o aplicativo SOAPUI):
Bloco de código | ||
---|---|---|
| ||
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tot="http://www.totvs.com/">
<soapenv:Header/>
<soapenv:Body>
<tot:SimularValoresPlanoPgtoTurmaDisc>
<!--Optional:-->
<tot:contextoSrv>1,1,3</tot:contextoSrv>
<!--Optional:-->
<tot:ra>20180320</tot:ra>
<!--Optional:-->
<tot:idPerLet>104</tot:idPerLet>
<!--Optional:-->
<tot:codPlanoPgto>PLAN</tot:codPlanoPgto>
<!--Optional:-->
<tot:idHabilitacaoFilial>94</tot:idHabilitacaoFilial>
<!--Optional:-->
<tot:strListaIdTurmaDisc>4560</tot:strListaIdTurmaDisc>
<!--Optional:-->
<tot:consideraDescontoAntecipacao>S</tot:consideraDescontoAntecipacao>
<!--Optional:-->
<tot:consideraDescontoAntecipacaoBolsa>N</tot:consideraDescontoAntecipacaoBolsa>
<!--Optional:-->
<tot:tipoBolsaContrato>S</tot:tipoBolsaContrato>
<!--Optional:-->
<tot:codStatusMatriculaDisc>123</tot:codStatusMatriculaDisc>
</tot:SimularValoresPlanoPgtoTurmaDisc>
</soapenv:Body>
</soapenv:Envelope> |
Na imagem acima observe que:
- A tag "contextoSrv" contém a informação 1,1,3 que significa:
- Código da coligada igual a 1
- Código da filial igual a 1
- Código do nível de ensino (codtipocurso) igual a 3
- A tag "ra" contém a informação:
- RA do aluno igual a 2018030420180320
- A tag "codPerLetidPerLet" contém a informação:
- Código Id. do período letivo igual a 2018/2104
- A tag "codPlanoPgto" contém a informação:
- Código do plano de pagamento igual a 2PLAN
- A tag "idHabilitacaoFilial" contém a informação:
- Identificador da matriz aplicada igual a 94
- A tag "strListaIdTurmaDisc" contém a informação 2574 4560 que significa que:
- Será considerada a turma disciplina com o idTurmaDisc igual a 25744560
- A tag "consideraDescontoAntecipacao" contém a informação S que significa que:
- Serão considerados valores de desconto por antecipação informados no campus / polo da matriz aplicada ou na matriz aplicada
- A tag "consideraDescontoAntecipacaoBolsa" contém a informação N que significa que:
- NÃO serão considerados valores de desconto por antecipação no cálculo dos valores de bolsas
- A tag "tipoBolsaContrato" contém a informação S que significa que:
- Será considerada a opção "Somar Bolsas" de contratos para cálculo dos valores de bolsas
- A tag "codStatusMatriculaDisc" contém a informação:
Código do status de matrícula na disciplina igual a 123.
Informações 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.
Informações Parcelas com valor fixo retornarão o seu próprio valor desconsiderando quaisquer valores de créditos ou informações contidas nas turmas disciplinas.
...
- 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
- 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:
- Registro acadêmico não informado: Caso não seja informado o RA do aluno, será exibida a mensagem "RA deve ser informado." conforme abaixo:
- Código do período letivo não informado: Será exibida a mensagem "Código do período letivo deve ser informado" conforme abaixo:
- Código do plano de pagamento não informado: Será exibida a mensagem "Código do plano de pagamento deve ser informado" conforme abaixo:
- Identificador da matriz aplicada não é um número inteiro: Será exibida a mensagem "Identificador da matriz aplicada não é um número inteiro" conforme abaixo:
- Lista de Turmas Disciplinas não informada: Será exibida a mensagem "Lista de turmas disciplinas deve ser informada." conforme abaixo:
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: - Erros devido a inconsistências diversas. Será exibida a mensagem conforme abaixo:
...
Parâmetros passados para o serviço:
Bloco de código | ||
---|---|---|
| ||
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tot="http://www.totvs.com/">
<soapenv:Header/>
<soapenv:Body>
<tot:SimularValoresPlanoPgtoTurmaDisc>
<!--Optional:-->
<tot:contextoSrv>1,1,3</tot:contextoSrv>
<!--Optional:-->
<tot:ra>20180320</tot:ra>
<!--Optional:-->
<tot:idPerLet>104</tot:idPerLet>
<!--Optional:-->
<tot:codPlanoPgto>PLAN</tot:codPlanoPgto>
<!--Optional:-->
<tot:idHabilitacaoFilial>94</tot:idHabilitacaoFilial>
<!--Optional:-->
<tot:strListaIdTurmaDisc>4560</tot:strListaIdTurmaDisc>
<!--Optional:-->
<tot:consideraDescontoAntecipacao>S</tot:consideraDescontoAntecipacao>
<!--Optional:-->
<tot:consideraDescontoAntecipacaoBolsa>N</tot:consideraDescontoAntecipacaoBolsa>
<!--Optional:-->
<tot:tipoBolsaContrato>S</tot:tipoBolsaContrato>
<!--Optional:-->
<tot:codStatusMatriculaDisc>123</tot:codStatusMatriculaDisc>
</tot:SimularValoresPlanoPgtoTurmaDisc>
</soapenv:Body>
</soapenv:Envelope> |
Após execução do serviço, o sistema retorna o seguinte XML:
...