openthorDocumentação

get_catalog_margin_quality

Qualidade da margem de cadastro (8133) · domínio Vendas · escopo mcp:sales

O que faz

Margem de CADASTRO por produto para uma região e UF de destino, como a rotina 8133 do Winthor: (PTABELA − ICMS de tabela − custo próxima compra) ÷ PTABELA. Margem negativa ou abaixo do esperado = DEFEITO de cadastro de preço (corrigir antes de vender). Use para 'que produtos estão cadastrados com margem negativa?' ou 'a margem de cadastro do fornecedor X está saudável?'. Estado atual do catálogo — não tem período.

Exemplo de pergunta

que produtos estão cadastrados com margem negativa?” — o assistente escolhe esta ferramenta sozinho; você não digita o nome dela.

Parâmetros

ParâmetroTipoObrigatórioPadrãoSignificado
regionintegersimRegião de preço (PCTABPR.NUMREGIAO) — obrigatório
ufstringsimUF de destino da NF (rota tributária) — obrigatório, ex.: 'AL'
supplier_codeintegernãoFiltrar por fornecedor (opcional)
product_codeintegernãoFiltrar por produto (opcional)
max_margin_pctnumbernãoSó produtos com margem calculada ≤ este % (ex.: 0 = só negativas)
topinteger (1–1000)não100

O que você recebe

  • product_code — Produto (cód.)
  • description — Descrição
  • supplier_code — Fornecedor (cód.)
  • region — Região de preço
  • uf — UF
  • list_price — Preço de tabela (R$)
  • custo_240 — Custo próxima compra (R$)
  • registered_margin_pct — Margem digitada no cadastro (%)
  • margin_pct — Margem (%)
  • sem_tributacao — Sem figura tributária (UF)

Cuidados ao ler o resultado

Leia antes de interpretar
  • Base 8133 (margem de CADASTRO): preço de tabela e custo de próxima compra ATUAIS — não é margem realizada de venda, nem líquida de devoluções.
  • Margem negativa = defeito de cadastro (preço abaixo do custo + imposto) — a razão de ser da 8133.
  • sem_tributacao = true: produto vendável SEM figura tributária cadastrada para a UF — a margem exibida assume ICMS 0 (superestimada de propósito; corrija a rota na 8133/212).
  • Filial 01. registered_margin_pct é a margem DIGITADA no cadastro; margin_pct é a calculada — divergência entre as duas também é achado.

Por trás da ferramenta

Esta ferramenta consulta o endpoint /v1/margin/catalog da API REST — as mesmas permissões e o mesmo recorte da sua credencial valem nos dois caminhos.