openthorDocumentação
Abrir o painel

GET /v1/agg/margin/realized/by-product

Margem realizada líquida (rotina 8128) agregada por produto. · domínio Vendas

Exemplo

cURL
curl -H "Authorization: Bearer ot_live_SEU_TOKEN_AQUI" \
  "https://api.openthor.dev/v1/agg/margin/realized/by-product?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_princ — numérico (eq · in · gte · lte · gt · lt)
  • supplier_code — numérico (eq · in · gte · lte · gt · lt)
  • supervisor_code — numérico (eq · in · gte · lte · gt · lt)
  • rep_code — numérico (eq · in · gte · lte · gt · lt)
  • customer_code — numérico (eq · in · gte · lte · gt · lt)
  • branch_code — numérico (eq · in · gte · lte · gt · lt)
  • branch_code — texto (somente eq · in)

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

Métricas

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

  • faturamento — Faturamento (R$)
  • venda_liq — Venda líquida (R$)
  • custo_liq — Custo líquido (R$)
  • margem_liq_pct — Margem líquida (%)

Ordenação e paginação

Ordene com sort=coluna (crescente) ou sort=-coluna (decrescente). Colunas ordenáveis: faturamento · venda_liq · custo_liq · margem_liq_pct. Limite padrão 50, máximo 200 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