Serviço externo padrão - Gera parcelas e título da parcela de inscrição

Este serviço realiza a geração de parcelas e o título bancário da parcelas de inscrição (caso esteja marcado para gerar título). Serão geradas todas as parcelas do plano de pagamento. O plano de pagamento utilizado será:

  • Se passado o plano de pagamento (parâmetro “planoPagamentoId”) será gerado para este.
  • Se não passado o plano de pagamento será recuperado um pelos filtros, comparados com os dados do contrato financeiro (Se tiver mais de um plano de pagamento será utilizando um dos plano aleatoriamente).

1. Parâmetros para chamada do serviço externo

Parâmetro Descrição Obrigatório Tipo Observação Valor padrão
contratoFinId Identificador do contrato financeiro Sim Integer
planoPagamentoId Identificado do plano de pagamento Não Integer

2. Exemplo de chamada do serviço

URL: http://IP:PORTA/APLICACAO/rest/servicoexterno/execute/geraParcTitInsc


2.1. Exemplo da passagem de parâmetros por Json:

{"contratoFinId" : 607384} ou {"contratoFinId" : 607384, "planoPagamentoId" : 858}

3. Retorno do serviço (Json)



Para obter o retorno do serviço deve-se verificar o status da requisição http. Sempre que o status for 200, significa que o processo foi realizado com sucesso.

3.1. Atributos retornados do serviço para o chamador

Campo Descrição Tipo Observação
log Log do processo de geração de parcelas Integer
resultado Retorna a situação do resultado String(7) Valores possíveis: SUCESSO / ERRO


Exemplo de retorno Json: 

{
    "log": [
        "SUCESSO - Total de parcelas geradas: 6",
        "SUCESSO - Total de título bancários gerados: 1",
        "COM_ADVERTENCIAS - Geração de parcela",
        "COM_ADVERTENCIAS -   Contrato: Nome do aluno (10081392) / 2102-521-1 / 01-A-I/2102-521 / 2018/1",
        "COM_ADVERTENCIAS -     Parcela número: 1 com vencimento em 10/02/2018, com valor bruto de 100,00, do responsável 10081392 - Nome do responsável, não teve o desconto/acréscimo 289 - 
                                Pontualidade 5% - Até dia 10,  proveniente do plano de pagamento  aplicado. Motivo: Data de vencimento da parcela fora da data de validade."
    ],
    "resultado": "SUCESSO"
}

Exemplo de retorno Json para erro: 

 "resultado": "ERRO",
    "erro": {
        "operacao": "br.com.edusoft.mentorweb.servico.controller.ServicoExternoFinanceiroImplJava.geraParcelaTituloInscParaContrato",
        "valores": "{\"contratoFinId\" : 607384000, \"planoPagamentoId\" : 858}",
        "motivo": "EduClientLogProcessoException: O registro da entidade \"com.edusoft.icoruja.vo.financeiro.movimentos.contrato.ContratoFinanceiroVO\" com identificador 607384000 não encontrado."
    }
  • (edição externa)