Serviço externo padrão - Cancelamento de parcela/título

Este serviço realiza o cancelamento de parcelas e título bancário.

Pré-requisitos:

  • Criação de um serviço externo:

  • Criar uma requisição HTTP para obter o token: a requisição precisa ser do método “GET” com a URL apontando para: [protocolo da aplicação]:[endereço da aplicação]/[nome da aplicação do G5]/rest/servicoexterno/token/[nome do serviço externo]. Também precisa passar o usuário e senha do serviço externo via headers.
  • Criar uma requisição HTTP para executar o processo: a requisição precisa ser do método “POST” com a URL apontando para: [protocolo da aplicação]:[endereço da aplicação]/[nome da aplicação do G5]/rest/servicoexterno/execute/[nome do serviço externo]. Precisa passar o token gerado pela requisição anterior no header, assim como o JSON com os parâmetros do serviço externo no body.


Campos que compõem o JSON de serviço externo de cancelamento de parcelas:


Informações sobre os parâmetros:

  1. Parâmetro cancelaSomenteTit sempre será obrigatório;
  2. Um dos parâmetros é obrigatório: contratoFinId ou parcelaId;
  3. Os parâmetros parcelaInicial e parcelaFinal são obrigatórios ao informar o parâmetro de contratoFinId;
  4. Se nenhum ID for informado no parâmetro motivoCancParcId, o sistema buscará automaticamente o valor padrão definido no campo 'Motivo padrão de cancelamento da parcela via serviço externo', localizado na aba de parcelas, nas configurações do financeiro.

Exemplo da passagem de parâmetros por JSON: 

{
    "contratoFinId": 546715,
    "parcelaId": 1015548,
    "parcelaInicial": 4,
    "parcelaFinal": 5,
    "cancelaSomenteTit": 0,
    "motivoCancParcId": 59
}

Exemplo de retorno de parcela cancelada: 

{
    "valor": {
        "totalCanceladas": 1,
        "ocorrencias": [
            {
                "nivelOcorrencia": "SUCESSO",
                "descricao": [
                    "A parcela de código 3, número de documento: 3, conta financeira: 5, do responsável: 1023700 foi cancelada com sucesso.",
                    "Total de parcelas marcadas para cancelamento: 1",
                    "Total de parcelas realmente canceladas: 1"
                ]
            }
        ]
    },
    "resultado": "SUCESSO"
}

Exemplo de retorno de título cancelado: 

{
    "valor": {
        "totalCanceladas": 1,
        "ocorrencias": [
            {
                "nivelOcorrencia": "SUCESSO",
                "descricao": [
                    "Título bancário com o nosso número 589 - 7 cancelado.",
                    "Total de título(s) Cancelado(s): 1"
                ]
            }
        ]
    },
    "resultado": "SUCESSO"
}

Exemplo de retorno de parcela não possui título : 

{
    "resultado": "ERRO",
    "erro": {
        "operacao": "cancelarParcelas",
        "valores": "{\r\n    \"contratoFinId\": 120408,\r\n    \n    \"parcelaInicial\": 5,\r\n    \"parcelaFinal\": 5,\r\n    \"cancelaSomenteTit\": 1\r\n    \n} ",
        "motivo": "FIN_00140 - A(s) parcela(s) selecionada(s) conforme os parâmetros fornecidos não possui(em) títulos para cancelar"
    }
}

Exemplo de retorno quando parâmetro “cancelaSomenteTit” não está preenchido: 

{
    "resultado": "ERRO",
    "erro": {
        "operacao": "Validação de campo obrigatério",
        "valores": "cancelaSomenteTit",
        "motivo": "ISE_00011 - Parâmetros \"Deve cancelar apenas o título e manter a parcela?\" é obrigatório"
    }
}

Exemplo de retorno quando os parâmetros “contratoFinId”, “parcelaInicial” e “parcelaFinal”, ou “parcelaId” não estão preenchidos: 

{
    "resultado": "ERRO",
    "erro": {
        "operacao": "cancelarParcelas",
        "valores": "{\r\n    \n    \n    \"parcelaInicial\": 5,\r\n    \"parcelaFinal\": 5,\r\n    \"cancelaSomenteTit\": 1\r\n    \n} ",
        "motivo": "FIN_00141 - Identificador da parcela ou do contrato financeiro estão nulos. É necessário que o identificador da parcela esteja preenchido ou que o identificador do contrato financeiro, número da parcela inicial e final estejam preenchidos."
    }
}

Exemplo de retorno de erro: 

{
    "resultado": "ERRO",
    "erro": {
        "operacao": "cancelarParcelas",
        "valores": "{\r\n    \"contratoFinId\": 1204088,\r\n    \n    \"parcelaInicial\": 5,\r\n    \"parcelaFinal\": 5,\r\n    \"cancelaSomenteTit\": 1\r\n    \n} ",
        "motivo": "FIN_00139 - Não foi possível encontrar parcelas aptas a serem canceladas com os parâmetros fornecidos."
    }
}




Voltar

  • (edição externa)