Versions Compared

Key

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

GET URL/{localizador}

Headers    

...

Campo

Tipo

Descrição

Obrigatório

localizadorIdOrdemPagamento

String

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

Sim

 

Response Body    application/json

Schema:

Campo

Tipo

Descrição

Obrigatório

Validada

Boolean

Indica se a Ordem de Abastecimento Pagamento 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

IdentificadorProduto

String

Identificador do Produto liberado para essa Ordem de Pagamento, quando houver.

Sim

Campos

Array of Objects <Campo>

Valores de Campos Dados solicitados pelo Transportador.Parceiro, para serem Capturados e Validados durante o processo de Pagamento.

Sim

Detalhes

Object <Detalhes>

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

Sim

 

<Campo>:

Campo

Tipo

Descrição

Obrigatório

Chave

String

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

Sim

Descricao

String

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

Sim

Tipo

String

Tipo do Campo que será apresentado.

Tipos esperados:

  • String (1)

  • Integer (2)

  • Decimal (3)

  • Bool Boolean (4)

  • Select SingleSelect (5)

  • DateTime MultiSelect (6)

  • Date (7)

  • Time (8)

  • ByteArray (9)

Sim

IdentificadorTipo

Integer

Identificador do Tipo do Campo.

Sim

Obrigatorio

Boolean

Booleana que identifica se o Campo é obrigatório.

Sim

Precisao

Int32

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

Não

ValorMinimo

Decimal

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

Não

ValorMaximo

Decimal

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

Não

MaxLength

Int32

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

Não

SomenteNumeros

Boolean

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

Não

Dominio

Array Of Objects <Item>

Domínio de dados, obrigatórios para os Tipos SingleSelect (5) e MultiSelect (6).

...

Não

 <Item>:

Campo

Tipo

Descrição

Valor

String

Valor do Item que será disponibilizado no Select.

Descricao

String

Descrição do Item, quer deverá ser apresentado no Select.

<Detalhes>:

Campo

Tipo

Descrição

Obrigatório

Solicitante

String

Nome do Frotista/Empresa que cadastrou a Solicitante responsável pela Ordem de AbastecimentoPagamento.

Sim

ProdutoDescricaoProduto

String

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

ValorUnitarioSim

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.QuantidadeIndefinida

Boolean

Indica se a Ordem de Pagamento não possui uma Quantidade Previamente Definida. Nesse caso, a venda será realizada respeitando a Quantidade Definida pelo Representante do Solicitante (Comprador), no momento da Compra.

Sim

QuantidadeLiberada

Decimal

Quantidade de Litros liberados liberada para abastecimentocompra. (Disponibilizado apenas para Ordens de Abastecimento Pagamento 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)

Não

 

JSON: 

Code Block
{
    "validadaValidada": false,
    "IdentificadorProduto": "campos"DSLCM",
    "Campos": [
          {
          "chaveChave": "23",
          "descricaoDescricao": "Hodômetro",
          "tipoTipo": "integer",
          "identificadorTipoIdentificadorTipo": 2,
          "obrigatorioObrigatorio": true
          },
          {
          "chaveChave": "24",
          "descricaoDescricao": "Placa",
          "tipoTipo": "string",
          "identificadorTipoIdentificadorTipo": 1,
          "obrigatorioObrigatorio": true,
          }"MaxLength": 9
   ],     "detalhes": { }
    ],
    "solicitanteDetalhes": "IS Transportes",{
          "produtoSolicitante": "DieselIS Transportes",
          "valorLitroDescricaoProduto": 3.800,
          "descontoNegociado": 0.300"Diesel",
          "valorLitroNegociadoQuantidadeIndefinida": 3.500true,
          "qtdLitrosLiberadosQuantidadeLiberada": 0.000,
          "tanqueCheio": true
    }
}