API REST /v1
A API REST serve os mesmos dados das ferramentas MCP, para quem constrói planilhas, integrações ou scripts — hoje são 39 endpoints, todos somente-leitura (GET). Comece por Autenticação e Sintaxe de consulta.
Base: https://api.openthor.dev · autenticação por chave ot_live_… no cabeçalho Authorization: Bearer · respostas em JSON com o envelope { data, meta }.
Vendas · 17
GET /v1/invoicesNotas fiscais de saída, uma a uma, com valor, custo e margem.
GET /v1/invoice-itemsLinhas (itens) de cada nota, com receita, custo e margem por produto.
GET /v1/agg/sales/by-repVendas agregadas por vendedor (RCA).
GET /v1/agg/sales/by-supervisorVendas agregadas por supervisor (equipe).
GET /v1/repsCadastro de vendedores (RCAs), com supervisor e status.
GET /v1/agg/sales/summaryResumo de vendas do período em uma linha — faturado, líquido de devoluções, notas, clientes e ticket médio.
GET /v1/agg/sales/by-monthSérie temporal de vendas por mês, semana ou dia.
GET /v1/agg/sales/by-supplierVendas agregadas por fornecedor (indústria).
GET /v1/agg/sales/by-customerVendas agregadas por cliente.
GET /v1/agg/sales/by-productVendas agregadas por produto.
GET /v1/agg/sales/by-branchVendas agregadas por filial.
GET /v1/productsCadastro de produtos vendáveis.
GET /v1/margin/catalogMargem de cadastro (rotina 8133) por produto — estado atual do catálogo de preços.
GET /v1/agg/margin/catalog/by-supplierQualidade da margem de cadastro agregada por fornecedor.
GET /v1/agg/margin/realized/by-supplierMargem realizada líquida (rotina 8128) por fornecedor, com e sem verba.
GET /v1/agg/margin/realized/by-productMargem realizada líquida (rotina 8128) agregada por produto.
GET /v1/margin/realized/below-thresholdProdutos com margem realizada líquida abaixo de um limite — o caça-prejuízo.
Clientes · 11
GET /v1/agg/customers/active-base-trendSérie temporal da base ativa de clientes.
GET /v1/customersCadastro de clientes.
GET /v1/customers/portfolioCarteira oficial cliente × vendedor (união da rotina 8066).
GET /v1/customer-metricsMétricas por cliente — recência, frequência, valor (RFM) e cadência de compra.
GET /v1/agg/customers/portfolio-by-repTamanho da carteira por vendedor.
GET /v1/agg/customers/positivacao-by-repPositivação do mês corrente por vendedor.
GET /v1/agg/customers/positivacao-by-supervisorPositivação do mês corrente por supervisor.
GET /v1/agg/customers/positivacao-summaryPositivação do mês corrente da empresa (uma linha).
GET /v1/agg/customers/coverage-by-cityCobertura de clientes por município.
GET /v1/customer-profileFicha 360 do cliente — atividade dos últimos 90 dias.
GET /v1/agg/customers/churn-by-repCarteira em risco (churn) e valor em risco por vendedor.
Pedidos · 3
GET /v1/ordersPedidos de venda, um a um, com status, motivo e idade.
GET /v1/agg/orders/pipelineFunil de pedidos por status (faturado, bloqueado, pendente, cancelado).
GET /v1/agg/orders/by-repPedidos agregados por vendedor.
Trade · 3
GET /v1/agg/trade/mix-penetrationPenetração do mix de um fornecedor, cliente a cliente.
GET /v1/agg/trade/penetration-scorecardScorecard de penetração de portfólio por fornecedor.
GET /v1/agg/trade/white-spaceLacunas produto × cliente de um fornecedor (white space) — quem ainda não compra o quê.
Financeiro · 2
GET /v1/receivablesTítulos a receber, um a um, com vencimento e dias de atraso.
GET /v1/agg/receivables/by-customerContas a receber agregadas por cliente — em aberto, vencido e inadimplente.
Estoque · 1
GET /v1/stockPosição de estoque atual por produto (retrato do momento, sem período).
Metas · 2
GET /v1/goalsMetas por período e nível (empresa, supervisor, RCA, RCA×fornecedor).
GET /v1/agg/goals/by-supplierMeta × realizado agregado por fornecedor.
Esta página ajudou? Conte para a gente — lemos tudo.