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 "Código do plano de pagamento deve ser informadoIdentificador 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:
...
- Valor fixo: 600,00
- Número da Parcela: 1
- Cota: 1
- Código do Serviço: 1
- Nome do Serviço: Mensalidade
- Id. do período letivo: 104
- Código do período letivo: 2018/2
- Data de vencimento: 30/11/2018
- Valor automático: N (Parcela fixa)
- Data de competência: 11/2018
(BOLSA)
- Código da Bolsa: 37
- Nome: Desconto Incondicional
- Valor: 10%
(DESCONTO POR ANTECIPAÇÃO)
...
)
- Identificador do Desconto: 6220
- Descrição: PRIMEIRO VENCIMENTO
- Valor do desconto: 50%
- Dia Fixo: 5
(ITEM DE DESCONTO 2)
...
- 10%
- Dia Fixo:
...
(ITEM DE DESCONTO 3)
...
- 28
Parâmetros passados para o serviço:
Após execução do serviço, o sistema retorna o seguinte XML:
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:--><SIMULACAO> <PARCELA> <CODCOLIGADA>1</CODCOLIGADA> <PARCELA>1</PARCELA> <COTA>1</COTA> <VALORORIGINAL>600,00</VALORORIGINAL> <tot:contextoSrv>1,1,3</tot:contextoSrv> <VLRDESCONTO>0,00</VLRDESCONTO> <!--Optional:--> <VLRLIQUIDO>240,00</VLRLIQUIDO> <tot:ra>20180320</tot:ra> <VLRBOLSACONDICIONAL>0</VLRBOLSACONDICIONAL> <!--Optional:--> <VLRBOLSAINCONDICIONAL>60,00</VLRBOLSAINCONDICIONAL> <tot:idPerLet>104</tot:idPerLet> <IDPERLET>104</IDPERLET> <!--Optional:--> <CODPERLET>2018/2</CODPERLET> <CODSERVICO>1</CODSERVICO> <tot:codPlanoPgto>PLAN</tot:codPlanoPgto> <!--Optional:--> <NOMESERVICO>Mensalidade</NOMESERVICO> <tot:idHabilitacaoFilial>94</tot:idHabilitacaoFilial> <DTVENCIMENTO>30/11/2018</DTVENCIMENTO> <!--Optional:--> <VALORAUTOMATICO>N</VALORAUTOMATICO> <tot:strListaIdTurmaDisc>4560</tot:strListaIdTurmaDisc> <DTCOMPETENCIA>01/11/2018</DTCOMPETENCIA> <!--Optional:--> <VLRCREDRETROATIVO>0</VLRCREDRETROATIVO><tot:consideraDescontoAntecipacao>S</tot:consideraDescontoAntecipacao> <BOLSAS> <!--Optional:--> <BOLSA> <tot:consideraDescontoAntecipacaoBolsa>N</tot:consideraDescontoAntecipacaoBolsa> <CODBOLSA>37</CODBOLSA> <!--Optional:--> <VALORBOLSA>60,00</VALORBOLSA> <tot:tipoBolsaContrato>S</tot:tipoBolsaContrato> </BOLSA> !--Optional:--> <tot:codStatusMatriculaDisc>123</tot:codStatusMatriculaDisc> </BOLSAS>tot:SimularValoresPlanoPgtoTurmaDisc> </soapenv:Body> </soapenv:Envelope> |
Após execução do serviço, o sistema retorna o seguinte XML:
Bloco de código | ||||
---|---|---|---|---|
| ||||
<SIMULACAO> <PARCELA> <DESCONTOPORANTECIPACAO> <CODCOLIGADA>1</CODCOLIGADA> <ITEMDESCONTO> <PARCELA>1</PARCELA> <COTA>1</COTA> <IDDESCONTO>62<<VALORORIGINAL>600,00</IDDESCONTO>VALORORIGINAL> <VLRDESCONTO>0,00</VLRDESCONTO> <VLRPGTOPORDESCPONTUAL>240<VLRLIQUIDO>240,00</VLRPGTOPORDESCPONTUAL>VLRLIQUIDO> <VLRBOLSACONDICIONAL>0</VLRBOLSACONDICIONAL> <DTDESCPONTUAL>06/08/2018</DTDESCPONTUAL><VLRBOLSAINCONDICIONAL>60,00</VLRBOLSAINCONDICIONAL> <IDPERLET>104</IDPERLET> <VALORDESCPONTUAL>300,00</VALORDESCPONTUAL><CODPERLET>2018/2</CODPERLET> <CODSERVICO>1</CODSERVICO> < <NOMESERVICO>Mensalidade</ITEMDESCONTO>NOMESERVICO> <DTVENCIMENTO>30/11/2018</DTVENCIMENTO> <ITEMDESCONTO> <VALORAUTOMATICO>N</VALORAUTOMATICO> <DTCOMPETENCIA>01/11/2018</DTCOMPETENCIA> <IDDESCONTO>63< <VLRCREDRETROATIVO>0</IDDESCONTO>VLRCREDRETROATIVO> <BOLSAS> <VLRPGTOPORDESCPONTUAL>480,00</VLRPGTOPORDESCPONTUAL> <BOLSA> <DTDESCPONTUAL>10/08/2018</DTDESCPONTUAL><CODBOLSA>37</CODBOLSA> <VALORDESCPONTUAL>60<VALORBOLSA>60,00</VALORDESCPONTUAL>VALORBOLSA> </ITEMDESCONTO>BOLSA> </BOLSAS> <DESCONTOPORANTECIPACAO> <ITEMDESCONTO> <IDDESCONTO>64<<IDDESCONTO>20</IDDESCONTO> <VLRPGTOPORDESCPONTUAL>510<VLRPGTOPORDESCPONTUAL>371,00<664</VLRPGTOPORDESCPONTUAL> <DTDESCPONTUAL>20<DTDESCPONTUAL>30/0807/2018</DTDESCPONTUAL> <VALORDESCPONTUAL>30<VALORDESCPONTUAL>41,00<76</VALORDESCPONTUAL> </ITEMDESCONTO> </DESCONTOPORANTECIPACAO> </PARCELA> </SIMULACAO> |
...
<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>
- <CODCOLIGADA>Código da coligada</CODCOLIGADA>
- <PARCELA>Número da parcela</PARCELA>
- <COTA>Número da cota</COTA>
<VALORORIGINAL>Valor original calculado para a parcela</VALORORIGINAL>
- <VLRDESCONTO>Valor calculado do desconto informado na parcela</VLRDESCONTO>
- <VLRLIQUIDO>Valor líquido a ser pago pelo aluno. (Considera o valor original subtraindo todos os descontos e bolsas calculadas)</VLRLIQUIDO>
- <VLRBOLSACONDICIONAL>Valor total das bolsas condicionais</VLRBOLSACONDICIONAL>
- <VLRBOLSAINCONDICIONAL>Valor total das bolsas incondicionais</VLRBOLSAINCONDICIONAL>
- <IDPERLET>Id. do período letivo</IDPERLET>
- <CODPERLET>Código do período letivo</CODPERLET>
- <CODSERVICO>Código do Serviço</CODSERVICO>
- <NOMESERVICO>Nome do Serviço</NOMESERVICO>
- <DTVENCIMENTO>Data de vencimento</DTVENCIMENTO>
- <VALORAUTOMATICO>Indica se a parcela é calculada por número de créditos (S: Calculada por número de créditos, N: Parcela Fixa)</VALORAUTOMATICO>
- <DTCOMPETENCIA>Data de competência da parcela no formato (dd/mm/yyyy)</DTCOMPETENCIA>
<VLRCREDRETROATIVO>Valor de crédito retroativo da parcela</VLRCREDRETROATIVO>
Aviso 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.
- <BOLSAS>Contém a marcação inicial e a marcação final do XML para os dados de bolsas de cada parcela</BOLSAS>
- <BOLSA>Contém a marcação inicial e a marcação final para cada bolsa da parcela</BOLSA>
- <CODBOLSA>Código da bolsa</CODBOLSA>
- <VALORBOLSA>Valor da bolsa</VALORBOLSA>
Aviso 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. As bolsas consideradas serão as cadastradas na concessão de bolsa futura para o aluno
- <BOLSA>Contém a marcação inicial e a marcação final para cada bolsa da parcela</BOLSA>
<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>
...
title | OBSERVAÇÕES |
---|
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)
...