Tabela de conteúdos
GET - Consulta Orçamento de Venda
Este método consulta orçamentos de venda cadastrados no Prosyst a partir dos parâmetros informados na URL. Pedidos de venda não são retornados: eles têm consulta própria em GET - Consulta Pedido de Venda.
O orçamento aprovado que vira pedido com o mesmo número deixa de sair aqui e passa a sair na consulta de pedidos. Já o orçamento aprovado que gera um pedido novo continua nesta consulta, e o pedido gerado sai na consulta de pedidos.
Exemplo 1 (Busca por orçamentos específicos)
api/OrcamentoVenda/Consulta?NrOrcamento=1,2,3
Exemplo 2 (Orçamentos cadastrados em um intervalo de datas)
api/OrcamentoVenda/Consulta?DataCadastroInicial=2026-10-01T00:00:00&DataCadastroFinal=2026-10-15T23:59:59
Exemplo 3 (Orçamentos não cancelados e ainda sem aprovação, cadastrados a partir de uma data)
api/OrcamentoVenda/Consulta?SituacaoOrcamento=O&OrcamentosSemAprovacao=true&DataCadastroInicial=2026-10-01T00:00:00
Parâmetros URL
Especifique os parâmetros abaixo para determinar quais orçamentos serão retornados:
- NrOrcamento=(nr. orçamento)[,nr. orçamento2, nr. orçamentoN] - Especifica um ou mais números de orçamentos. Informe vários números separados por vírgula (,). Com este parâmetro, as datas deixam de ser obrigatórias, e os demais filtros informados continuam valendo.
- DataCadastroInicial / DataCadastroFinal - Informar data de início/fim no formato “YYYY-MM-DDTHH:MI:SS”. Especifica o intervalo de data de cadastro dos orçamentos. Pode-se também especificar somente uma das datas (Início ou Fim). Se somente uma das datas for especificada, assume-se o intervalo de 30 dias para a data do outro extremo (pode ser diferente caso o cliente o tenha configurado assim).
- DataUltimaAlteracaoInicial / DataUltimaAlteracaoFinal - Informar data de início/fim no formato “YYYY-MM-DDTHH:MI:SS”. Especifica o intervalo de data de última modificação dos orçamentos. Pode-se também especificar somente uma das datas (Início ou Fim), com a mesma regra dos 30 dias.
- SituacaoOrcamento - (Opcional) Informar um destes valores:
- SituacaoOrcamento=O - Somente orçamentos não cancelados.
- SituacaoOrcamento=C - Somente orçamentos cancelados.
- (vazio) - Caso não informado, trará os dois.
- OrcamentosSemAprovacao - (Opcional) Com true, traz somente os orçamentos ainda não aprovados. Sem o parâmetro, ou com false, traz aprovados e não aprovados.
- DataAprovacaoInicial / DataAprovacaoFinal - (Opcional) Intervalo da data de aprovação dos orçamentos, no formato “YYYY-MM-DD”. Não vale junto com OrcamentosSemAprovacao=true.
- NrTipoOperacao - (Opcional) Um ou mais códigos de tipo de operação, separados por vírgula (,).
- CodigoEstabelecimento - (Opcional) Informar o código do estabelecimento no qual se deseja realizar a consulta.
- Etapa - (Opcional) Informar a etapa de venda dos orçamentos que se deseja buscar.
Observações: o sistema sempre obrigará informar o NrOrcamento ou ao menos uma das datas de cadastro ou de última alteração (DataCadastroInicial, DataCadastroFinal, DataUltimaAlteracaoInicial, DataUltimaAlteracaoFinal).
Retorno Simplificado:
Para o retorno simplificado deve ser adicionado no arquivo appsettings.json a propriedade “API_PEDIDOVENDA_RETORNO_SIMPLIFICADO” como true. A mesma propriedade vale para a consulta de pedidos.
Parâmetros do Header
| auth | Token adquirido no Login. |
Exemplos de Retorno
Sucesso
O retorno tem a mesma estrutura da consulta de pedidos, completo ou simplificado. O número do orçamento vem em numeroPedido, e a situação, em situacaoPedido (“Orçamento” ou “Cancelado”) e, no retorno completo, em codigoSituacao (“O” ou “C”).
Sem resultados no retorno
{
"bemSucedido": false,
"mensagemFalha": null,
"novoCodigo": null,
"dados": "Nenhum orçamento encontrado!"
}
Falha de validação
Sem o NrOrcamento e sem nenhuma das datas, ou com um período maior que o permitido, a requisição é recusada (HTTP 400) com a mensagem abaixo, e o motivo vem em dados:
{
"bemSucedido": false,
"mensagemFalha": "Algumas validações para consulta do orçamento de venda não foram bem-sucedidas. Consulte os detalhes para mais informações.",
"novoCodigo": null,
"dados": [ ... ]
}
Com uma Etapa que não existe, a requisição é recusada com a mensagem “Código da etapa inexistente”.