Versions Compared

Version Old Version 5 New Version Current
Changes made by

Ivan Saavedra (Unlicensed)

Larissa Oliveira (Unlicensed)

Saved on

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 Pagamento, disponibilizado pelo Motorista.

Sim

 

Response Body    application/json

...

Campo

Tipo

Descrição

Obrigatório

Validada

Boolean

Indica se a Ordem de Pagamento já se encontra Validada.

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 TransportadorParceiro, para serem Capturados e Validados durante o processo de Pagamento.

Sim

Detalhes

Object <Detalhes>

Detalhes da Ordem de Pagamento.

Sim

...

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 Solicitante responsável pela Ordem de Pagamento.

Sim

DescricaoProduto

String

Descrição do Produto liberado para essa Ordem de Pagamento, quando houver.

Sim

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 liberada para compra. (Disponibilizado apenas para Ordens de Pagamento que não sejam Tanque Cheio)

Não

 

JSON: 

Code Block
{
    "validadaValidada": false,
    "camposIdentificadorProduto": "DSLCM",
    "Campos": [
          {
          "chaveChave": "23",
          "descricaoDescricao": "Hodômetro",
          "tipoTipo": "integer",
          "identificadorTipoIdentificadorTipo": 2,
          "obrigatorioObrigatorio": true
          },
          {
          "chaveChave": "24",
          "descricaoDescricao": "Placa",
          "tipoTipo": "string",
          "identificadorTipoIdentificadorTipo": 1,
          "obrigatorioObrigatorio": true,
          "maxLengthMaxLength": 9
          }
    ],
    "detalhesDetalhes": {
          "solicitanteSolicitante": "IS Transportes",
          "descricaoProdutoDescricaoProduto": "Diesel",
          "quantidadeIndefinidaQuantidadeIndefinida": true,
          "quantidadeLiberadaQuantidadeLiberada": 0.000,
    }
}