...
...
GET /api/broker/
...
ordemAbastecimento/localizar/{localizador}
Endpoint responsável por Localizar uma Ordem de Abastecimento, retornando dados que serão utilizados nas próximas etapas do processo.
Importante:
Os Campos retornados e solicitados pelo Transportadorsão dinâmicos. O preenchimento dos mesmos será necessário para que ocorra a Validação da Ordem de Abastecimento posteriormente.
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ção | Obrigatório |
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. | Sim |
IdentificadorCombustivel | String | Identificador do Combustível liberado para essa Ordem de Abastecimento, quando houver. | Sim |
Campos | Array of Objects <Campo> | Valores de Campos solicitados pelo Transportador. | Sim | Produtos
Combustiveis | Array of Objects <Produto><Combustivel> | 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. | |
Sim | |||
Detalhes | Object <Detalhes> | Dados da Ordem de Abastecimento a serem apresentados para o Usuário na Tela de Detalhes da Ordem de Abastecimento. | Sim |
<Produto><Combustivel>:
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 |
Solicitante | String | Nome do Frotista/Empresa que cadastrou a Ordem de Abastecimento. |
DescricaoProdutoDescricaoCombustivel | String | Descrição do Combustível liberado para essa Ordem de Abastecimento, quando houver. |
ValorUnitarioValorLitro | 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. |
ValorUnitarioNegociadoValorLitroNegociado | 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. |
QuantidadeLiberadaQuantidadeLitrosLiberada | 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 | ||
|---|---|---|
| ||
{
"validada": false
"combustiveis": [
,
"identificadorCombustivel": "DSS10",
"campos": [
{
"chave": "23",
"descricao": "Hodômetro",
"tipo": "integer",
"identificadorTipo": 2,
"obrigatorio": true,
"precisao": null,
"valorMinimo": null,
"valorMaximo": null,
"maxlength": null,
"somenteNumeros": null,
"dominio": null
},
{
"identificadorchave": "GSLCM24",
"descricao": "Placa",
"tipo": "string",
"identificadorTipo": 1,
"Gasolina Comum" "obrigatorio": true,
"precisao": null,
"valorMinimo": null,
"valorMaximo": null,
"maxlength": null,
"somenteNumeros": false,
"dominio": null
},
{
"chave": "25",
"descricao": "CPF",
"tipo": "string",
"identificadorTipo": 1,
"obrigatorio": true,
"precisao": null,
"valorMinimo": null,
"valorMaximo": null,
"maxlength": 11,
"somenteNumeros": true,
"dominio": null
},
{
"identificadorchave": "GSLAT26",
"descricao": "Valor do Litro",
"tipo": "decimal",
"identificadorTipo": 3,
"obrigatorio": true,
"precisao": 3,
"valorMinimo": 0.000,
"Gasolina Aditivada""valorMaximo": null,
"maxlength": null,
"somenteNumeros": null,
"dominio": null
},
{
"chave": "27",
"descricao": "Data do Abastecimento",
"tipo": "date",
"identificadorTipo": 7,
"obrigatorio": true,
"precisao": null,
"valorMinimo": null,
"valorMaximo": null,
"maxlength": null,
"somenteNumeros": null,
"dominio": null
},
{
"chave": "29",
"descricao": "Dia da Semana",
"tipo": "Select",
"identificadorTipo": 5,
"identificador "obrigatorio": true,
"precisao": null,
"valorMinimo": null,
"valorMaximo": null,
"maxlength": null,
"somenteNumeros": null,
"dominio": [
{
"valor": "DSS102",
"descricao": "Segunda"
},
{
"valor": "3",
"Diesel S-10" "descricao": "Terça"
}
]
},
{
"campos": [
"chave": "30",
"descricao": "Abastecimento Previsto",
"tipo": "Boolean",
"identificadorTipo": 4,
"obrigatorio": false,
"precisao": null,
"valorMinimo": null,
"valorMaximo": null,
"maxlength": null,
"somenteNumeros": null,
"dominio": null
},
{
"chave": "2331",
"descricao": "HodômetroDia da Semana",
"tipo": "integerMultiSelect",
"identificadorTipo": 26,
"obrigatorio": true,
"precisao": null,
"valorMinimo": null,
"valorMaximo": null,
"maxlength": null,
"somenteNumeros": null,
"dominio": [
{
"valor": "2",
"descricao": "Segunda"
},
{
"valor": "3",
"descricao": "Terça"
}
]
},
{
"chave": "32",
"descricao": "Documento Adicional",
"tipo": "ByteArray",
"identificadorTipo": 9,
"obrigatorio": false,
"precisao": null,
"24", "valorMinimo": null,
"valorMaximo": null,
"maxlength": null,
"somenteNumeros": null,
"dominio": null
},
{
"chave": "27",
"descricao": "PlacaData do Abastecimento",
"tipo": "stringdate",
"identificadorTipo": 17,
"obrigatorio": true,
"precisao": null,
"valorMinimo": null,
"valorMaximo": null,
"maxlength": null,
"somenteNumeros": null,
"dominio": null
}
],
"detalhescombustiveis": [
{
"identificador": "GSLCM",
"solicitantedescricao": "Gasolina "IS Transportes",Comum"
},
{
"identificador": "DSS10",
"produtodescricao": "Diesel S-10"
}
],
"detalhes": {
"solicitante": "IS Transportes",
"descricaoCombustivel": "Diesel S-10",
"valorLitro": 35.800000,
"descontoNegociado": 0.300,
"valorLitroNegociado": 34.500700,
"qtdLitrosLiberadosquantidadeLitrosLiberada": 0.000,
"tanqueCheio": true
}
} |