Indicador compra
1 função do TermoPortal para indicador compra.
// 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 |
|---|---|---|
buscar_pelo_filtro_indicador_compra | GET /indicador_compra/filtro | Indicadores de compra de uma unidade |
buscar_pelo_filtro_indicador_compra
GET/indicador_compra/filtro Exige credencial
Indicadores de compra de uma unidade
Exige a permissão ver no módulo Dashboard do perfil de quem chama (administrador e master têm tudo). Soma na hora as compras (notas emitidas pelo Tiny) do CNPJ da unidade unidade_id: total comprado, comparação com o período anterior (períodos de até 731 dias), notas, produtos diferentes, última compra, compras por mês, por tipo e os produtos mais comprados (até 6). unidade_id é obrigatório e precisa ser uma unidade da sessão (colaborador interno acessa todas). inicio e fim em AAAA-MM-DD (padrão: últimos 365 dias). amostra: true indica soma parcial. Até 30 chamadas por minuto por pessoa.
function buscar_pelo_filtro_indicador_compra(
credencial_de_acesso: CredencialDeAcesso,
parametros: ParametrosDeBuscarPeloFiltroIndicadorCompra = {},
opcoes_da_chamada?: OpcoesDaChamada,
): Promise<tipos.IndicadoresDeCompra>import { CredencialDeAcesso } from "termo_core";
import { buscar_pelo_filtro_indicador_compra } from "termo_core/portal";
const credencial_de_acesso = CredencialDeAcesso.token_do_usuario_logado(token_do_usuario);
const resposta = await buscar_pelo_filtro_indicador_compra(credencial_de_acesso, { inicio: "..." });Argumentos
Nome
Tipo
Retorno: Promise<tipos.IndicadoresDeCompra> · Rust: Result<tipos::IndicadoresDeCompra, ErroAoChamarServico> · veja IndicadoresDeCompra.
Tipos
Tipos usados pelas funções desta página. O nome é o mesmo nos dois pacotes.
CompraDoMes
import type { CompraDoMes } from "termo_core/portal";
export interface CompraDoMes {
comprado: number;
mes: string;
notas: number;
}CompraPorTipo
import type { CompraPorTipo } from "termo_core/portal";
export interface CompraPorTipo {
comprado: number;
tipo: string;
}IndicadoresDeCompra
import type { IndicadoresDeCompra } from "termo_core/portal";
export interface IndicadoresDeCompra {
amostra: boolean;
anterior?: number | null;
comprado: number;
fim: string;
inicio: string;
itens: number;
notas: number;
por_mes: Array<CompraDoMes>;
por_tipo: Array<CompraPorTipo>;
produtos: Array<ProdutoComprado>;
produtos_diferentes: number;
ultima_compra?: string | null;
}ProdutoComprado
import type { ProdutoComprado } from "termo_core/portal";
export interface ProdutoComprado {
comprado: number;
descricao: string;
familia?: string | null;
quantidade: number;
sku: string;
tipo?: string | null;
ultima_compra?: string | null;
ultima_quantidade: number;
vezes: number;
}