Serviço externo padrão - Gera parcela específica

Este serviço realiza a geração de parcelas específicas, com ou sem plano de pagamento. Informar os dados das parcelas para serem geradas, esses dados estarão dentro do array de: parcelas[]. Informações necessárias para a geração das parcelas:

  • Contrato financeiro;
  • Conta bancária;
  • Tipo debito;
  • Parcelas;
  • Valor bruto;
  • Data de vencimento;
  • Gera titulo.


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

Parâmetro Descrição Obrigatório Tipo Observação Valor padrão
contratoFinanceiroId Identificador do contrato financeiro Sim Integer
contaBancariaCarteiraId Id da conta bancária Sim Integer
tipoDebitoId Id do tipo de débito Sim Integer
parcelas Array que conterá as parcelas que se deseja gerar Sim Integer
valorBruto Valor da parcela Sim Integer
dataVencimento Data de vencimento da parcela Sim Integer
geraTitulo Se deverá gerar título Sim Integer
planoPagamentoId Id do plano de pagamento Não Integer Quando não informado, se houverem descontos no contrato financeiro, o desconto não será aplicado.


Deve-se passar no cabeçalho da requisição, o parâmetro token. O valor deste parâmetro é gerado pelo serviço de geração de token.

2. Exemplo de chamada do serviço

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

Obs.: antigamente, este serviço se chamava “geraParcelaSemPlanoPagamento”, então, em alguns clientes, o serviço externo pode estar com este nome.


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

O exemplo abaixo irá gerar 2 parcelas: 

{
   "contratoFinanceiroId":738463,
   "contaBancariaCarteiraId":48,
   "tipoDebitoId":17,
   "planoPagamentoId":10,
   "parcelas":[
      {
         "valorBruto":200.0,
         "dataVencimento":"01/10/2022",
         "geraTitulo":0
      },
      {
         "valorBruto":210.0,
         "dataVencimento":"01/11/2022",
         "geraTitulo":0
      }
   ]
}

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
parcelas Parcelas geradas Array Com os valores brutos das parcelas, data de vencimento e se gerou título
resultado Retorna a situação do resultado String(7) Valores possíveis: SUCESSO / ERRO


Exemplo de retorno Json: 

{
    "valor": {
        "logs": [
            "SUCESSO - Total de parcelas geradas: 2",
       ],
        "parcelas": [
            {
                "id": 6155458,
                "nroParcela": 7,
                "valorBruto": 200.00,
                "dataVencimento": "01/10/2022 00:00:00",
                "isParcelaTotalmentePaga": false
            },
            {
                "id": 6155459,
                "nroParcela": 8,
                "valorBruto": 210.00,
                "dataVencimento": "01/11/2022 00:00:00",
                "isParcelaTotalmentePaga": false
            }
        ]
    },
    "resultado": "SUCESSO"
}

Exemplo de retorno Json para erro: 

{
    "resultado": "ERRO",
    "erro": {
        "operacao": "Conversão json",
        "valores": "{\r\n   \"contratoFinanceiroId\":99999999999999999999999,\r\n   \"contaBancariaCarteiraId\":48,\r\n   \"tipoDebitoId\":17,\r\n   \"parcelas\":[\r\n      {\r\n         \"valorBruto\":200.0,\r\n         \"dataVencimento\":\"01/10/2022\",\r\n         \"geraTitulo\":0\r\n      },\r\n      {\r\n         \"valorBruto\":210.0,\r\n         \"dataVencimento\":\"01/11/2022\",\r\n         \"geraTitulo\":0\r\n      }\r\n   ]\r\n}",
        "motivo": "ISE_00008 - Parâmetros inválidos. Erro original: com.google.gson.JsonSyntaxException: java.lang.NumberFormatException: Expected a long but was 99999999999999999999999 at line 2 column 50\n\tat com.google.gson.internal.bind.TypeAdapters$8.read(TypeAdapters.java:254)\n\tat com.google.gson.internal.bind.TypeAdapters$8.read(TypeAdapters.java:244)\n\tat com.google.gson.internal.bind.ReflectiveTypeAdapterFactory$1.read(ReflectiveTypeAdapterFactory.java:93)\n\tat com.google.gson.internal.bind.ReflectiveTypeAdapterFactory$Adapter.read(ReflectiveTypeAdapterFactory.java:172)\n\tat com.google.gson.Gson.fromJson(Gson.java:795)\n\tat com.google.gson.Gson.fromJson(Gson.java:761)\n\tat com.google.gson.Gson.fromJson(Gson.java:710)\n\tat com.google.gson.Gson.fromJson(Gson.java:682)\n\tat com.edusoft.base.servico.util.EduServicoJson.deserializa(EduServicoJson.java:47)\n\tat br.com.edusoft.servicoExterno.server.ServicoExternoExecuteJava.execute(ServicoExternoExecuteJava.java:52)\n\tat br.com.edusoft.servicoExterno.server.ServicoExternoExecuteFactory.execute(ServicoExternoEx"
    }
}
  • (edição externa)