DOCUMENTAÇÃO CORPORATIVA

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 22 Next »

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

ValorLitro

Decimal

Valor por Litro Abastecido.

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",
    "ValorLitro": 3.00,
    "Combustivel": "Diesel",
    "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.

Solicitante

String

Nome do Frotista/Empresa que cadastrou a Ordem de Abastecimento.

Produto

String

Descrição do Combustível liberado para essa Ordem de Abastecimento, quando houver.

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)

ValorTotal

Decimal

Valor total da Ordem de Abastecimento. (Disponibilizado apenas para Ordens de Abastecimento que não sejam Tanque Cheio)

JSON:

{
    "Localizador": "128",
    "Mensagem": "Ordem de Abastecimento Validada com Sucesso!"
}

  • No labels