Inclusão de Parcelas de Frete (Eventos) V2


Método responsável pela inclusão de eventos em uma viagem.


Request


  • ENDPOINT: ViagemV2/AdicionarEventos
  • VERBO: PUT


Índice Chave Descrição Elem. Tipo Ocor. Tam. Versão
1 Token Token de autenticação E Caractere 1-1 100 1.0
2 CNPJAplicacao CNPJ para autenticação E Caractere 1-1 14 1.0
3 CNPJEmpresa CNPJ da empresa responsável pela requisição E Caractere 1-1 14 1.0
4 DocumentoUsuarioAudit Documento do usuário que está realizando a operação E Caractere 1-1 14 1.0
5 NomeUsuarioAudit Nome do usuário que está realizando a operação E Caractere 1-1 60 1.0
6 ViagemId Código da viagem a ser cancelada E Inteiro 1-1 10 1.0
5 Eventos Parcelas da Viagem A Inteiro 1-1 10 1.0
5.1 HabilitarPagamentoCartao Ao definir o parâmetro de pagamento como true, a transação será processada via Extratta (Cartão).
Caso o proprietário não tenha um cartão vinculado, o sistema criará automaticamente uma conta virtual, na qual o valor será disponibilizado.
Se o parâmetro pagamento for definido como false, dois cenários são possíveis:
1- O pagamento poderá ser registrado como depósito (transação não irá ocorrer pela Extratta);
2- O pagamento poderá ser realizado via PIX através da Extratta, desde que o cliente tenha contratado o serviço de pagamento via PIX e o proprietário tenha uma chave PIX válida cadastrada.		 E Booleano 1-1 True/False 1.0
5.2 NumeroControle Número de controle para ERP E Caractere 1-0 100 1.0
5.3 TipoEvento Enumeração do tipo de parcela, podendo ser:
0: Adiantamento;
1: Saldo;
2: Estadia;
3: RPA;
4: Tarifa ANTT;
5: Abastecimento;
6: Abono;		 E Inteiro 1-0 1 1.0
5.4 ValorPagamento Valor do pagamento da viagem E Decimal 1-1 10,3 1.0
5.5 Status Status do evento de pagamento:
0: Aberto/Pendente;
1: Bloqueado;
2: Baixado (Efetivado/Liquidado);
3: Cancelado;
5: Agendado.		 E Inteiro 1-1 1 1.0


Modelo de Json - Request


{
  "Token": "",
  "CNPJAplicacao": "",
  "CNPJEmpresa": "",
  "DocumentoUsuarioAudit": "",
  "NomeUsuarioAudit": "",
  "ViagemId": 0,
  "Eventos": [
    {
        "HabilitarPagamentoCartao": false,
        "NumeroControle": "",
        "TipoEvento": 0,
        "ValorPagamento": 0.0,
        "Status": 0,
    }
  ]
}


Response


Índice Chave Descrição Elem. Tipo Ocor. Tam. Versão
1 Sucesso True: Caso não tenha acontecido nenhuma exceção ou validação no processo mesmo não trazendo dados no retorno
False: Qualquer validação ou exceção que impediu o processo de ser concluído		 E Booleano 1-1 True/False 1.0
2 Mensagem Mensagem de retorno E Caractere 1-1 100 1.0
3 Faults Objeto pai que contém uma lista de erro(s) ou aviso(s) caso aconteça A 0-1
3.1 Type Tipo de erro ou aviso, podendo ser eles:
1 - Error;
2 - Alert.		 E Inteiro 0-1 1 1.0
3.2 Code Codigo do erro E Caractere 0-1 10 1.0
3.3 Message Mensagem do erro E Caractere 0-1 200 1.0


Modelo de Json - Response


{
  "Sucesso": false,
  "Mensagem": "",
  "Faults": [
    {
        "Type": 0,
        "Code": "",
        "Message": ""
    }
  ]
}