POST /api/broker/ordemAbastecimento/validar

Endpoint responsável validar todos os Parâmetros de Controle cadastrados pelo Frotista. Nele serão enviados os campos necessários para essa validação e, caso configurado previamente pelo responsável da Ordem em questão, impedirá o pagamento quando existir alguma não conformidade.

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 “ ; “ .

Headers

Content-Type	application/json
Authorization	Bearer {token}

Request Body application/json

Schema:

Campo	Tipo	Descrição	Obrigatório
Localizador	String	Código de Identificação da Ordem de Abastecimento, disponibilizado pelo Motorista.	Sim
Identificador	String	Identificador do Combustível que será Abastecido.	Sim
ValorLitro	Decimal	Valor por Litro do Combustível que será Abastecido.	Sim
Resposta	Array Of Object <Resposta>	Objeto de Resposta dos campos solicitados no Retorno da Localização.	Sim

Resposta:

Campo	Tipo	Descrição
Chave	String	Chave do Campo solicitado na Etapa de Localização.
Valor	String	Valor preenchido para Validação.

JSON:

{
    "localizador": "128",
    "identificador": "DSS10",
    "valorLitro": 3.900,
    "resposta": [
          {
            "chave": "23",
            "valor": "1000"
          },
          {
            "chave": "24",
            "valor": "ZZZ1234"
          },
          {
             "chave": "25",
             "valor": "82193909210"
          },
          {
             "chave": "29",
             "valor": "2"
          },
          {
             "chave": "31",
             "valor": "2;3;4"
          }
    ]
}

Response Body application/json

Campo	Tipo	Descrição
Localizador	String	Código de Identificação da Ordem de Abastecimento, disponibilizado pelo Motorista.
Mensagem	String	Mensagem indicando resultado da operação.
Detalhes	Object <Detalhe>	Dados da Ordem de Abastecimento a serem apresentados para o Usuário.

<Detalhes>:

Campo	Tipo	Descrição
Solicitante	String	Nome do Frotista/Empresa que cadastrou a Ordem de Abastecimento.
DescricaoCombustivel	String	Descrição do Combustível liberado para essa Ordem de Abastecimento, quando houver.
ValorLitro	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.
QuantidadeLitrosLiberada	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:

{
    "Localizador": "128",
    "Mensagem": "Ordem de Abastecimento Validada com Sucesso!",
    "detalhes": {
          "solicitante": "IS Transportes",
          "descricaoCombustivel": "Diesel",
          "valorLitro": 3.800,
          "descontoNegociado": 0.300,
          "valorLitroNegociado": 3.500,
          "quantidadeLitrosLiberada": 0.000,
          "tanqueCheio": true
    }
}

Documentação WebApi 1.0 - TMPay Broker

Validar Ordem de Abastecimento

POST /api/broker/ordemAbastecimento/validar

Headers

Request Body application/json

Response Body application/json