...
...
GET /api/broker/
...
ordemabastecimento/{localizador}
Endpoint responsável por Localizar uma Ordem de Abastecimento, retornando dados que serão utilizados nas próximas etapas do processo.
...
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. |
CombustiveisProdutos | Array of Objects <Combustivel><Produto> | Valores de Combustíveis existentes no Estabelecimento para serem apresentados em uma Combo de Seleção no momento da Validação. |
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. |
<Combustivel><Produto>:
Campo | Tipo | Descrição |
Identificador | String | Identificador do Combustível, que deverá ser enviado no momento da Validação. |
Descricao | String | Descrição do Combustível, que deverá ser apresentado na Combo de Seleção. |
...
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:
|
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. |
<Detalhes>:
Campo | Tipo | Descrição |
Solicitante | String | Nome do Frotista/Empresa que cadastrou a Ordem de Abastecimento. |
CombustivelProduto | String | Descrição do Combustível liberado para essa Ordem de Abastecimento, quando houver. |
ValorLitroValorUnitario | 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. |
ValorLitroNegociadoValorUnitarioNegociado | 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. |
QtdLitrosLiberadosQuantidadeLiberada | 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) |
...