openthorDocumentação

Glossário

Os termos do dia a dia da distribuição, como o OpenThor os usa — e, abaixo, o dicionário de colunas completo.

Termos de negócio

TermoDefinição
Faturado (billed) vs venda (sale)billed_value é tudo que saiu com nota, incluindo bonificação a preço de tabela; sale_value é só o que foi de fato vendido. Nunca some os dois.
Faturamento líquido (net_revenue)Vendas menos devoluções do período (contadas na data da devolução), sem abater impostos. Não é a base fiscal das rotinas 8074/8062 nem a venda líquida da 8128 — três “líquidos” diferentes.
BonificaçãoMercadoria entregue sem cobrança — tem custo real e receita zero. Infla o “faturado” se ninguém separar.
Margem brutaReceita menos custo real, antes de impostos, devoluções e verba. Nas vendas agregadas, margin_pct vem como fração 0–1 (0,23 = 23%).
Margem de cadastro (rotina 8133)A margem planejada do preço de tabela de hoje — estado do catálogo, não uma venda. Negativa = etiqueta errada para corrigir antes de vender.
Margem realizada líquida (rotina 8128)A margem oficial de uma venda que aconteceu: venda líquida (menos devoluções e ST/FECP) menos custo líquido — com e sem verba no nível do fornecedor. Percentuais em 0–100.
VerbaRebate que o fornecedor paga por acordo comercial. Existe no nível do fornecedor (não rateia por produto) — pode deixar lucrativo um agregado cujo SKU isolado está no vermelho.
Caça-prejuízoApelido do relatório de produtos com margem realizada líquida negativa — find_negative_realized_margin.
Ticket médioFaturamento dividido pelo número de notas distintas.
PositivaçãoDos clientes da base ativa (compraram nos últimos 12 meses), quantos compraram no mês corrente. Não confundir com “clientes” dos rankings de venda (compradores distintos no período pedido) — dois modelos que não se misturam.
Base ativaClientes que compraram nos últimos 12 meses — vem do movimento, não do cadastro.
CarteiraOs clientes de um vendedor, pela união oficial da rotina 8066 (não só um campo do cadastro).
RCA / SupervisorRCA = vendedor (representante comercial). Supervisor = gestor de uma equipe de RCAs. Nos rankings, a atribuição usa o organograma atual; na 8128, quem era o supervisor no dia da venda.
RFMRecência (última compra), Frequência (ritmo) e Valor (faturamento 12m) — a régua clássica de carteira.
Churn / valor em riscoClientes que pararam de comprar (12 meses) e o faturamento anual que representavam.
Cadência de compraIntervalo médio entre compras de um cliente — acha quem “desacelerou” antes de virar inativo.
Mix / penetraçãoDe quantos produtos do portfólio de um fornecedor cada cliente compra.
White spaceA “batalha naval” produto × cliente: clientes fortes que ainda não compram produtos fortes — as vendas mais fáceis da semana.
RupturaProduto zerado que ainda vendia nos últimos 90 dias — falta que custa venda.
Estoque morto (capital parado)Produto com valor em estoque e sem giro há N dias (padrão 90).
Título / vencido / inadimplenteTítulo = duplicata em aberto. Vencido = passou do vencimento. Inadimplente é mais estrito: exclui PIX/cartão (atraso de liquidação bancária não é calote).
Meta e atingimentoO Winthor grava a mesma meta em até 5 níveis (empresa, supervisor, RCA, RCA×fornecedor) — eles se conferem entre si, mas nunca se somam. pct_attained usa o realizado bruto (convenção 8055); pct_attained_net desconta devoluções.
Frescor (data_as_of)Quando o coletor sincronizou os dados pela última vez — toda resposta declara. Conferências contra rotinas do Winthor: sempre no mesmo dia.

Dicionário de colunas

Todas as colunas e métricas que a API e as ferramentas devolvem (166 entradas — gerado do código; uma coluna sem tradução aparece pelo nome técnico, nunca com um rótulo inventado):

ColunaSignificado
activeAtivos
active_baseBase ativa (12m)
active_countClientes ativos
active_customersClientes ativos no período
activity_codeRamo
age_daysIdade (dias)
aging_avgIdade média (dias)
amountValor (R$)
avg_interval_daysIntervalo médio (dias)
avg_margin_pctMargem média (%)
avg_registered_margin_pctMargem digitada média (%)
barcodeCódigo de barras
billed_atEmitida em
billed_valueFaturado (R$, inclui bonificação)
blockedBloqueado
bonus_ordersPedidos de bonificação
bonus_valueBonificação (R$)
branch_codeFilial
cancelled_atCancelado em
category_codeCategoria
channelCanal
churn_pctChurn (%)
collection_codeCobrança
cost_amountCusto (R$)
credit_limitLimite de crédito (R$)
custo_240Custo próxima compra (R$)
custo_liqCusto líquido (R$)
customer_codeCliente (cód.)
customer_valueValor do cliente (R$)
customersClientes
customers_realizedPositivação realizada
customers_targetMeta de positivação
dataData
days_inactiveDias sem comprar
days_overdueDias em atraso
days_since_saleDias sem vender
delinquent_amountInadimplente (R$)
descricaoDescrição
descriptionDescrição
due_atVencimento
fantasiaNome fantasia
faturamentoFaturamento (R$)
first_purchase_atPrimeira compra
fornecedorFornecedor
gap_valueFalta para a meta (R$)
goal_levelNível da meta
icms_pctICMS de tabela (%)
inactive_countClientes inativos
installmentParcela
invoice_idNº interno da NF
invoice_numberNº da nota
invoicesNotas (qtde)
invoices_12mNotas 12m
invoices_90dNotas 90d
is_active_12mBase ativa (12m)
is_blockedBloqueado
is_bonusBonificação
is_delinquentInadimplente
is_overdueVencido
is_positivado_mtdPositivado no mês
issued_atEmitido em
last_purchase_atÚltima compra
last_sold_atÚltima venda
line_costCusto da linha (R$)
line_marginMargem da linha (R$)
line_revenueReceita da linha (R$)
list_pricePreço de tabela (R$)
margem_cv_pctMargem com verba (%)
margem_liq_pctMargem líquida (%)
margem_sv_pctMargem sem verba (%)
margin_amountMargem (R$)
margin_pctMargem (%)
margin_valueMargem (R$)
min_margin_pctMargem mínima (%)
mix_segmentSegmento de mix
months_active_12mMeses ativos (12m)
moved_atMovimento
municipality_codeMunicípio (cód.)
municipality_nameMunicípio
nameNome
net_revenueFaturamento líquido (R$)
network_codeRede
nfe_keyChave NF-e
nfe_statusStatus NF-e
nfsNotas (qtde)
num_loadCarga
open_amountEm aberto (R$)
order_idNº do pedido
ordered_atData do pedido
ordersPedidos (qtde)
overdue_amountVencido (R$)
owner_codeDono da meta (cód.)
owner_typeTipo do dono da meta
ownershipTitularidade
parent_customer_codeCliente matriz
payment_plan_codePlano de pagamento
pct_attained% atingido (bruto)
pct_attained_net% atingido (líquido)
penetration_pctPenetração (%)
periodPeríodo
portfolio_sizeTamanho da carteira
positivacao_pctPositivação (%)
positivadosPositivados no mês
product_codeProduto (cód.)
product_nameProduto
productsProdutos distintos
pseudo_repRCA pseudo (0/1)
purchase_daysDias de compra
qtyQuantidade
qty_availableDisponível
qty_blockedBloqueado (qtde)
qty_on_handEm estoque
qty_reservedReservado
qty_sold_90dVendido em 90d (qtde)
realized_net_valueRealizado líquido (R$)
realized_valueRealizado bruto (R$)
regionRegião de preço
registeredCadastrados
registered_atCadastrado em
registered_margin_pctMargem digitada no cadastro (%)
registered_skusSKUs cadastrados
rep_codeVendedor (RCA)
repsVendedores (qtde)
return_valueDevoluções (R$)
returned_atDevolvida em
revenue_amountFaturamento (R$)
sale_pricePreço de venda (R$)
sale_typeTipo de venda
sale_valueVenda (R$, sem bonificação)
sem_tributacaoSem figura tributária (UF)
shipped_atExpedida em
skus_90dSKUs 90d
skus_boughtSKUs comprados
skus_negativeSKUs com margem negativa
skus_sem_tributacaoSKUs sem tributação
skus_totalSKUs (total)
sold_skusSKUs vendidos
stateUF
statusStatus
status_codeStatus (cód.)
status_reasonMotivo do status
stock_valueValor em estoque (R$)
supervisor_codeSupervisor
supervisor_nameNome do supervisor
supplier_codeFornecedor (cód.)
supplier_nameFornecedor
supplier_princFornecedor principal (cód.)
suppliers_90dFornecedores 90d
target_valueMeta (R$)
tax_idCNPJ/CPF
taxa_pctPositivação (%)
ticket_medioTicket médio (R$)
title_countTítulos (qtde)
total_customersTotal de clientes
total_valueValor total (R$)
trade_nameNome fantasia
transaction_idNº do título
ufUF
unit_costCusto unitário (R$)
units_per_boxUnid. por caixa
valueFaturamento (R$)
value_12mFaturamento 12m (R$)
value_90dFaturamento 90d (R$)
value_at_riskValor em risco (R$/ano)
venda_liqVenda líquida (R$)
verbaVerba (R$)