Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

GET /api/ordemAbastecimento/{localizador}

Endpoint responsável por Localizar uma Ordem de Abastecimento e retornar os dados da mesma para que seja disponibilizado na interface do Sistema de Pagamento.

Importante: Caso a Ordem de Abastecimento retorne como Validada, a etapa de Validação da Ordem de Abastecimento não deve ser apresentada, avançando direto para a etapa de Autorização da Ordem de Abastecimento.

Headers    

Content-Type

application/json

Authorization

Bearer {token}

...

Schema:

Campo

Tipo

DescriçãonomeFrotista

Validada

Boolean

Indica se a Ordem de Abastecimento já se encontra Validada. Em caso positivo, a etapa de Validação da Ordem de Abastecimento não deve ser apresentada, avançando direto para a etapa de Autorização da Ordem de Abastecimento.

Solicitante

String

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

descricaoCombustivelProduto

String

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

valorLitroNegociadoValorUnitarioNegociado

Decimal

Valor por Litro Negociado. No caso de não existir uma negociação prévia, constará na Ordem de Abastecimento os valores referentes ao preço na Bomba no momento em que a Ordem foi cadastrada. qtLitrosLiberadoso Valor por Litro cadastrado pelo Posto de Combustível.

QtdLiberada

Decimal

Quantidade de Litros liberados para abastecimento.

valorTotalOrdemValorTotalOrdem

Decimal

Valor total da Ordem de Abastecimento.

tanqueCheioTanqueCheio

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)

Campos

Objeto

Valores de Campos solicitados pelo Transportador.

Campos:

Campo

Tipo

Descrição

Chave

String

Chave do Campo, que será enviada no momento da Validação.

Descricao

String

Descrição do Campo para ser utilizado como Legenda/Label.

Tipo

String

Tipo do Campo que será apresentado.

Tipos esperados:

  • String (1)

  • Integer (2)

  • Decimal (3)

  • Bool (4)

  • Select (5)

  • DateTime (6)

IdentificadorTipo

Integer

Identificador do Tipo do Campo.

JSON: 

Code Block
languagejson
{
    "nomeFrotista": "Cleisson",
    "descricaoCombustivel": "Diesel",
    "valorLitroNegociado": 3.50,
    "qtLitrosLiberados": 100.00,
    "valorTotalOrdem": 350.00,
    "tanqueCheio": null
}

...