get_sales_summary
Resumo de vendas do período · domínio Vendas · escopo mcp:sales
O que faz
Resumo do faturamento em um período: valor faturado, faturamento líquido de devoluções (net_revenue), devoluções, custo, margem (R$ e %), nº de NFs, clientes e ticket médio. Use para 'quanto vendemos no mês?', 'faturamento líquido' ou 'vendas de hoje' (para hoje, informe a data de hoje em from e to).
Exemplo de pergunta
“quanto vendemos no mês?” — o assistente escolhe esta ferramenta sozinho; você não digita o nome dela.
Parâmetros
| Parâmetro | Tipo | Obrigatório | Padrão | Significado |
|---|---|---|---|---|
from | data (YYYY-MM-DD) | sim | — | Início do período (YYYY-MM-DD) |
to | data (YYYY-MM-DD) | sim | — | Fim do período (inclusivo) |
O que você recebe
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— Clientesproducts— Produtos distintosqty— Quantidadeticket_medio— Ticket médio (R$)
Cuidados ao ler o resultado
Leia antes de interpretar
- Antes do faturamento do dia processar, 'hoje' pode vir zerado (R$0) — é o estado real, não um erro.
- sale_value exclui bonificação; billed_value a inclui (a preço de tabela). margin_pct é fração (0–1).
- net_revenue = vendas − devoluções de cliente (return_value), datadas pela devolução, SEM abater impostos — não é a base fiscal das rotinas 8074/8062 (líq-ST/líq-ST-IPI).
Por trás da ferramenta
Esta ferramenta consulta o endpoint /v1/agg/sales/summary da API REST — as mesmas permissões e o mesmo recorte da sua credencial valem nos dois caminhos.
Esta página ajudou? Conte para a gente — lemos tudo.