POST /api/ordemAbastecimento/validarParametros
Endpoint responsável validar todos os Parâmetros de Controle cadastrados pelo Frotista. Nele serão enviados os campos necessários para essa validação e, caso configurado previamente pelo responsável pela Ordem de Abastecimento, impedirá o pagamento quando existir alguma não conformidade.
Headers
Content-Type | application/json |
Authorization | Bearer {token} |
Request Body application/json
Schema:
Campo | Tipo | Descrição | Obrigatório |
Localizador | String | Código de Identificação da Ordem de Abastecimento, disponibilizado pelo Motorista. | Sim |
Combustivel | String | Descrição do Combustível Abastecido. | Sim |
CamposResposta | Array Of Object | Objeto de Resposta dos campos solicitados na Etapa de Localização. | Sim |
Campos:
Campo | Tipo | Descrição |
Chave | String | Chave do Campo solicitado na Etapa de Localização. |
Valor | String | Valor preenchido para Validação. |
JSON:
{ "Localizador": "128", "Combustivel": "DSS10", "campos": [ { "chave": "23", "descricao": "1000" }, { "chave": "24", "descricao": "ZZZ1234" } ] }
Response Body application/json
Campo | Tipo | Descrição |
Localizador | String | Código de Identificação da Ordem de Abastecimento, disponibilizado pelo Motorista. |
Mensagem | String | Mensagem indicando resultado da operação. |
Detalhes | Array of Objects <Detalhe> | Dados da Ordem de Abastecimento a serem apresentados para o Usuário. |
UsuarioAutorizador | Boolean | Booleana que indica se o Usuário Logado tem privilégios de Autorizar uma Ordem de Abastecimento. No caso negativo, sistema não poderá Avançar a Tela de Detalhes da Ordem de Abastecimento. Opção utilizada apenas por Parceiros que possuem privilégios diferentes para os usuários que estão acessando a plataforma. |
<Detalhe>:
Campo | Tipo | Descrição |
Solicitante | String | Nome do Frotista/Empresa que cadastrou a Ordem de Abastecimento. |
Combustivel | String | Descrição do Combustível liberado para essa Ordem de Abastecimento, quando houver. |
ValorLitro | Decimal | Valor por Litro do Combustível em questão, cadastrado previamente pelo Posto de Combustível. |
DescontoNegociado | Decimal | Valor de Desconto Negociado previamente pelo Posto de Combustível e o Transportador/Frotista. |
ValorLitroNegociado | Decimal | Valor por Litro Negociado. No caso de não existir uma negociação prévia, constará o Valor por Litro cadastrado pelo Posto de Combustível. |
QtdLitrosLiberados | Decimal | Quantidade de Litros liberados para abastecimento. (Disponibilizado apenas para Ordens de Abastecimento que não sejam Tanque Cheio) |
TanqueCheio | Boolean | Indica se a Ordem de Abastecimento é para Tanque Cheio. Nesse caso, o Valor Total da Ordem será a Quantidade de Litros Abastecidos multiplicado pelo Valor Litro Negociado (Disponibilizado nesse objeto) |
JSON:
{ "Localizador": "128", "Mensagem": "Ordem de Abastecimento Validada com Sucesso!", "solicitante": "Cleisson", "produto": "Diesel", "valorLitro": 3.800, "descontoNegociado": 0.300, "valorLitroNegociado": 3.500, "qtdLitrosLiberados": 0.000, "tanqueCheio": true }