openthorDocumentação

get_sales_by_supplier

Vendas por fornecedor (indústria) · domínio Vendas · escopo mcp:sales

O que faz

Faturamento e margem por fornecedor em um período: valor, faturamento líquido de devoluções (net_revenue), devoluções, margem (R$ e %), NFs, clientes e SKUs. Use para 'qual fornecedor mais vendeu?', 'líquido por fornecedor' ou 'margem por indústria'.

Exemplo de pergunta

qual fornecedor mais vendeu?” — o assistente escolhe esta ferramenta sozinho; você não digita o nome dela.

Parâmetros

ParâmetroTipoObrigatórioPadrãoSignificado
fromdata (YYYY-MM-DD)sim
todata (YYYY-MM-DD)sim
topinteger (1–200)não20
order_bystring (billed_value · sale_value · margin_value · margin_pct · net_revenue · return_value)nãobilled_value

O que você recebe

  • supplier_code — Fornecedor (cód.)
  • billed_value — Faturado (R$, inclui bonificação)
  • sale_value — Venda (R$, sem bonificação)
  • margin_value — Margem (R$)
  • margin_pct — Margem (%)
  • nfs — Notas (qtde)
  • customers — Clientes
  • products — Produtos distintos
  • net_revenue — Faturamento líquido (R$)
  • return_value — Devoluções (R$)

Cuidados ao ler o resultado

Leia antes de interpretar
  • O fornecedor da linha de venda é a indústria (CODFORNEC em PCMOV); a DEVOLUÇÃO é atribuída pela indústria do PRODUTO (cadastro) — em doc de entrada o CODFORNEC é o emissor, não a indústria.
  • net_revenue = vendas − devoluções do fornecedor (datadas pela devolução), SEM abater impostos.
  • customers = clientes COMPRADORES do fornecedor no período (grão movimento) — não é a positivação de carteira.
  • Apenas filial ativa.

Por trás da ferramenta

Esta ferramenta consulta o endpoint /v1/agg/sales/by-supplier da API REST — as mesmas permissões e o mesmo recorte da sua credencial valem nos dois caminhos.