Objetivo

Método de consulta de grupos de promoções cadastradas no ERP.

Chamada

GET /api/v1/GrupoPromocao

Informações para Requisição (Request Information)

Parâmetros URI (URI Parameters)

NomeDescriçãoTipo (Type)Exigência
CNPJ EmpresaCNPJ da empresa utilizada como filtro de informações das promoçõesstringOpcional
Número EmpresaNúmero de Empresa para filtrar as promoçõesinteger($int32)Opcional
SegmentoNúmero do segmento de venda para filtrar as promoçõesinteger($int32)Opcional
StatusA = ativo (somente produtos ativos), I = inativo (somente produtos inativos). Padrão: A.

string

Opcional
VigenteSomente Promoções em vigor no momentostringOpcional
Código PromoçãoFiltro de promoção normal específicainteger($int32)Opcional
Data Hora de AlteraçãoFiltro para buscar promoções alteradas a partir de uma data (item / cabeçalho)string($date-time)Opcional
Data InícioFiltro para buscar promoções que tem início a partir de uma datastring($date-time)Opcional


Parâmetros do Corpo (Body Parameters)

Não há.

Informações para Resposta (Response Information)

Códigos do Recurso (Response Codes)

Formatos de Resposta (Response Formats)

application/json, text/json

CODE 200 - SUCCESS

PromocaoDtoIListDto

NomeDescriçãoTipo (Type)Origem
Código da PromoçãoNúmero do código da promoção
Código gerado internamente a cada promoção criada. Promoções > Promoção (parte numérica)
DescriçãoDescrição da promoção
Promoções > Promoção (parte texto)
Data Início da PromoçãoData inicial da promoção
Promoções > Período > Data Inicial
Data Fim da PromoçãoData final da promoção
Promoções > Período > Data Final
Faixa de Acréscimo FinanceiroIndica a faixa de acréscimo para cálculo do preço de tabela, na venda dos produtos da promoção. Utilizado em vendas pelo módulo Venda Balcão.
Promoções > aba Promoção > Faixa de Acréscimo Financeiro
Grupo de PromoçãoIndica o código e descrição do grupo que a promoção pertence
Interno banco de dados
Indicador se Usa Acréscimo de Tabela de vendaIndica se aplica acréscimo de tabela de venda, ao calcular o preço de venda dos produtos da promoção. Utilizado em vendas pelo módulo Venda Balcão.
Interno banco de dados
Tipo de Média de VendaIndica o tipo cálculo de média de venda em que deve se enquadrar as vendas dos produtos da promoção. P = Promoção / N = Normal.
Gerenciador de Preços > Pesquisa de Promoções > coluna Média Vda.

Inativa Promoção sem Saldo de Acordo

Indica se inativa a promoção quando não houver saldo do conta corrente de acordo promocional vinculado.
Interno banco de dados
Data e hora de inclusãoData e hora em que a promoção foi incluída no ERP
Interno banco de dados
Data e hora de alteraçãoData e hora em que a promoção foi alterada no ERP
Interno banco de dados