Dashboards
1 função do TermoPortal para dashboards.
// npm install termo_core --save-exact
import * as portal from "termo_core/portal";
// ou: import { portal } from "termo_core";| Função | Rota | O que faz |
|---|---|---|
painel_buscar_top_empresas_pedido_dashboards | GET /dashboards/painel/top_empresas_pedido | As 10 empresas que mais enviaram pedidos no período |
painel_buscar_top_empresas_pedido_dashboards
GET/dashboards/painel/top_empresas_pedido Exige credencial
As 10 empresas que mais enviaram pedidos no período
Dashboard do painel: só colaborador interno com o módulo Dashboard. Conta os pedidos de venda do Tiny (pedido_venda_tiny, sem os cancelados) de cada empresa (a unidade do pedido; sem unidade, o documento ou o nome do cliente) com a data entre inicio e fim (hoje, no horário de Brasília). periodo: dia (hoje), semana (desde segunda), semestre (desde 1º de janeiro ou 1º de julho) ou ano (desde 1º de janeiro); sem ele, semana. Ordem: mais pedidos, depois maior valor. total_pedidos e total_empresas são de todas as empresas do período, não só das 10. O resultado fica 30 minutos em cache na memória do backend (atualizado_em e proxima_atualizacao_em).
function painel_buscar_top_empresas_pedido_dashboards(
credencial_de_acesso: CredencialDeAcesso,
parametros: ParametrosDePainelBuscarTopEmpresasPedidoDashboards = {},
opcoes_da_chamada?: OpcoesDaChamada,
): Promise<tipos.TopEmpresasPedido>import { CredencialDeAcesso } from "termo_core";
import { painel_buscar_top_empresas_pedido_dashboards } from "termo_core/portal";
const credencial_de_acesso = CredencialDeAcesso.token_do_usuario_logado(token_do_usuario);
const resposta = await painel_buscar_top_empresas_pedido_dashboards(credencial_de_acesso, { periodo: "..." });Argumentos
Nome
Tipo
Retorno: Promise<tipos.TopEmpresasPedido> · Rust: Result<tipos::TopEmpresasPedido, ErroAoChamarServico> · veja TopEmpresasPedido.
Tipos
Tipos usados pelas funções desta página. O nome é o mesmo nos dois pacotes.
TopEmpresaPedido
import type { TopEmpresaPedido } from "termo_core/portal";
export interface TopEmpresaPedido {
documento?: string | null;
nome: string;
posicao: number;
quantidade_pedidos: number;
unidade_id?: string | null;
valor_total: number;
}TopEmpresasPedido
import type { TopEmpresasPedido } from "termo_core/portal";
export interface TopEmpresasPedido {
atualizado_em: string;
empresas: Array<TopEmpresaPedido>;
fim: string;
inicio: string;
periodo: string;
proxima_atualizacao_em: string;
total_empresas: number;
total_pedidos: number;
}