Skip to content

POST orcamentos

Marcos Vinicius Kapp edited this page Sep 21, 2015 · 27 revisions

URL

POST https://www.vpsa.com.br/apps/api/orcamentos

Parâmetros

Envie um JSON no corpo da requisição, contendo:

  • validade: dias de validade para o vencimento do orçamento (long obrigatório)
  • idEntidade: id da entidade utilizada (long obrigatório)
  • idTerceiro: id do terceiro utilizado (long obrigatório)
  • idRepresentante: id do representante utilizado (long obrigatório)
  • itens: lista de itens do orçamento, contendo:
    • produto: (obrigatório se existir itens)
      • id: id do produto
      • codigoSistema: código de sistema do produto.
    • quantidade: quantidade do item (decimal obrigatório se existir itens)
    • valorUnitario: valor unitário do item do orçamento (decimal obrigatório se existir itens)
  • servicos: lista de serviços do orçamento, contendo:
    • idServico: id do serviço (long obrigatório se existir serviços)
    • quantidade: quantidade do serviço (decimal obrigatório se existir serviços)
    • valorUnitario: valor unitário do serviço do orçamento (decimal obrigatório se existir serviços)
  • valorFrete: valor de frete do orçamento (decimal opcional)
  • valorSeguro: valor de seguro do orçamento (decimal opcional)
  • valorOutros: valor de outros do orçamento (decimal opcional)
  • numeroPedidoCliente: Número do pedido que originou o orçamento (string opcional)
  • idPlanoPagamento: id do plano de pagamento utilizado (long obrigatório). Utilizar a API https://github.com/VPSA/api/wiki/GET%20planos-pagamento para obter o id do Plano de Pagamentos.
  • observacao: observações do orçamento (string opcional)
  • vendaConsumidorFinal: indica se o orçamento é para consumidor final (boolean obrigatório)

Retorno

Sucesso:

  • HTTP STATUS 201 – CREATED
  • Body: id do orçamento gerado

Requisição inválida:

  • HTTP STATUS 400 – BAD REQUEST
  • Body: mensagem de erro

Exemplo

POST https://www.vpsa.com.br/apps/api/orcamentos

'Content-Type'='application/json'

{
   "validade":15,
   "idEntidade":1,
   "idTerceiro":2,
   "idRepresentante":3,
   "itens":[
      {
         "produto": {
             "id" : 245,
             "codigoSistema" : "0001.0001" 
         },
         "quantidade":8, 
         "valorUnitario":10
      }
   ],
   "servicos":[
      {
         "idServico":9,
         "quantidade":1, 
         "valorUnitario":20
      }
   ],
   "valorFrete":2,
   "valorSeguro":6,
   "valorOutros":4,
   "numeroPedidoCliente" : "111-12",
   "idPlanoPagamento":1,
   "observacao":"Ref. 007",
   "vendaConsumidorFinal":true
}

Introdução

Endpoints de Integração

Administrativo

Comercial

Compras

Financeiro

Controle de crédito

Fiscal

Contábil

Operacional

Dicas Gerais

Filtros Padrões

Tabelas Padrões

Atualizações

Clone this wiki locally