openthorDocumentação
Abrir o painel

GET /v1/agg/sales/summary

Resumo de vendas do período em uma linha — faturado, líquido de devoluções, notas, clientes e ticket médio. · domínio Vendas

Exemplo

cURL
curl -H "Authorization: Bearer ot_live_SEU_TOKEN_AQUI" \
  "https://api.openthor.dev/v1/agg/sales/summary?from=2026-06-01&to=2026-06-30&limit=5"

A autenticação e o formato do envelope { data, meta } são comuns a todos os endpoints — veja Autenticação e Resposta e metadados.

Filtros e período

Campos filtráveis com a sintaxe campo=op:valor:

  • supplier_code — numérico (eq · in · gte · lte · gt · lt)
  • customer_code — numérico (eq · in · gte · lte · gt · lt)
  • rep_code — numérico (eq · in · gte · lte · gt · lt)
  • product_code — numérico (eq · in · gte · lte · gt · lt)

Janela de datas: from/to (inclusivos, formato YYYY-MM-DD) sobre moved_at.

Métricas

Selecione com metrics=m1,m2 (padrão: todas):

  • billed_value — Faturado (R$, inclui bonificação)
  • sale_value — Venda (R$, sem bonificação)
  • bonus_value — Bonificação (R$)
  • return_value — Devoluções (R$)
  • net_revenue — Faturamento líquido (R$)
  • margin_value — Margem (R$)
  • margin_pct — Margem (%)
  • nfs — Notas (qtde)
  • customers — Clientes
  • products — Produtos distintos
  • qty — Quantidade
  • ticket_medio — Ticket médio (R$)

Ordenação e paginação

Ordene com sort=coluna (crescente) ou sort=-coluna (decrescente). Colunas ordenáveis: billed_value · sale_value · bonus_value · return_value · net_revenue · margin_value · margin_pct · nfs · customers · products · qty · ticket_medio. Limite padrão 1, máximo 1 linhas por chamada; pagine com offset enquanto meta.has_more for true.

O que sua chave enxerga

O recorte da credencial (filial, vendedor, cliente, fornecedor, janela de datas) é aplicado no servidor e não pode ser ampliado por filtros — dois usuários podem ver totais diferentes no mesmo endpoint, por desenho.

Ferramentas MCP sobre este endpoint