Skip to main content
POST
Inserir Pedido de Compra
Diferente dos demais endpoints de escrita da API, este sempre responde 200, mesmo quando a operação falha por regra de negócio. Verifique data.notifications: vazio indica sucesso (com o pedido em data.payload); não vazio indica falha.
O data.payload de retorno usa um formato diferente do retornado nas rotas de consulta (GET) — não assuma a mesma estrutura.

Authorizations

Authorization
string
header
required

Envie o token retornado por /v2/autenticar no header Authorization, no formato Bearer {token}.

Body

application/json

Pedido de compra. Usado tanto nas rotas de consulta (GET) quanto no corpo de POST/PUT. As regras de negócio (ex.: filial válida, data do pedido válida, tipo de compra) são verificadas no processamento e, em caso de falha, retornam como notifications no corpo da resposta, sempre com HTTP 200 — nunca como HTTP 400.

codigoDoExercicio
integer<int32>
numeroDaMovimentacao
number
numeroDoPedido
number

Gerado automaticamente na inclusão.

idPedidoWS
string | null
seq
integer<int32>
dataDoPedido
string<date-time>
descricaoDoPedido
string | null
numeroDaOrdem
number | null
cliente
object

Dados de pessoa jurídica (cliente/fornecedor) usados nos documentos de compras.

enderecoCliente
object

Endereço utilizado pelo cadastro de Fornecedor.

fornecedor
object

Dados de pessoa jurídica (cliente/fornecedor) usados nos documentos de compras.

enderecoFornecedor
object

Endereço utilizado pelo cadastro de Fornecedor.

codigoDoBancoFornecedor
integer<int32> | null
codigoDaAgenciaFornecedor
string | null
tipoContaBancariaFornecedor
string | null
numeroDaContaCorrenteFornecedor
string | null
codigoDoTipoDeCompra
integer<int32>
codigoDoMotivo
integer<int32> | null
codigoDaRegraDeAprovacao
integer<int32>
codigoDaFormaDePagamento
integer<int32> | null
descricaoDaFormaDePagamento
string | null
codigoDaCondicaoDePagamento
integer<int32> | null
descricaoDaCondicaoDePagamento
string | null
observacaoPagamento
string | null
freteNaPrimeiraParcelaPagamento
boolean
gerarContasAPagarProcessamentoPC
boolean
codigoDaFilial
integer<int32> | null

Validado no domínio (deve corresponder a uma filial válida da empresa).

codigoDoAlmoxarifado
integer<int32> | null
codigoDoProjeto
integer<int32> | null
codigoDoCentroDeCusto
string | null
codigoDaClassificacaoAuxiliar
integer<int32> | null
codigoDoItemDeLancamento
string | null
codigoDaContaCorrente
integer<int32> | null
codigoDoColaborador
integer<int32> | null
descricaoDoColaborador
string | null
codigoDoColaboradorDestino
integer<int32> | null
descricaoDoColaboradorDestino
string | null
codigoDoColaboradorResponsavelCompras
integer<int32> | null
descricaoDoColaboradorResponsavelCompras
string | null
observacao
string | null
codigoDoPrazoDeEntrega
integer<int32> | null
numeroPrazoDeEntrega
integer<int32> | null
descricaoDoPrazoDeEntrega
string | null
dataDoPrazoDeEntrega
string<date-time> | null
enderecoEntrega
object

Endereço utilizado pelo cadastro de Fornecedor.

contatoEntrega
string | null
observacaoEntrega
string | null
valorProdutos
number
valorDescontos
number
valorAcrescimos
number
valorImpostos
number
valorFrete
number
valorTotal
number
freteEmitenteDestinatario
string | null
numeroDaNotaFiscal
number | null
numeroDeSerieDaNotaFiscal
string | null
dataDeEntradaNotaFiscal
string<date-time> | null
chaveDaNotaFiscal
string | null
itens
object[]
parcelas
object[]

Response

Requisição processada. Sempre HTTP 200, inclusive em caso de falha de negócio. Verifique data.notifications: vazio indica sucesso (nesse caso data.payload traz o pedido criado); não vazio indica falha (a mensagem de erro está em data.notifications, e data.payload pode vir nulo ou parcialmente preenchido).

success
boolean

Sempre true nesta rota — reflete apenas que a requisição HTTP foi processada, não o resultado de negócio.

Example:

true

data
object

Corpo retornado em data pelas rotas POST/PUT de pedido de compra. Contém success (verdadeiro quando não há notificações), notifications (lista de mensagens de erro, vazia em caso de sucesso) e payload (o pedido processado).