Documentação API (Forç... » Dashboard
Export

Dashboard

Este artigo documenta o processo para a criação dos dashboars de vendas

Neste recurso será possível obter os dados para criação de dashboards mostrando as vendas por situação do pedido, quantidade de pedidos por situação, comparativo de metas x faturamento, análise de produdos mais vendidos e clientes com mais vendas.

Painel de vendas agrupado por situação do pedido

Lista o total de faturamento agrupado por situação do pedido de um determinado período.

Requisição  
Método GET
URL /api/v1/dashboards/pedidos_venda/faturamento_por_situacao
Formato do conteúdo application/json
Parâmetros de consulta Tipo Obrigatório Descrição
dataInicial Data Sim Data inicial para filtro
dataFinal Data Sim Data final para filtro
filial Integer Sim Filial do representante
gerente Integer Não

Código do gerente

Obrigatório se logado com privilégio gerente
supervisor Integer Não Obrigatório se logado com privilégio supervisor
representante Integer Não Obrigatório se logado com privilégio representante
Exemplo de uso
/api/v1/dashboards/pedidos_venda/faturamento_por_situacao?dataInicial=2023-05-01&dataFinal=2023-05-30&filial=1
/api/v1/dashboards/pedidos_venda/faturamento_por_situacao?dataInicial=2023-05-01&dataFinal=2023-05-30&filial=1&gerente=1
/api/v1/dashboards/pedidos_venda/faturamento_por_situacao?dataInicial=2023-05-01&dataFinal=2023-05-30&filial=1&supervisor=10
/api/v1/dashboards/pedidos_venda/faturamento_por_situacao?dataInicial=2023-05-01&dataFinal=2023-05-30&filial=1&representante=100
Estrutura de dados da resposta
 		       
Propriedade Tipo Tamanho Obrigatório Descrição
situacao String 20 Sim

Situação do pedido

LIBERADO

BLOQUEADO

BLOQUEADO_COMERCIAL

DIGITACAO

BLOQUEADO_FINANCEIRO

BLOQUEADO_INTERNET

MARGEM_CONTRIBUICAO

BLOQUEADO_SALDO

CANCELADO

FATURADO

RASCUNHO
quantidadePedidos Numeric 15,2 Sim Quantidade de pedidos
faturamentoTotal Numeric 15,2 Sim total do faturamento por situação 
[
  {
    "situacao": "FATURADO",
    "quantidadePedidos": 100,
    "faturamentoTotal": 1000000.00
  },
  {
    "situacao": "RASCUNHO",
    "quantidadePedidos": 10,
    "faturamentoTotal": 10000.00
  },
  {
    "situacao": "BLOQUEADO",
    "quantidadePedidos": 5,
    "faturamentoTotal": 25000.00
  },
  {
    "situacao": "CANCELADOS",
    "quantidadePedidos": 5,
    "faturamentoTotal": 2000.00
   }
]
Fatumento dos últimos 12 meses

Lista os totais de faturamento dos últimos 12 meses

Requisição  
Método GET
URL /api/v1/dashboards/pedidos_venda/faturamento_doze_meses
Formato do conteúdo application/json
Parâmetros de consulta Tipo Obrigatório Descrição
filial Integer Sim Filial do representante
gerente Integer Não

Código do gerente

Obrigatório se logado com privilégio gerente
supervisor Integer Não Obrigatório se logado com privilégio supervisor
representante Integer Não Obrigatório se logado com privilégio representante
Exemplo de uso
/api/v1/dashboards/pedidos_venda/faturamento_doze_meses?filial=1
/api/v1/dashboards/pedidos_venda/faturamento_doze_meses?filial=1&gerente=1
/api/v1/dashboards/pedidos_venda/faturamento_doze_meses?filial=1&supervisor=10
/api/v1/dashboards/pedidos_venda/faturamento_doze_meses?filial=1&representante=100
Estrutura de dados da resposta
 		       
Propriedade Tipo Tamanho Obrigatório Descrição
competencia String 7 Sim

Mês de competência
valorFaturamento Numeric 15,2 Sim total do faturamento do mês 
[
  {
    "competencia": "03/2023",
    "valorFaturamento": 1000000.00
  },
  {
    "competencia": "04/2023",
    "valorFaturamento": 500000.00
  },
  {
    "competencia": "05/2023",
    "valorFaturamento": 500000.00
  }
]
Fatumento x metas de uma período selecionado

Lista os totais de faturamento e metas de uma período selecionado

Requisição  
Método GET
URL /api/v1/dashboards/pedidos_venda/faturamento_meta_periodo
Formato do conteúdo application/json
Parâmetros de consulta Tipo Obrigatório Descrição
dataInicial Data Sim Data inicial para filtro
dataFinal Data Sim Data final para filtro
filial Integer Sim Filial do representante
gerente Integer Não

Código do gerente

Obrigatório se logado com privilégio gerente
supervisor Integer Não Obrigatório se logado com privilégio supervisor
representante Integer Não Obrigatório se logado com privilégio representante
Exemplo de uso
/api/v1/dashboards/pedidos_venda/faturamento_meta_periodo?dataInicial=2023-05-01&dataFinal=2023-05-30&filial=1
/api/v1/dashboards/pedidos_venda/faturamento_meta_periodo?dataInicial=2023-05-01&dataFinal=2023-05-30&filial=1&gerente=1
/api/v1/dashboards/pedidos_venda/faturamento_meta_periodo?dataInicial=2023-05-01&dataFinal=2023-05-30&filial=1&supervisor=10
/api/v1/dashboards/pedidos_venda/faturamento_meta_periodo?dataInicial=2023-05-01&dataFinal=2023-05-30&filial=1&representante=100
Estrutura de dados da resposta
 		       
Propriedade Tipo Tamanho Obrigatório Descrição
competencia String 7 Sim

Mês de competência
valorFaturamento Numeric 15,2 Sim total do faturamento do mês
valorMeta Numeric 15,2 Sim total da meta do mês 
[
  {
    "competencia": "03/2023",
    "valorFaturamento": 1000000.00,
    "valorMera": 900000.00
  },
  {
    "competencia": "04/2023",
    "valorFaturamento": 500000.00,
    "valorMera": 550000.00
  },
  {
    "competencia": "05/2023",
    "valorFaturamento": 500000.00,
    "valorMera": 600000.00
  }
]
Análise dos produtos mais vendidos

Lista o total do faturamento por produto em um determinado período ordendo em ordem descrecente para listar os produtos mais vendidos.

Requisição  
Método GET
URL /api/v1/dashboards/pedidos_venda/faturamento_por_produto
Formato do conteúdo application/json
Parâmetros de consulta Tipo Obrigatório Descrição
dataInicial Data Sim Data inicial para filtro
dataFinal Data Sim Data final para filtro
filial Integer Sim Filial do representante
gerente Integer Não

Código do gerente

Obrigatório se logado com privilégio gerente
supervisor Integer Não Obrigatório se logado com privilégio supervisor
representante Integer Não Obrigatório se logado com privilégio representante
Exemplo de uso
/api/v1/dashboards/pedidos_venda/faturamento_por_produto?dataInicial=2023-05-01&dataFinal=2023-05-30&filial=1
/api/v1/dashboards/pedidos_venda/faturamento_por_produto?dataInicial=2023-05-01&dataFinal=2023-05-30&filial=1&gerente=1
/api/v1/dashboards/pedidos_venda/faturamento_por_produto?dataInicial=2023-05-01&dataFinal=2023-05-30&filial=1&supervisor=10
/api/v1/dashboards/pedidos_venda/faturamento_por_produto?dataInicial=2023-05-01&dataFinal=2023-05-30&filial=1&representante=100
Estrutura de dados da resposta
 		       
Propriedade Tipo Tamanho Obrigatório Descrição
produtoId Integer - Sim

Identificador do produto
produtoNome String 60 Sim Descricao do produto
valorFaturamento Numeric 15,2 Sim total do faturamento do produto 
[
  {
    "produtoId": 100,
    "produtoNome": "Produto 100",
    "valorFaturamento": 1000000.00
  },
  {
    "produtoId": 200,
    "produtoNome": "Produto 200",
    "valorFaturamento": 500000.00
  },
  {
    "produtoId": 300,
    "produtoNome": "Produto 300",
    "valorFaturamento": 300500.00
  },
  {
    "produtoId": 400,
    "produtoNome": "Produto 400",
    "valorFaturamento": 200000.00
  }
]
Análise dos clientes que mais compraram

Lista o total do faturamento por cliente em um determinado período ordendo em ordem descrecente para listar os cliente que mais compraram.

Requisição  
Método GET
URL /api/v1/dashboards/pedidos_venda/faturamento_por_cliente
Formato do conteúdo application/json
Parâmetros de consulta Tipo Obrigatório Descrição
dataInicial Data Sim Data inicial para filtro
dataFinal Data Sim Data final para filtro
filial Integer Sim Filial do representante
gerente Integer Não

Código do gerente

Obrigatório se logado com privilégio gerente
supervisor Integer Não Obrigatório se logado com privilégio supervisor
representante Integer Não Obrigatório se logado com privilégio representante
Exemplo de uso
/api/v1/dashboards/pedidos_venda/faturamento_por_cliente?dataInicial=2023-05-01&dataFinal=2023-05-30&filial=1
/api/v1/dashboards/pedidos_venda/faturamento_por_cliente?dataInicial=2023-05-01&dataFinal=2023-05-30&filial=1&gerente=1
/api/v1/dashboards/pedidos_venda/faturamento_por_cliente?dataInicial=2023-05-01&dataFinal=2023-05-30&filial=1&supervisor=10
/api/v1/dashboards/pedidos_venda/faturamento_por_cliente?dataInicial=2023-05-01&dataFinal=2023-05-30&filial=1&representante=100
Estrutura de dados da resposta
 		       
Propriedade Tipo Tamanho Obrigatório Descrição
clienteId Integer - Sim

Identificador do cliente
clienteNome String 60 Sim Descricao do cliente
valorFaturamento Numeric 15,2 Sim total do faturamento do cliente 
[
  {
    "clienteId": 100,
    "clienteNome": "Cliente 100",
    "valorFaturamento": 1000000.00
  },
  {
    "clienteId": 200,
    "clienteNome": "Cliente 200",
    "valorFaturamento": 500000.00
  },
  {
    "clienteId": 300,
    "clienteNome": "Cliente 300",
    "valorFaturamento": 300500.00
  },
  {
    "clienteId": 400,
    "clienteNome": "Cliente 400",
    "valorFaturamento": 200000.00
  }
]
 
 
Back to top
Dashboard | Documentação

An Error Occurred

An unknown error occurred

Return to home

Back to top