Versões comparadas

Chave

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

...

  • 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 do detalhamento dos valores:
    • Data de pagamento: 2018-10-05

...


Expandir
titleVALIDAÇÕ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 encontradas parcelas para exibição do detalhamento", conforme abaixo
    Image Modified

  2. Contexto informado inválido ou incompleto: Caso não seja informado contexto no formado correto, será exibida a seguinte mensagem "Contexto informado inválido. Favor informar, [Código da coligada], [Código da Filial], [Código do Nível de Ensino]", conforme abaixo: 
    Image Modified

  3. Não foram informados parcelas: Caso não seja informado o ID da parcela, será exibida a seguinte mensagem "Lista de parcelas deve ser informada", conforme abaixo: 
    Image Modified

  4. Data informada no formado incorreto: Caso não seja informado data no formado correto, será exibida a seguinte mensagem "Data de pagamento inválida. Favor informar a data de pagamento no formato 
    (Ano-Mes-Dia). Ex.: 2018-10-01 (1º de Outubro de 2018)", conforme abaixo: 
    Image Modified
  5. Sistema só encontra uma parcela no contexto informado: Caso informe duas parcelas que estão em contextos diferente, ou, duas parcelas que esteja no mesmo contexto e uma delas não esteja gerada, será exibida a seguinte mensagem "Não foram encontradas informações referentes à parcela no contexto informado", conforme abaixo: 
    Image Modified

XML de retorno do serviço de detalhamento:

...

Abaixo segue uma explicação de cada tag do XML de retorno do serviço.

Expandir
titleDETALHAMENTO
  • <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>
Expandir
titlePARCELA
  • <PARCELA>Contém a marcação inicial e a marcação final para os valores para cada parcela</PARCELA>
Expandir
titleDISCIPLINA
  • <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 disciplina 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
        titleInformação

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

Expandir
titleVALORESEDUCACIONAIS
  • <VALORESEDUCACIONAIS>Contém a marcação inicial e a marcação final do XML para os dados dos valores educacionais 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>
    • <VALORCREDITOCONTACORRENTE>Valor do crédito da conta corrente para pagamento a maior da parcela</VALORCREDITOCONTACORRENTE>
    • <VALORDEBITOCONTACORRENTE>Valor do débito da conta corrente para pagamento a menor da parcela</VALORDEBITOCONTACORRENTE>
    • <VALORPARCELA>Valor total da parcela</VALORPARCELA>

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

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

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

      • <TIPOSAC>Tipo sacado da bolsa (N - Nenhum, A - Aluno, R - Outro Sacado)</TIPOSAC>
      • <CODCFO>Código do Cliente / Fornecedor para o campo outro sacado</CODCFO>
      • <CODCOLCFO>Coligada do Cliente / Fornecedor para o campo outro sacado</CODCOLCFO>
      • <NOME>Nome da bolsa</NOME>
      • <ORDEMPERDA>Ordem de perda da bolsa</ORDEMPERDA>
      • <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>

      • <VALORBAIXA>Valor baixado da bolsa</VALORBAIXA>

        Informações
        titleInformação

        As mesmas informações citadas acima se aplicam a estrutura BOLSASINCONDICIONAIS

Expandir
titleVALORESFINANCEIROS
  • <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>
    • <LANCAMENTO>Contém os dados de cada lançamento financeiro para cada parcela<LANCAMENTO>
    • <CODCOLIGADA>Código da coligada</CODCOLIGADA>
    • <IDPARCELA>Identificador da parcela</IDPARCELA>
    • <IDLAN>Identificador do lançamento financeiro</IDLAN>

    • <CODCOLCFO>Código da coligada do cliente</CODCOLCFO>
    • <CODCFO>Código do cliente</CODCFO>
    • <NOMERESPONSAVEL>Nome do responsável financeiro</NOMERESPONSAVEL>
    • <VALORORIGINAL>Valor Original</VALORORIGINAL>
    • <VALORLIQUIDO>Valor líquido</VALORLIQUIDO>

    • <VALORJUROS>Valor do juros</VALORJUROS>
    • <VALORMULTA>Valor da multa</VALORMULTA>
    • <VALORDESCONTO>Valor do desconto</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>
    • <VALORDESCANTECIPACAO>Valor do desconto por antecipação</VALORDESCANTECIPACAO>

      Informações
      titleValores de Integração

      Se o lançamento financeiro tiver valores de integração, os mesmos serão apresentados na tag <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á <VALORINTEGRACAO11>99,99</VALORINTEGRACAO11>.

    • <LANBOLSACREDITO>Identifica se o lançamento é de bolsa de crédito (N - Não, S - Sim)</LANBOLSACREDITO>

    • <STATUSLAN>Status do lançamento financeiro (Aberto = 0, Baixado = 1, Cancelado = 2, Baixado por acordo = 3, Baixado parcialmente = 4 )</STATUSLAN>

    • <VALORBAIXADO>Valor baixado (preenchido quando o lançamento estiver baixado)</VALORBAIXADO>

    • <VALORDEVOLUCAO>Valor devolução de bolsa retroativa</VALORDEVOLUCAO>

Expandir
titleDESCONTOSPORANTECIPACAO
  • <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<\DESCONTOPORANTECIPACAO>

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

...

titleCONFIGVALORINTEGRACAO
    • <CONFIGVALORINTEGRACAO>Contém a marcação inicial e a marcação final do XML para os dados dos valores de integração financeiros. </CONFIGVALORINTEGRACAO>
      • <VALORINTEGRACAO>Contém os dados de cada valor de integração para cada lançamento da parcela</VALORINTEGRACAO>
      • <IDCAMPO>Contém o ID do campo do valor integração parametrizado</IDCAMPO>
      • <DESCRICAO>Contém a descrição do valor de integração parametrizado </DESCRICAO>
      • <CODSISTEMA>Contém o código do sistema que é dono do valor de integração parametrização</CODSISTEMA>
      • <ACAO>Contém a constante da Ação informada no valor de integração (0 - Nada, 1 - Soma, 2 - Desconta)</ACAO>

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)

Image Modified