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

Este serviço realiza a geração de parcelas e o título bancário da parcelas. Se informada uma parcela inicial e final para gerar, serão gerada apenas essas, caso não seja informado, serão geradas todas as parcelas do plano de pagamento, o mesmo ocorro para os títulos, porém para não gerar títulos, deve ser colocado nos parâmetros do serviço parcela inicial e final de geração de titulo 0. 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. Se não for informado, o sistema irá escolher um plano de pagamento aleatóriamente, de acordo com os filtros. Porém, é expressamente recomendado que seja informado o plano de pagamento.	Não	Integer
parcelaInicial	Parcela inicial para geração	Não	Integer
parcelaFinal	Parcela final para geração	Não	Integer
parcelaInicialTitulo	Parcela inicial para geração dos titulos	Não	Integer
parcelaFinalTitulo	Parcela inicial para geração dos titulos	Não	Integer

2. Exemplo de chamada do serviço

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

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

{
  "contratoFinId":541907,
  "planoPagamentoId":3569,
  "parcelaInicial":1,
  "parcelaFinal": 2,
  "parcelaInicialTitulo": 2,
  "parcelaFinalTitulo": 2
}

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
valor	Log do processo de geração de parcelas	Integer
resultado	Retorna a situação do resultado	String(7)	Valores possíveis: SUCESSO / ERRO

Observação: No retorno dos dados da parcela gerada, o campo “isParcelaTotalmentePaga” retorna como true se a parcela for gerada com a situação “Paga”. Exemplo de cenário em que isso acontece: Parcela gerada com um desconto aplicado de 100%.

Exemplo de retorno Json:

{
    "valor": {
        "logs": [
            "SUCESSO - Total de parcelas geradas: 2",
            "SUCESSO - Total de título bancários gerados: 2"
        ],
        "parcelas": [
            {
                "id": 480790,
                "nroParcela": 1,
                "valorBruto": 10.00,
                "dataVencimento": "01/12/2021 00:00:00",
                "isParcelaTotalmentePaga": false,
                "titulo": {
                    "id": 508237,
                    "valorTitulo": 10.00,
                    "linhaDigitavel": "23791.26564 09100.009936 39410.062028 2 88210000001000"
                }
            },
            {
                "id": 480791,
                "nroParcela": 2,
                "valorBruto": 100.00,
                "dataVencimento": "20/02/2020 00:00:00",
                "isParcelaTotalmentePaga": true,
                "titulo": {
                    "id": 508225,
                    "valorTitulo": 100.00,
                    "linhaDigitavel": "23791.26564 09100.009936 39310.062029 5 81710000010000"
                }
            }
        ]
    },
    "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."
    }