Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

O objetivo desse serviço é mostrar a composição o detalhamento dos valores da parcela de do contrato com lançamentos financeiros gerado, através de uma lista de parcelas a terem os valores calculados e uma data de pagamento para o cálculo.disciplina.

Esse serviço mostrar o detalhamento dos valores das parcelas de contrato com os seus valores financeiros para entender os valores que serão pagados na mensalidade.

Aviso
titleLancamentoGerado

OBSERVAÇÃO

A composição O detalhamento dos valores da parcela será somente para as parcelas de contrato com lançamentos financeiros gerados.

...

O método RetornaDetalhamentoCalculoParcelas presente no webservice do TOTVS Educacional (wsEdu) retorna a composição o detalhamento dos valores da parcelas de contrato com lançamentos financeiros gerados baseados em turmas disciplinas, bolsas condicionais, bolsa incondicionais, desconto por antecipação , ou conta corrente. Como informações obrigatórias no XML, devem ser informados o contexto do TOTVS Educacional a ser considerado, lista de parcelas e data de pagamento para cálculo.

Segue abaixo uma descrição dos parâmetros a serem passados para a simulação de o detalhamento dos valores de parcelas:

  • contextoSrv: Contexto do TOTVS Educacional a ser executada a simulaçãoo detalhamento. 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)
  • strListaIdParcela: Lista contendo os identificadores de parcelas a terem seus valores simulados detalhados com os valores separados por vírgula. Caso uma parcela da lista de parcelas não exista na base de dados, os dados referentes ao identificador informado não serão retornados.
      Exemplo: <IdParcela1>,<IdParcela2>
  • dataPagamento: Data de pagamento para ser considerada no cálculo da composiçãodo detalhamento dos valores.
      Exemplo: 2018-10-05


Exemplo de parâmetros de simulação do detalhamento preenchidos (utilizando o aplicativo SOAPUI):

...

  • A tag "contextoSrv" contém a informação 1,1,1 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 1
  • A tag "strListaIdParcela" contém a informação:
    • Parcelas a serem processadas com idparcela1 = 19901, idparcela2 = 19902.

  • A tag "dataPagamento" contém a data de pagamento a ser utilizada para cálculo da composição do detalhamento dos valores:
    • Data de pagamento: 2018-10-05

...

  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 encontradas parcelas para exibição do detalhamento" conforme abaixo


XML de retorno do serviço de

...

detalhamento:

Conforme foi dito acima, o serviço RetornaDetalhamentoCalculoParcelas de wsEdu retorna a composição o detalhamento dos valores das parcelas de contrato com lançamento financeiro gerados conforme regra de simulação de valores de parcelas de contratos na visão de parcelas   sem dependência de quaisquer matrículas em disciplinas.

...

  • <DETALHAMENTO>Contém a marcação inicial e a marcação final do XML de retorno do serviço de retorno detalhamento cálculo da parcela.</DETALHAMENTO>

  • <PARCELA>Contém a marcação inicial e a marcação final para os valores de para cada parcela</PARCELA>

  • <DISCIPLINAS>Contém a marcação inicial e a marcação final das disciplinas presente na matrícula do aluno</DISCIPLINAS>

    • <DISCIPLINA>Contém os dados de cada disciplinas presente na matrícula do aluno</DISCIPLINA>

      • <CODCOLIGADA>Código da coligada</CODCOLIGADA>
      • <IDPARCELA>Identificador da parcela</IDPARCELA>
      • <SEQUENCIAL>Identificador único para cada parcela</SEQUENCIAL>
      • <ORIGEM>Origem do item de cálculo</ORIGEM>
      • <TIPOITEM>Tipo do item de cálculo</TIPOITEM>

      • <IDTURMADISC>Identificador da turma disciplina</IDTURMADISC>
      • <CODDISC>Código da disciplina</CODDISC>
      • <NUMCREDITOCOB>Número de crédito de cobrados</NUMCREDITOCOB>
      • <VALORCREDITO>Valor crédito</VALORCREDITO>
      • <VALORTOTALCONTRATO>Valor total da disciplina calculado para o contrato</VALORTOTALCONTRATO>

      • <QTDPARCELASCONSIDERADA>Quantidade de parcelas consideradas</QTDPARCELASCONSIDERADA>

      • <VALORTOTALPORPARCELA>Valor total da disciplina para a parcela</VALORTOTALPORPARCELA>

      • <IDFAIXACREDITO>Identificador da Faixa de Crédito</IDFAIXACREDITO>

      • <INCONSISTENTE>Inconsistente</INCONSISTENTE>

        Informações
        titleDetalhamento do Cálculo da Parcela por Disciplina

        Para as tag's das disciplinas são os campos usados no Detalhamento do Cálculo da Parcela por Disciplina.

    • <VALORESEDUCACIONAIS>Contém a marcação inicial e a marcação final do XML para os dados dos valores educacionais de para cada parcela</VALORESEDUCACIONAIS>
      • <CODCOLIGADA>Código da coligada</CODCOLIGADA>
      • <IDPARCELA>Identificador da parcela</IDPARCELA>
      • <VALORDESCONTOPARCELA>Valor do desconto da parcela</VALORDESCONTOPARCELA>
      • <VALORBOLSASCONDICIONAIS>Valor das bolsas condicionais da parcela</VALORBOLSASCONDICIONAIS>
      • <VALORBOLSASINCONDICIONAIS>Valor das bolsas incondicionais da parcela</VALORBOLSASINCONDICIONAIS>
      • <VALORCONTACORRENTEAMAIOR><VALORCREDITOCONTACORRENTE>Valor do crédito da conta corrente para pagamento a maior da parcela</VALORCONTACORRENTEAMAIOR>VALORCREDITOCONTACORRENTE>
      • <VALORCONTACORRENTEAMENOR><VALORDEBITOCONTACORRENTE>Valor do débito da conta corrente para pagamento a menor da parcela</VALORCONTACORRENTEAMENOR>VALORDEBITOCONTACORRENTE>
      • <VALORPAGAMENTOAMAIOR>Valor do pagamento a maior da parcela</VALORPAGAMENTOAMAIOR>
      • <VALORPAGAMENTOAMENOR>Valor do pagamento a menor da parcela</VALORPAGAMENTOAMENOR>
      • <VALORPERDADESCANTECIPACAO>Valor da perda do desconto por antecipação</VALORPERDADESCANTECIPACAO>
      • <VALORREPASSEBOLSAAMENOR>Valor do repasse da bolsa a menor</VALORREPASSEBOLSAAMENOR>

    • <BOLSASINCONDICIONAIS>Contém a marcação inicial e a marcação final do XML para os dados das bolsas incondicionais de para cada parcela</BOLSASINCONDICIONAIS>

      • <BOLSA>Contém os dados de cada bolsa de para cada parcela<BOLSA>

        • <CODCOLIGADA>Código da coligada</CODCOLIGADA>
        • <IDPARCELA>Identificador da parcela</IDPARCELA>
        • <CODBOLSA>Código da bolsa</CODBOLSA>

        • <NOME>Nome da bolsa</NOME>
        • <TIPODESC>Tipo de Desconto (P - Percentual, V- Valor)</TIPODESC>

        • <DESCONTO>Valor do desconto conforme o campo tipo de desconto</DESCONTO>
        • <VALORCALCULADO>Valor calculado para a bolsa</VALORCALCULADO>

    • <BOLSASCONDICIONAIS>Contém a marcação inicial e a marcação final do XML para os dados das bolsas condicionais de para cada parcela</BOLSASCONDICIONAIS>

      • <BOLSA>Contém os dados de cada bolsa de para cada parcela<BOLSA>

        • <CODCOLIGADA>Código da coligada</CODCOLIGADA>
        • <IDPARCELA>Identificador da parcela</IDPARCELA>
        • <CODBOLSA>Código da bolsa</CODBOLSA>

        • <NOME>Nome da bolsa</NOME>
        • <TIPODESC>Tipo de Desconto (P - Percentual, V- Valor)</TIPODESC>

        • <DESCONTO>Valor do desconto conforme o campo tipo de desconto</DESCONTO>
        • <VALORCALCULADO>Valor calculado para a bolsa</VALORCALCULADO>

    • <VALORESFINANCEIROS>Contém a marcação inicial e a marcação final do XML para os dados do lançamento financeiro para cada parcela</VALORESFINANCEIROS>
      • <CODCOLIGADA>Código da coligada</CODCOLIGADA>
      • <IDPARCELA>Identificador da parcela</IDPARCELA>
      • <IDLAN>Identificador do lançamento financeiro</IDLAN>

      • <VALORORIGINAL>Valor Original</VALORORIGINAL>
      • <VALORLIQUIDO>Valor líquido</VALORLIQUIDO>

      • <VALORJUROS>Valor do juros</VALORJUROS>
      • <VALORMULTA>Valor da multa</VALORCALCULADO>VALORMULTA>
      • <VALORDESCONTO>Valor do desconto</VALORCALCULADO>VALORDESCONTO>
      • <VALOROP1>Valor opcional 1</VALOROP1>
      • <VALOROP2>Valor opcional 2</VALOROP2>
      • <VALOROP3>Valor opcional 3</VALOROP3>
      • <VALOROP4>Valor opcional 4</VALOROP4>
      • <VALOROP5>Valor opcional 5</VALOROP5>
      • <VALOROP6>Valor opcional 6</VALOROP6>
      • <VALOROP7>Valor opcional 7</VALOROP7>
      • <VALOROP8>Valor opcional 8</VALOROP8>
      • <VALORDESCPONTUAL><VALORDESCANTECIPACAO>Valor do desconto por antecipação</VALORDESCPONTUAL>VALORDESCANTECIPACAO>

        Informações
        titleValores Integração

        OBSERVAÇÃO:

        Se o lançamento financeiro tiver valores de integração, os mesmos serão apresentados na tag <VALORINTEGRAVAO <VALORINTEGRACAO + Identificador do valor integração>.

        Exemplo:

        No lançamento financeiro tem o valor de integração 11 - Pagamento a menor. Desta forma, a tag deste valor de integração ficará <VALORINTEGRAVAO11></VALORINTEGRAVAO11>.

    • <DESCONTOSPORANTECIPACAO>Contém a marcação inicial e a marcação final do XML para os dados dos desconto por antecipação para cada parcela</DESCONTOSPORANTECIPACAO>

      • <DESCONTOPORANTECIPACAO>Contém os dados de cada desconto por antecipação para cada parcela<BOLSA>

        • <CODCOLIGADA>Código da coligada</CODCOLIGADA>
        • <IDPARCELA>Identificador da parcela</IDPARCELA>
        • <IDLAN>Identificador do lançamento financeiro</IDLAN>
        • <IDAGRUPADESCPONTUAL>Identificador do agrupamento do desconto por antecipação</IDAGRUPADESCPONTUAL>

        • <IDDESCONTO>Ientificador do item do desconto por antecipação</IDDESCONTO>
        • <DESCRICAO>Nome do item do desconto por antecipação</DESCRICAO>

        • <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>

Aviso
titleOBSERVAÇÕ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)


...