Versions Compared

Version Old Version 4 New Version Current
Changes made by

Ivan Saavedra (Unlicensed)

Ivan Saavedra (Unlicensed)

Saved on

Key

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

POST URL

Headers    

Content-Type

application/json

Authorization

Api-Key

 

Importante:

  • Se no objeto de Resposta dos campos solicitados no Retorno da Localização houver uma resposta de um campo do tipo MultiSelect (6), os valores serão delimitados por “ ; “ .

Request Body    application/json

...

Campo

Tipo

Descrição

Obrigatório

LocalizadorIdOrdemPagamento

StringLong

Código de Identificação da Ordem de Pagamento.

Sim

IdentificadorProduto

String

Identificador do Produto que será Abastecidovendido.

Sim

ValorUnitario

Decimal

Valor da Unidade do Produto que foi Vendido.

Sim

Resposta

Array Of Object <Resposta>

Objeto de Resposta dos campos solicitados no Retorno da Localização.

Sim

...

Campo

Tipo

Descrição

Chave

String

Chave do Campo solicitado na Etapa de Localização.

Valor

String

Valor preenchido para Validação.

 

JSON:

Code Block
{
    "localizadorIdOrdemPagamento": "128",
    "identificadorProdutoIdentificadorProduto": "DSS10",
    "ValorUnitario": 5.000,
    "camposCampos": [
          {
          "chaveChave": "23",
          "descricaoDescricao": "1000"
          },
          {
          "chaveChave": "24",
          "descricaoDescricao": "ZZZ1234"
          }
    ]
}

 

Response Body    application/json

 

Campo

Tipo

Descrição

LocalizadorObrigatório

IdOrdemPagamento

StringLong

Código de Identificação da Ordem de Pagamento.

Sim

Mensagem

String

Mensagem indicando resultado da operação.

Não

Detalhes

Object <Detalhe>

Dados da Ordem de Pagamento a serem apresentados para o Usuário.

Sim

 

<Detalhe><Detalhes>:

Campo

Tipo

Descrição

Obrigatório

Solicitante

String

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

Sim

DescricaoCombustivelDescricaoProduto

String

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

ValorLitroSim

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.

ValorLitroNegociado

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.

QtdLitrosLiberados

Decimal

Quantidade de Litros liberados para abastecimentoQuantidadeIndefinida

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 liberada para compra. (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
{
    "LocalizadorIdOrdemPagamento": "128",
    "Mensagem": "Ordem de Abastecimento Validada com Sucesso!",
    "detalhesDetalhes": {
          "solicitanteSolicitante": "IS Transportes",
          "produtoDescricaoProduto": "Diesel",
          "valorLitroQuantidadeIndefinida": 3.800true,
          "descontoNegociadoQuantidadeLiberada": 0.300,
          "valorLitroNegociado": 3.500,
          "qtdLitrosLiberados": 0.000,
          "tanqueCheio": true
    }
}