DOCUMENTAÇÃO CORPORATIVA

Cadastrar Ordem de Pagamento

POST      /api/ordemAbastecimento/ordemPagamento

 

Headers    

Content-Type

application/json

Authorization

Api-Key

 

Request Body    application/json

Schema:

Campo

Tipo

Descrição

Obrigatório

CNPJ

String

CNPJ do Estabelecimento

Não

Valor

Decimal

Valor total da Ordem de Pagamento.

Não

DocumentoCliente

String

Documento do Solicitante da Ordem de Pagamento.

Não

DescricaoCliente

String

Nome Fantasia do Solicitante da Ordem de Pagamento.

Não

IdProduto

Integer

ID Que identifica o produto referente a Ordem de Pagamento.

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.

Não

QuantidadeLiberada

Decimal

Quantidade liberada para compra. (Disponibilizado apenas para Ordens de Pagamento que não sejam Tanque Cheio)

Não

DataEstimadaTransacao

DateTime

Data estimada para a venda.

Não

 

JSON:

{ "CNPJ": "14821124000142",(Quando houver) "Valor": 55.000, "DocumentoCliente": "11111111111111" "DescricaoCliente": "Target Meio de Pagamentos", "IdProduto": 1, "QuantidadeIndefinida": false, "QuantidadeLiberada": 11.000 }

 

Response Body    application/json

 

Campo

Tipo

Descrição

Obrigatório

Localizador

String

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

Sim

IdOrdemPagamento

Long

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

Sim

 

JSON:

{ "Localizador": "1", "IdOrdemPagamento": 1 }