...
...
POST /api/broker/ordemAbastecimento/
...
validar
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 da Ordem de Abastecimentoem questão, impedirá o pagamento quando existir alguma não conformidade.
Importante:
Se no objeto de Resposta dos campos solicitados no Retorno da Localização houver uma resposta de um campo do tipo MultiSelect (6), os valores serão delimitados por “ ; “ .
Headers
Content-Type | application/json |
Authorization | Bearer {token} |
...
Campo | Tipo | Descrição | Obrigatório |
Localizador | String | Código de Identificação da Ordem de Abastecimento, disponibilizado pelo Motorista. | Sim |
CombustivelIdentificador | String | Descrição Identificador do Combustível que será Abastecido. | Sim |
ValorLitro | Decimal | Valor por Litro do Combustível que será Abastecido. | Sim |
CamposRespostaResposta | Array Of Object <Resposta> | Objeto de Resposta dos campos solicitados na Etapa de no Retorno da Localização. | Sim |
CamposResposta:
Campo | Tipo | Descrição |
Chave | String | Chave do Campo solicitado na Etapa de Localização. |
Valor | String | Valor preenchido para Validação. |
...
Code Block | ||
---|---|---|
| ||
{ "Localizadorlocalizador": "128", "Combustivelidentificador": "DSS10", "valorLitro": 3.900, "camposresposta": [ { "chave": "23", "descricaovalor": "1000" }, { "chave": "24", "descricaovalor": "ZZZ1234" }, { "chave": "25", "valor": "82193909210" }, { "chave": "29", "valor": "2" }, { "chave": "31", "valor": "2;3;4" } ] } |
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 Object <Detalhe> | Dados da Ordem de Abastecimento a serem apresentados para o Usuário. |
<Detalhe><Detalhes>:
Campo | Tipo | Descrição |
Solicitante | String | Nome do Frotista/Empresa que cadastrou a Ordem de Abastecimento. |
CombustivelDescricaoCombustivel | 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. |
QtdLitrosLiberadosQuantidadeLitrosLiberada | 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) |
...
Code Block | ||
---|---|---|
| ||
{ "Localizador": "128", "Mensagem": "Ordem de Abastecimento Validada com Sucesso!", "detalhes": { "solicitante": "CleissonIS Transportes", "produto": "descricaoCombustivel": "Diesel", "valorLitro": 3 3.800, "descontoNegociado": 0 0.300, "valorLitroNegociado": 3 3.500, "qtdLitrosLiberados": 0.000, "quantidadeLitrosLiberada": 0.000, "tanqueCheio": true true } } |