openthorDocumentação

get_gross_margin_by_branch

Margem bruta por filial · domínio Vendas · escopo mcp:sales

O que faz

Faturamento e margem bruta por filial em um período: valor, margem (R$ e %), NFs e clientes. Use para 'margem por filial' ou 'qual loja teve melhor margem?'.

Exemplo de pergunta

margem por filial” — 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
order_bystring (margin_value · billed_value · margin_pct)nãomargin_value
topinteger (1–200)não50

O que você recebe

  • branch_code — Filial
  • billed_value — Faturado (R$, inclui bonificação)
  • margin_value — Margem (R$)
  • margin_pct — Margem (%)
  • nfs — Notas (qtde)
  • customers — Clientes

Cuidados ao ler o resultado

Leia antes de interpretar
  • Margem bruta = receita − custo (CUSTOREAL); margem 'realizada' (8128) é outro produto.

Por trás da ferramenta

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