Pular para o conteúdo

Relatórios

Base: https://api.nivesistemas.com.br · 47 endpoints

Resumo de vendas

Query params

Campo Tipo Obrigatório Descrição
from string não Data inicial (YYYY-MM-DD)
to string não Data final
sellerId string não Filtrar por vendedor (UUID)
paymentMethodId string não Filtrar por forma de pagamento
salesChannelId string não Filtrar por canal de venda (UUID) ou none para vendas sem canal
includeItems boolean não Inclui os produtos de cada venda (relatório detalhado)
Janela do terminal
curl -X GET "https://api.nivesistemas.com.br/reports/sales-summary" \
-H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
-H "X-Store-Slug: loja-demo"

Faturamento comercial agrupado por mês

Query params

Campo Tipo Obrigatório Descrição
from string não Data inicial (YYYY-MM-DD)
to string não Data final
Janela do terminal
curl -X GET "https://api.nivesistemas.com.br/reports/monthly-sales" \
-H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
-H "X-Store-Slug: loja-demo"

Produtos mais vendidos

Query params

Campo Tipo Obrigatório Descrição
from string não Data inicial
to string não Data final
limit integer não Quantidade
Janela do terminal
curl -X GET "https://api.nivesistemas.com.br/reports/top-products" \
-H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
-H "X-Store-Slug: loja-demo"

Vendas por categoria

Query params

Campo Tipo Obrigatório Descrição
from string não Data inicial
to string não Data final
Janela do terminal
curl -X GET "https://api.nivesistemas.com.br/reports/sales-by-category" \
-H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
-H "X-Store-Slug: loja-demo"

Vendas e catálogo por tag de produto

Query params

Campo Tipo Obrigatório Descrição
from string não Data inicial
to string não Data final
Janela do terminal
curl -X GET "https://api.nivesistemas.com.br/reports/sales-by-tag" \
-H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
-H "X-Store-Slug: loja-demo"

Vendas, produtos e estoque por marca, categoria ou tag

Query params

Campo Tipo Obrigatório Descrição
dimension string sim brand, category ou tag
from string não Data inicial
to string não Data final
Janela do terminal
curl -X GET "https://api.nivesistemas.com.br/reports/catalog-groups" \
-H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
-H "X-Store-Slug: loja-demo"

Produtos de uma marca, categoria ou tag com vendas do período e estoque atual

Query params

Campo Tipo Obrigatório Descrição
dimension string sim brand, category ou tag
groupId string sim Id do grupo ou none (sem marca/categoria/tag)
from string não Data inicial
to string não Data final
Janela do terminal
curl -X GET "https://api.nivesistemas.com.br/reports/catalog-groups/products" \
-H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
-H "X-Store-Slug: loja-demo"

Posição de estoque

Query params

Campo Tipo Obrigatório Descrição
all boolean não Retorna todos os SKUs (sem paginação)
page integer não Página (padrão 1)
pageSize integer não Itens por página (padrão 500, máx. 2000)
Janela do terminal
curl -X GET "https://api.nivesistemas.com.br/reports/stock" \
-H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
-H "X-Store-Slug: loja-demo"

Peças em rascunhos de venda (para conferência)

Janela do terminal
curl -X GET "https://api.nivesistemas.com.br/reports/draft-stock" \
-H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
-H "X-Store-Slug: loja-demo"

Alertas do dashboard

Janela do terminal
curl -X GET "https://api.nivesistemas.com.br/reports/dashboard-alerts" \
-H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
-H "X-Store-Slug: loja-demo"

Melhores clientes

Query params

Campo Tipo Obrigatório Descrição
from string não Data inicial
to string não Data final
Janela do terminal
curl -X GET "https://api.nivesistemas.com.br/reports/top-customers" \
-H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
-H "X-Store-Slug: loja-demo"

Vendas a prazo

Query params

Campo Tipo Obrigatório Descrição
from string não Data inicial
to string não Data final
Janela do terminal
curl -X GET "https://api.nivesistemas.com.br/reports/credit-sales" \
-H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
-H "X-Store-Slug: loja-demo"

Relatório de taxas de cartão (MDR) no período

Query params

Campo Tipo Obrigatório Descrição
from string não Data inicial
to string não Data final
Janela do terminal
curl -X GET "https://api.nivesistemas.com.br/reports/card-fees" \
-H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
-H "X-Store-Slug: loja-demo"

Comissões por vendedor

Query params

Campo Tipo Obrigatório Descrição
from string não Data inicial
to string não Data final
Janela do terminal
curl -X GET "https://api.nivesistemas.com.br/reports/commissions-by-seller" \
-H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
-H "X-Store-Slug: loja-demo"

Visão geral do dashboard

Janela do terminal
curl -X GET "https://api.nivesistemas.com.br/reports/dashboard-overview" \
-H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
-H "X-Store-Slug: loja-demo"

Métricas do dashboard

Janela do terminal
curl -X GET "https://api.nivesistemas.com.br/reports/dashboard-metrics" \
-H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
-H "X-Store-Slug: loja-demo"

Gráficos do dashboard

Janela do terminal
curl -X GET "https://api.nivesistemas.com.br/reports/dashboard-charts" \
-H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
-H "X-Store-Slug: loja-demo"

Insights do dashboard

Janela do terminal
curl -X GET "https://api.nivesistemas.com.br/reports/dashboard-insights" \
-H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
-H "X-Store-Slug: loja-demo"

Curva ABC de produtos por faturamento

Janela do terminal
curl -X GET "https://api.nivesistemas.com.br/reports/product-abc" \
-H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
-H "X-Store-Slug: loja-demo"

Margem bruta por pedido

Janela do terminal
curl -X GET "https://api.nivesistemas.com.br/reports/sale-margins" \
-H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
-H "X-Store-Slug: loja-demo"

Indicadores de clientes no período

Janela do terminal
curl -X GET "https://api.nivesistemas.com.br/reports/customer-dashboard" \
-H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
-H "X-Store-Slug: loja-demo"

Meta mensal de faturamento

Janela do terminal
curl -X GET "https://api.nivesistemas.com.br/reports/sales-goals" \
-H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
-H "X-Store-Slug: loja-demo"

Criar ou atualizar meta mensal

Janela do terminal
curl -X PUT "https://api.nivesistemas.com.br/reports/sales-goals" \
-H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
-H "X-Store-Slug: loja-demo"

Progresso da meta no mês

Janela do terminal
curl -X GET "https://api.nivesistemas.com.br/reports/sales-goals/progress" \
-H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
-H "X-Store-Slug: loja-demo"

Histórico de metas e realizado

Janela do terminal
curl -X GET "https://api.nivesistemas.com.br/reports/sales-goals/history" \
-H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
-H "X-Store-Slug: loja-demo"

Aniversários de clientes

Janela do terminal
curl -X GET "https://api.nivesistemas.com.br/reports/customer-birthdays" \
-H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
-H "X-Store-Slug: loja-demo"

Aniversários de vendedores

Janela do terminal
curl -X GET "https://api.nivesistemas.com.br/reports/seller-birthdays" \
-H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
-H "X-Store-Slug: loja-demo"

Fluxo de caixa

Janela do terminal
curl -X GET "https://api.nivesistemas.com.br/reports/cash-flow" \
-H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
-H "X-Store-Slug: loja-demo"

DRE gerencial ou contábil (receita, CMV, despesas, impostos e resultado do período)

Query params

Campo Tipo Obrigatório Descrição
from string não Data inicial (YYYY-MM-DD)
to string não Data final
view string não managerial (padrão) ou accounting
Janela do terminal
curl -X GET "https://api.nivesistemas.com.br/reports/dre" \
-H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
-H "X-Store-Slug: loja-demo"

Entradas de caixa por forma de pagamento (à vista, crediário e cheques compensados)

Query params

Campo Tipo Obrigatório Descrição
from string não Data inicial
to string não Data final
Janela do terminal
curl -X GET "https://api.nivesistemas.com.br/reports/cash-inflow-by-payment" \
-H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
-H "X-Store-Slug: loja-demo"

Aging de contas a receber

Janela do terminal
curl -X GET "https://api.nivesistemas.com.br/reports/receivables-aging" \
-H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
-H "X-Store-Slug: loja-demo"

Contas canceladas por perda (perdão de dívida) no período

Query params

Campo Tipo Obrigatório Descrição
from string sim Início (YYYY-MM-DD)
to string sim Fim (YYYY-MM-DD)
Janela do terminal
curl -X GET "https://api.nivesistemas.com.br/reports/receivables-write-offs" \
-H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
-H "X-Store-Slug: loja-demo"

Relatório detalhado de contas a receber (títulos em aberto por cliente)

Query params

Campo Tipo Obrigatório Descrição
status string não open (padrão) | overdue | current
Janela do terminal
curl -X GET "https://api.nivesistemas.com.br/reports/receivables-detailed" \
-H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
-H "X-Store-Slug: loja-demo"

Relatório resumido de contas a receber (saldo total por cliente)

Query params

Campo Tipo Obrigatório Descrição
status string não open (padrão) | overdue | current
Janela do terminal
curl -X GET "https://api.nivesistemas.com.br/reports/receivables-summary" \
-H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
-H "X-Store-Slug: loja-demo"

Relatório detalhado de contas a pagar (títulos em aberto por fornecedor)

Query params

Campo Tipo Obrigatório Descrição
status string não open (padrão) | overdue | current
supplierId uuid não Fornecedor
categoryId string não Categoria (uuid) ou none para sem categoria
costCenterId uuid não Centro de custo
kind string não manual | purchase | recurring | card_bill | credit_card
approvalStatus string não PENDING | APPROVED | REJECTED
q string não Busca (descrição, NF, fornecedor, documento)
dueFrom string não Vencimento inicial (YYYY-MM-DD)
dueTo string não Vencimento final (YYYY-MM-DD)
Janela do terminal
curl -X GET "https://api.nivesistemas.com.br/reports/payables-detailed" \
-H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
-H "X-Store-Slug: loja-demo"

Contas pagas no período (principal, juros, multa, desconto, forma e conta de saída)

Query params

Campo Tipo Obrigatório Descrição
from string sim Início (YYYY-MM-DD)
to string sim Fim (YYYY-MM-DD)
supplierId uuid não Fornecedor
categoryId string não Categoria (uuid) ou none para sem categoria
costCenterId uuid não Centro de custo
kind string não manual | purchase | recurring | card_bill | credit_card
q string não Busca (descrição, NF, fornecedor, documento)
financialAccountId string não Conta de saída (uuid) ou none
paymentMethodId string não Forma de pagamento (uuid) ou none
Janela do terminal
curl -X GET "https://api.nivesistemas.com.br/reports/payables-paid" \
-H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
-H "X-Store-Slug: loja-demo"

Contas a pagar em aberto e pagas no período, agrupadas

Query params

Campo Tipo Obrigatório Descrição
from string sim Início (YYYY-MM-DD)
to string sim Fim (YYYY-MM-DD)
dimension string não category (padrão) | dreGroup | costCenter | supplier
supplierId uuid não Fornecedor
categoryId string não Categoria (uuid) ou none para sem categoria
costCenterId uuid não Centro de custo
kind string não manual | purchase | recurring | card_bill | credit_card
q string não Busca (descrição, NF, fornecedor, documento)
Janela do terminal
curl -X GET "https://api.nivesistemas.com.br/reports/payables-summary" \
-H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
-H "X-Store-Slug: loja-demo"

Projeção de saídas (parcelas em aberto e recorrências a gerar), entradas previstas e saldo projetado

Query params

Campo Tipo Obrigatório Descrição
from string não Início (YYYY-MM-DD, padrão hoje)
to string não Fim (YYYY-MM-DD, padrão hoje + 90 dias)
groupBy string não day | week (padrão) | month
supplierId uuid não Fornecedor
categoryId string não Categoria (uuid) ou none para sem categoria
costCenterId uuid não Centro de custo
kind string não manual | purchase | recurring | card_bill | credit_card
q string não Busca (descrição, NF, fornecedor, documento)
Janela do terminal
curl -X GET "https://api.nivesistemas.com.br/reports/payables-forecast" \
-H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
-H "X-Store-Slug: loja-demo"

Contas a pagar canceladas no período (valor cancelado, motivo e usuário)

Query params

Campo Tipo Obrigatório Descrição
from string sim Início (YYYY-MM-DD)
to string sim Fim (YYYY-MM-DD)
supplierId uuid não Fornecedor
categoryId string não Categoria (uuid) ou none para sem categoria
costCenterId uuid não Centro de custo
kind string não manual | purchase | recurring | card_bill | credit_card
q string não Busca (descrição, NF, fornecedor, documento)
Janela do terminal
curl -X GET "https://api.nivesistemas.com.br/reports/payables-cancelled" \
-H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
-H "X-Store-Slug: loja-demo"

Dashboard de serviços

Query params

Campo Tipo Obrigatório Descrição
from string não Data inicial
to string não Data final
Janela do terminal
curl -X GET "https://api.nivesistemas.com.br/reports/services-dashboard" \
-H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
-H "X-Store-Slug: loja-demo"

Relatório de campanhas promocionais

Query params

Campo Tipo Obrigatório Descrição
from string sim Data inicial (YYYY-MM-DD)
to string sim Data final
campaignId uuid não Campanha
sellerId uuid não Vendedor
productId uuid não Produto
operatorUserId uuid não Operador
sortBy string não quantity | revenue | discount | units
Janela do terminal
curl -X GET "https://api.nivesistemas.com.br/reports/promotional-campaigns" \
-H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
-H "X-Store-Slug: loja-demo"

GET /reports/promotional-campaigns/:campaignId/sales

Seção intitulada “GET /reports/promotional-campaigns/:campaignId/sales”

Vendas de uma campanha promocional

Parâmetros de rota: campaignId

Janela do terminal
curl -X GET "https://api.nivesistemas.com.br/reports/promotional-campaigns/{campaignId}/sales" \
-H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
-H "X-Store-Slug: loja-demo"

Contagens de estoque (sem custo) para o painel inicial

Janela do terminal
curl -X GET "https://api.nivesistemas.com.br/reports/stock-summary" \
-H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
-H "X-Store-Slug: loja-demo"

Consumo próprio / uso interno

Query params

Campo Tipo Obrigatório Descrição
from string não Data inicial
to string não Data final
status string não COMPLETED ou CANCELLED
locationId uuid não Local
productId uuid não Produto
categoryId uuid não Categoria
userId uuid não Usuário
Janela do terminal
curl -X GET "https://api.nivesistemas.com.br/reports/own-consumption" \
-H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
-H "X-Store-Slug: loja-demo"

Sugestão de compra (relatórios avançados)

Query params

Campo Tipo Obrigatório Descrição
filter string não out (zerados), low (abaixo do mínimo) ou all
limit integer não Padrão 200, máx. 500
Janela do terminal
curl -X GET "https://api.nivesistemas.com.br/reports/suggested-purchase" \
-H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
-H "X-Store-Slug: loja-demo"

Estoque parado (relatórios avançados)

Query params

Campo Tipo Obrigatório Descrição
minDays integer não Dias sem venda (padrão 60)
limit integer não Padrão 500, máx. 1000
Janela do terminal
curl -X GET "https://api.nivesistemas.com.br/reports/dead-stock" \
-H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
-H "X-Store-Slug: loja-demo"

Emitir NFC-e pendentes em lote (relatórios avançados)

Query params

Campo Tipo Obrigatório Descrição
limit integer não Máx. 500
Janela do terminal
curl -X POST "https://api.nivesistemas.com.br/reports/dashboard-inbox/emit-pending-nfce" \
-H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
-H "X-Store-Slug: loja-demo"