enduser:erp:developer:integracao:integracaowebservice:pedidovenda:aprovarorcamento

PUT - Aprovação do Orçamento

Este método realiza a aprovação do orçamento, a partir do número do pedido informado no corpo da requisição.

api/PedidoVenda/aprovar-orcamento

Exemplo URL

<IP do Serviço>:<Porta liberada para o serviço>/api/PedidoVenda/aprovar-orcamento

Parâmetros do Header

authToken adquirido no Login.

Exemplo de Body

{
  "NumeroPedido": 123456,
  "CodigoEstabelecimento":1,
  "AprovadoExternamente": true,
  "Observacoes": "Teste aprovação orçamento",
  "PedidoCliente": "PC-998",
  "CondicoesFaturamento": [
    { "Percentual": 30, "DataVencimento": "2026-10-09", "FormaPagamento": 3, "Antecipado": true },
    { "Percentual": 70, "DataVencimento": "2026-11-10", "FormaPagamento": 1, "Antecipado": false }
  ]
}

Explicação dos campos do Body

Campos com (*) são obrigatórios:

  • NumeroPedido (*) → Long → Número do orçamento que será aprovado.
  • CodigoEstabelecimento → Integer → Estabelecimento ao qual pertence o orçamento. Quando não informado, é usado o estabelecimento da conexão do serviço.
  • AprovadoExternamente → Booleano → Indica se o orçamento já foi aprovado no sistema externo. Com true, a aprovação dispensa as validações do ERP; com false ou omitido, o orçamento é aprovado passando por todas as validações.
  • Observacoes → String → Texto gravado no histórico do orçamento junto com o registro da aprovação.
  • PedidoCliente → String → Expressão que representa o pedido do cliente.
  • CodicaoFaturamento:
    • Percentural → Decimal → Percentual do valor da parcela.
    • DataVencimento → Date → Data de vencimento da parcela.
    • FormaPagamento → Inteiro → Código da forma de pagamento.
    • Antecipado → Booleano → Se a parcela será antecipada.
AprovadoExternamente = false não reprova o orçamento. O método sempre tenta aprovar; o campo decide apenas se as validações do ERP são aplicadas.

Como funciona a aprovação

Antes de qualquer outra verificação, o método confere que o número informado existe, que ainda é um orçamento (não foi aprovado, cancelado nem liquidado), que não é de origem da Orçamentação de Obras e, quando informado, que o estabelecimento existe. Se alguma dessas conferências falhar, nada é gravado e o retorno traz o motivo.

Depois disso, a aprovação segue um de dois caminhos:

Situação Validações do ERP
AprovadoExternamente = true e parâmetro UTILIZA-APROV-EXTERNA ativo Dispensadas: o ERP considera que a aprovação já foi analisada no sistema externo e aprova o orçamento direto.
AprovadoExternamente = false, campo omitido, ou parâmetro UTILIZA-APROV-EXTERNA inativo Aplicadas: o orçamento só é aprovado se passar em todas as validações, as mesmas da aprovação feita dentro do ERP.

Com as validações aplicadas, o orçamento é recusado quando, por exemplo:

  • está em uma etapa que não permite a rotina de aprovação;
  • não possui condição de pagamento nem condição de faturamento, ou as parcelas da condição de faturamento não somam 100% ou têm vencimento anterior ao cadastro;
  • possui item com material cancelado ou, quando a empresa exige, item sem data de entrega;
  • é de pagamento antecipado e ainda não foi totalmente pago;
  • não atende a alguma validação específica configurada para a empresa ou integração.

Quando recusado, o retorno vem com bemSucedido igual a false e as mensagens de cada validação no campo dados.

Exemplos de Retorno

Sucesso

{
    "bemSucedido": true,
    "mensagemFalha": null,
    "novoCodigo": null,
    "dados": null
}
enduser/erp/developer/integracao/integracaowebservice/pedidovenda/aprovarorcamento.txt · Última modificação: por 127.0.0.1

Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki