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 3 Next »

GET URL/{localizador}

Headers    

Content-Type

application/json

Authorization

Api-Key

 

Request Query String application/json

Schema:

Campo

Tipo

Descrição

Obrigatório

localizador

String

Código de Identificação da Ordem de Abastecimento, disponibilizado pelo Motorista.

Sim

 

Response Body    application/json

Schema:

Campo

Tipo

Descrição

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.

Campos

Array of Objects <Campo>

Valores de Campos solicitados pelo Transportador.

Detalhes

Object <Detalhes>

Dados da Ordem de Abastecimento a serem apresentados para o Usuário na Tela de Detalhes da Ordem de Abastecimento.

 

<Campo>:

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.

Obrigatorio

Boolean

Booleana que identifica se o Campo é obrigatório.

Precisao

Int32

Precisão do Campo. Apenas válido para Campos Decimais.

ValorMinimo

Decimal

Valor Mínimo do Campo. Válido para campos Numéricos.

ValorMaximo

Decimal

Valor Máximo do Campo. Válido para Campos Numéricos.

MaxLength

Int32

Tamanho máximo do Campo. Válido para Campos de Texto.

SomenteNumeros

Boolean

Booleana que indica que o input precisa aceitar somente números.

 

<Detalhes>:

Campo

Tipo

Descriçã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.

ValorUnitario

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.

ValorUnitarioNegociado

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.

QuantidadeLiberada

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: 

{
    "validada": false
    "campos": [
          {
          "chave": "23",
          "descricao": "Hodômetro",
          "tipo": "integer",
          "identificadorTipo": 2,
          "obrigatorio": true
          },
          {
          "chave": "24",
          "descricao": "Placa",
          "tipo": "string",
          "identificadorTipo": 1,
          "obrigatorio": true
          }
    ],
    "detalhes": {
          "solicitante": "IS Transportes",
          "produto": "Diesel",
          "valorLitro": 3.800,
          "descontoNegociado": 0.300,
          "valorLitroNegociado": 3.500,
          "qtdLitrosLiberados": 0.000,
          "tanqueCheio": true
    }
}

 

  • No labels