Skip to content
API/
Orçamentos
/
/
Retornar orçamentos por f...

Retornar orçamentos por filtros

Request

Recupera a lista de orçamentos com base nos filtros informados.

Security
BearerAuth
Query
paginainteger

Número da página

Default:1
tamanho_paginainteger

Tamanho da página

Default:10
campo_ordenado_ascendentestring

Campo para ordenação ascendente. Se informado ele desconsidera o valor do campo_ordenado_descendente. É possível ordenar pela data da venda (DATA), pelo número da venda (NUMERO) ou pelo nome do cliente (CLIENTE)

Enum:"DATA""NUMERO""CLIENTE"
Example:campo_ordenado_ascendente=DATA
campo_ordenado_descendentestring

Campo para ordenação descendente. Se este campo for utilizado, o campo campo_ordenado_ascendente não deverá ser informado. É possível ordenar pela data da venda (DATA), pelo número da venda (NUMERO) ou pelo nome do cliente (CLIENTE)

Enum:"DATA""NUMERO""CLIENTE"
Example:campo_ordenado_descendente=DATA
termo_buscastring

Termo de busca

data_iniciostring

Data inicial (formato: YYYY-MM-DD)

data_fimstring

Data final (formato: YYYY-MM-DD)

data_criacao_destring

Data de criação inicial (formato: YYYY-MM-DD)

data_criacao_atestring

Data de criação final (formato: YYYY-MM-DD)

data_alteracao_destring

Data de alteração inicial (formato: YYYY-MM-DDThh:mm:ss)

data_alteracao_atestring

Data de alteração final (formato: YYYY-MM-DDThh:mm:ss)

ids_vendedoresArray of strings

IDs dos vendedores (UUID)

ids_clientesArray of strings

IDs dos clientes (UUID)

ids_natureza_operacaoArray of strings

IDs das naturezas de operação (UUID)

ids_categoriasArray of strings

IDs das categorias (UUID)

ids_produtosArray of strings

IDs dos produtos (UUID)

situacoesArray of strings

Situações dos orçamentos

Items Enum:"ORCAMENTO""ORCAMENTO_ACEITO""ORCAMENTO_RECUSADO"
origensArray of strings

Origens dos orçamentos

numerosArray of integers

Números dos orçamentos

ids_legado_donosArray of integers

IDs legados dos donos

ids_legado_clientesArray of integers

IDs legados dos clientes

ids_legado_produtosArray of integers

IDs legados dos produtos

curl -i -X GET \
  'https://api-v2.contaazul.com/v1/orcamentos?pagina=1&tamanho_pagina=10&campo_ordenado_ascendente=DATA&campo_ordenado_descendente=DATA&termo_busca=string&data_inicio=string&data_fim=string&data_criacao_de=string&data_criacao_ate=string&data_alteracao_de=string&data_alteracao_ate=string&ids_vendedores=string&ids_clientes=string&ids_natureza_operacao=string&ids_categorias=string&ids_produtos=string&situacoes=ORCAMENTO&origens=string&numeros=0&ids_legado_donos=0&ids_legado_clientes=0&ids_legado_produtos=0' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
itensArray of objects(ItemOrcamentoPorFiltro)

Lista de orçamentos

total_itensinteger

Total de itens

Example:10
Response
{
  "itens": [
    { … }
  ],
  "total_itens": 10
}