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 Transportador sã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}

Request Query String application/json

Schema:

Campo	Tipo	Descrição	Obrigatório
localizador	String	Código de Identificação da Ordem de Abastecimento, disponibilizado pelo Motorista.	Sim

Response Body application/json

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
Combustiveis	Array of Objects <Combustivel>	Valores de Combustíveis existentes no Estabelecimento para serem apresentados em uma Combo de Seleção no momento da Validação.	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

<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>:

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) Boolean (4) SingleSelect (5) 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
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:

{
    "validada": false,
    "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
        },
        {
            "chave": "24",
            "descricao": "Placa",
            "tipo": "string",
            "identificadorTipo": 1,
            "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
        },
        {
            "chave": "26",
            "descricao": "Valor do Litro",
            "tipo": "decimal",
            "identificadorTipo": 3,
            "obrigatorio": true,
            "precisao": 3,
            "valorMinimo": 0.000,
            "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,
            "obrigatorio": true,
            "precisao": null,
            "valorMinimo": null,
            "valorMaximo": null,
            "maxlength": null,
            "somenteNumeros": null,
            "dominio": [
                {
                    "valor": "2",
                    "descricao": "Segunda"
                },
                {
                    "valor": "3",
                    "descricao": "Terça"
                }
            ]
        },
        {
            "chave": "30",
            "descricao": "Abastecimento Previsto",
            "tipo": "Boolean",
            "identificadorTipo": 4,
            "obrigatorio": false,
            "precisao": null,
            "valorMinimo": null,
            "valorMaximo": null,
            "maxlength": null,
            "somenteNumeros": null,
            "dominio": null
        },
        {
            "chave": "31",
            "descricao": "Dia da Semana",
            "tipo": "MultiSelect",
            "identificadorTipo": 6,
            "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,
            "valorMinimo": null,
            "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
        }
    ],
    "combustiveis": [
        {
            "identificador": "GSLCM",
            "descricao": "Gasolina Comum"
        },
        {
            "identificador": "DSS10",
            "descricao": "Diesel S-10"
        }
    ],
    "detalhes": {
        "solicitante": "IS Transportes",
        "descricaoCombustivel": "Diesel S-10",
        "valorLitro": 5.000,
        "descontoNegociado": 0.300,
        "valorLitroNegociado": 4.700,
        "quantidadeLitrosLiberada": 0.000,
        "tanqueCheio": true
    }
}

Documentação WebApi 1.0 - TMPay Broker

Localizar Ordem de Abastecimento

GET /api/broker/ordemAbastecimento/localizar/{localizador}

Headers

Request Query String application/json

Response Body application/json