Entidade REGRAS_COMISSIONAMENTO

COMISSOES.REGRAS_COMISSIONAMENTO

Descrição

Regra de comissionamento para apuração da comissão nos pedidos, documentos ou financeiro.

Atributos

Atributo	Domínio	Regras	Descrição
ID	ID(18)	Rqd PK	Id: Chave de identificação interna
REGRA_COMISSIONAMENTO	OPCAO(100)	Rqd UK	Nome da regra: Nome dado para identificar a regra de comissionamento.
DESCRICAO	TEXT_LONG		Descrição: Texto livre contendo uma descrição da regra. Meramente informativo.
TIPO_OPERACAO	OPTION(1)	Rqd	Tipo de operação: Define o tipo de operação da comissão. Valores permitidos: P - Pagar - A comissão será paga pelo estabelecimento para a pessoa comissionada. R - Receber - A comissão será cobrada da pessoa comissionada. Valor padrão = P
ORIGEM	OPCAO(1)	Rqd	Origem: Indica ONDE as comissões desta regra são definidas. Não indica QUANDO as comissõe são pagas. Por exemplo: É muito comum definir a comissão no pedido e paga-la ao comissionado somente da liquidação dos pagamentos do(s) respectivo(s) faturamentos. Valores permitidos: I - Item do pedido - Comissão definida pelo item do pedido. Pode variar conforme o produto. P - Pedido - As comissões são definidas no pedido. Não pode variar conforme o produto. O - Item de documento - Comissão definida pelo item do documento. Pode variar conforme o produto. D - Documento - As comissões são definidas em um documento de entrada ou saída. T - Título - As comissões são definidas em títulos de um determinado cliente. N - Cumprimento de metas - As comissões são determinadas a partir do atingimento de determinados valores de indicadores de qualidade. M - Manual - A contratação da comissão somente pode ser registrada manualmente. Valor padrão = P
PERMITE_INCLUSAO_MANUAL	FLAG(1)	Rqd	Permite inclusão manual: Indica quando uma regra de comissionamento pode ser inserida manualmente nos respectivos elementos originadores. Valor padrão = N
GRUPO	UPPER(20)	UK	Grupo: Nome de um grupo de regras de comissão. Nos processamento das comissões, apenas uma regra de cada grupo gera comissões. Quando a regra participa de um grupo, ela deverá ter também uma sequencia que define a ordem com que as regras são avaliadas. Apenas a primeira regra de um grupo que atender às condições será aplicada. Todas as demais regras do mesmo grupo são ignoradas.
SEQUENCIA	INTEGER	UK	Sequencia: Sequencia para aplicação das regras de um grupo. Deve ser informado apenas quando existir um grupo informado.
DATA_INICIO	DATE		Data de início: Quando informada, indica que esta regra só válida a partir desta data. A data considerada é sempre data de emissão do objeto originador (pedido, documento, título, etc.).
DATA_TERMINO	DATE		Data de término: Quando informada, indica que esta regra não deve ser utilizada após esta data. A data considerada é sempre data de emissão do objeto originador.
TIPO_REGRA	OPCAO(1)	Rqd	Tipo de regra: Indica a forma com que a regra será definida. Valores permitidos: P - Parametrizada - A regra é definida através de um conjunto de parâmetros que definem filtros e valores utilizados para calcular o parâmetro. S - SQL - O comissionamento é calculado através de uma expressão SQL que determina os valores e as pessoas comissionados. Valor padrão = P
REGRA_SQL	SOURCE_CODE		Regra SQL: SQL que define o valor e a pessoa a ser comissionada. Deve ser preenchido quando o tipo de regra for "SQL". Este SQL deverá receber um único parâmetro que depende da origem da regra, ou seja, pode ser o item do pedido, item do documento fiscal ou título. O SQL deverá retornar um registro para cada comissão devida com as seguintes colunas: COMISSIONADO_ID - ID da pessoa a ser comissionada. VALOR_COMISSAO - Valor total a ser comissionada quando a condição de comissionamento for atendida.
COMISSIONADO	OPTION(21)	Rqd	Comissionado: Indica a pessoa para quem será paga (comissões a pagar) ou de quem será recebida (comissões a receber) a comissão. Caso informado 'OUTRO' deve obrigatoriamente ser informado uma pessoa específica. Valores permitidos: VENDEDOR - Vendedor do pedido - O comissionado para esta regra deve ser o vendedor que está informado no pedido. VENDEDOR_CLIENTE - Vendedor do cliente - O comissionado para esta regra será o vendedor registrado no cadastro do cliente do pedido. REPRESENTANTE - Representante do pedido - Pessoa que está informada como representante no pedido. REPRESENTANTE_CLIENTE - Representante do cliente - O comissionado para esta regra será o representante registrado no cadastro do cliente do pedido. CLIENTE - Cliente / Destinatário - O comissionado para esta regra será o cliente/destinatário do pedido. FORNECEDOR - Fornecedor / Emitente - O comissionado para esta regra será o fornecedor do pedido. TRANSPORTADORA - Transportador - O comissionado para esta regra será o transportador registrado no pedido. EMITENTE - Usuário / Digitador - O comissionado para esta regra será o usuário que cadastrou o pedido. AGENTE - Agente de vendas - Agente de vendas registrado no pedido. TECNICO_RESPONSAVEL - Técnico responsável - A comissão será creditada para o técnico que ficou responsável pelo pedido. DETENTOR_MARCA - Detentor dos direitos da marca - A comissão será paga ao proprietário/detentor dos direitos de exploração, uso, distribuição ou comercialização da respectiva marca do produto. Comissões pagas nessas situações são normalmente chamadas de Royalties. OUTRO - Outro (fixo) - Indica que o comissionado para esta regra é uma determinada pessoa. Quando esta opção for selecionada, a pessoa a ser comissionada deverá ser informada junto com a regra. Valor padrão = VENDEDOR
COMISSIONADO_ID	ID(18)	FK	Comissionado: Pessoa que irá receber o valor da comissão. Somente será informado caso o campo de comissionado informado for "OUTRO" Referência para PESSOAS
EVENTO	OPCAO(20)	Rqd	Quando é creditada: Indica quando a comissão deve ser lançada no conta-corrente do comissionado. Valores permitidos: EMISSAO_PEDIDO - Na emissão do pedido - No momento em que o pedido for emitido, a comissão é calculado e lançada no conta-corrente. ENTREGA_PEDIDO - Entrega do pedido - Os lançamentos das comissões são realizados conforme a quantidade entregue do pedido. EMISSAO_DOC - Na emissão do documento - Os lançamentos das comissões são realizados no momento da emissão do documento. ENTREGA_DOC - Entrega do documento - O lançamento das comissões é realizado no momento em que é registrada a confirmação de recebimento do documento pelo cliente (retorno do canhoto). PAGAMENTO_TITULO - Pagamento do título - O lançamento das comissões ocorre no pagamento de um título. PUBLICACAO_INDICADOR - Publicação do indicador - A comissão será devida no momento que o respectivo indicador de qualidade seja publicado.
ESTABELECIMENTO_ID	ID(18)	FK	Estabelecimento: Quando informado indica que esta regra deve ser aplicada apenas para pedidos/documentos/títulos deste estabelecimento. Referência para ESTABELECIMENTOS
TIPO_PEDIDO_ID	ID(18)	FK	Tipo de pedido: Quando informado, indica que esta regra somente deve ser aplicada para pedidos deste tipo. Referência para TIPOS_PEDIDOS
CATEGORIA_TIPO_PEDIDO	SELECTION_CHECK(20)		Categoria do tipo de pedido: Quando informado, indica que esta regra deve ser aplicada somente para pedidos cujo tipo é de uma destas categorias. Este campo somente pode ser informado quando um tipo de pedido específico não foi informado. Valores permitidos: C - Compra - Tipos de pedidos que irão gerar uma entrada de produtos no estoque. Ex: Ordem de Compra. O - Orçamento - Tipos de pedidos que representam apenas algum tipo de orçamento ou cotação. Estes pedidos não irão movimentar estoque. R - Representação - O tipo de pedido de representação é quando o estabelecimento não é o Fornecedor ou Cliente. S - Pedido de serviço - Define um pedido para prestação de serviço. Ex, consultoria, mão-de-obra, etc. T - Transferência - Pedidos de transferência entre uma filial e sua matriz, ou filial para filial ou matriz para filial. U - Outro - Define um pedido especial. Ex, um pedido interno que não é um pedido de venda nem de compra. V - Venda - Tipos de pedidos que representam uma venda.
PRODUTO_ID	ID(18)	FK	Produto: Quando informada, indica que esta regra deve ser aplicada apenas para um produto específico. Referência para PRODUTOS
TIPO_ITEM_PRODUTO	SELECTION_CHECK(40)		Tipo de item do produto: Quando informado, indica que a comissão é válida apenas para os itens do pedido de produtos deste tipo. Valores permitidos: 00 - Mercadoria para revenda 01 - Matéria-prima 02 - Embalagem 03 - Produto em processo 04 - Produto acabado 05 - Subproduto 06 - Produto intermediário 07 - Material de uso e consumo 08 - Ativo imobilizado 09 - Serviços 10 - Outros insumos 99 - Outros
TIPO_PRODUTO_ID	ID(18)	FK	Tipo de produto: Quando informado indica que esta regra deve ser aplicada apenas para pedidos deste tipo. Referência para TIPOS_PRODUTOS
MARCA_ID	ID(18)	FK	Marca: Quando informada, indica que esta regra deve ser aplicada para todos os produtos desta marca. Referência para MARCAS
FABRICANTE_ID	ID(18)	FK	Fabricante: Quando informado, indica que esta regra deve ser aplicada apenas para produtos deste fabricante. Referência para PESSOAS
EMITENTE_ID	ID(18)	FK	Emitente: Quando informado indica que esta regra deve ser aplicada apenas para pedidos cujo documento/pedido/título seja deste emitente. Referência para PESSOAS
DESTINATARIO_ID	ID(18)	FK	Destinatário: Quando informado indica que esta regra deve ser aplicada apenas para pedidos/documentos/títulos para este destinatário. Referência para PESSOAS
INDICADOR_QUALIDADE_ID	ID(18)	FK	Indicador de qualidade: Utilizado apenas nos casos de regras originadas no cumprimento de metas. Quando informado, determina o indicador de qualidade cuja meta deve estar cumprida para que a comissão seja paga. Referência para INDICADORES_QUALIDADE
PERCENTUAL_META	PERCENT(18)		Percentual da meta: Indica que essa regra de comissionamento é válida apenas quando esse percentual de meta foi atingido. Este atributo é utilizado apenas para regras de comissionamento baseadas em metas (atributo "Indicador de qualidade" está preenchido). O uso deste atributo permite estabelecer diferentes percentuais de comissão de acordo com o alcance da meta. Exemplo: Comissão de 2% quando a meta for atingida (em 100%) Comissão de 1,5% quando realizar 90% da meta Comissão de 1% quando realizar 80% da meta Comissão de 0,5% nos demais casos (quando realizar menos de 80% da meta) Neste caso haveriam 4 regras de comissionamento, vinculadas ao mesmo indicador. Cada uma com percentual de meta diferente. Assim como qualquer outra regra, a sequencia e o grupo são importantes. A menor sequencia deve ser usada para o maior percentual e a menor sequencia sem percentual informado.
CONDICAO	SOURCE_CODE		Condição: Condição adicional para determinar quando a regra é aplicada ou não. Deve ser utilizada em casos de condições complexas onde uso de campos de "filtro" não é suficiente. Nestes casos, a condição deve ser informada através de uma consulta SQL que recebe um único parâmetro "?" que representa um item de pedido cujo comissionamento está sendo avaliado. Caso este SQL retorne linhas, então esta regra deve ser aplicada. ATENÇÃO: O comando SQL pode retornar colunas com valores que serão automaticamente utilizados pela regra. Qualquer atributo da regra pode ser sobrescrito através deste SQL. Isso permite total liberdade na formulação de quem será o comissionado, valores, percentuais, eventos, etc.
VALOR_BASE	OPTION(7)	Rqd	Base da comissão: Indica qual o valor de base a ser utilizado para o cálculo da comissão. Valores permitidos: BRUTO - Valor bruto do item - O valor de base para o cálculo da comissão é o valor bruto do item (quantidade x preço unitário x percentual). LIQUIDO - Valor líquido do item - O valor base é o valor líquido do item (preço bruto - descontos - impostos - frete, etc.). BALANCO - Balanço (do pedido) - O valor de base utilizado para o calculo da comissão é o balanço (rentabilidade) do respectivo processo comercial (pedido). CUSTOM - Customizado - O valor de base para o cálculo da comissão é definido por uma fórmula indicada através de uma expressão SQL informada no campo "Fórmula do valor de base".
EXPRESSAO_VALOR	SOURCE_CODE		Fórmula para valor base: Expressão para calcular o valor da base de calculo para a comissão. Utilizada quando o valor da base de cálculo não é o valor bruto ou o líquido. Deve retornar obrigatoriamente um valor numérico. Este campo é utilizado apenas quando a base de calculo selecionada for "Customizado". Pode ser utilizado o parâmetro "?" para representar o ID de contexto.
ORIGEM_PERCENTUAL	OPTION(12)	Rqd	Percentual: Indica como é definido o percentual de comissão. Valores permitidos: VENDEDOR - Informado no cadastro do vendedor/representante - O percentual de comissão é aquele definido no cadastro do respectivo vendedor/representante. LISTA_PRECOS - Informado no item da lista de preços - O percentual de comissão é o primeiro que estiver informado na seguinte ordem: Item do pedido, item da lista de preços, cadastro do produto ou cadastro do tipo de produto. CLIENTE - Informado no cadastro do cliente - O percentual de comissão é aquele definido no cadastro do respectivo cliente. INFORMADO - Informado (fixo) - O percentual de comissão é definido pela própria regra de comissionamento. Neste caso, o campo "Percetual" deve ser obrigatoriamente preenchido. CUSTOM - Customizado - O percentual de comissão é determinado através de uma fórmula definida através de uma expressão SQL informada na regra.
PERCENTUAL_INFORMADO	PERCENT(18)		Percentual informado: Percentual de comissão a ser aplicado sobre o valor. Este campo somente será informado caso o valor de origem do percentual de comissão seja "Percentual informado".
EXPRESSAO_PERCENTUAL	SOURCE_CODE		Fórmula para percentual: Fórmula que retorna o percentual de comissão a ser gerado. A fórmula deve ser informada através de uma expressão SQL que deve se basear no parâmetro ? que será substituído pelo ID do item de pedido. Esta fórmula é utilizada apenas quando a origem percentual é "Customizado".
CONTROLE	OPCAO(1)	Rqd	Controle: Determina como se deseja fazer o controle das comissões. Valores permitidos: C - Conta corrente - As comissões são apenas lançadas em um conta-corrente. T - Títulos financeiros - As comissões geram títulos (a pagar ou a receber). R - Relatório - As comissões contratadas são apenas controladas pelas regras de comissionamento sem gerar nenhum controle. Neste caso, um relatório deve ser realizado para determinar os valores de comissão a serem pagos. Valor padrão = C
DESCRICAO_LANCAMENTO	TEXT(200)	Rqd	Descrição do lançamento: Descrição a ser utilizada no lançamento do movimento na conta. Macro: ${ref} irá substituir pelo número do pedido, ou número do documento, ou número do título. Valor padrão = ${ref} Exemplos: Comissão referente ao documento: ${ref}
TIPO_CONTA_CORRENTE_ID	ID(18)	FK	Tipo de conta-corrente: Tipo de conta corrente/caixa a ser utilizada nos lançamentos de comissões. Quando uma comissão for gerada, o sistema irá localizar uma conta corrente deste tipo do respectivo comissionado. Caso não encontrada, uma nova conta corrente será automaticamente criada. Caso seja encontrada mais do que uma conta-corrente ativa deste tipo, para a mesma pessoa e para o mesmo estabelecimento, então a mais antiga será utilizada. Referência para TIPOS_CAIXA
HISTORICO_LANCAMENTO_CREDITO_ID	ID(18)	FK	Histórico de lançamento de crédito: Determina o histórico que deve ser utilizado para registrar lançamentos de crédito na conta-corrente. Referência para HISTORICOS
HISTORICO_LANCAMENTO_DEBITO_ID	ID(18)	FK	Histórico de lançamento de débito: Determina o histórico que deve ser utilizado para lançamentos de débito no conta-corrente de comissões. Referência para HISTORICOS
TIPO_TITULO_ID	ID(18)	FK	Tipo de título: Quando o contole de comissões é por título, indica o tipo de título a ser criado. Referência para TIPOS_TITULOS
CONTA_GERENCIAL_ID	ID(18)	FK	Conta gerencial: Quando informado, vincula os registros das comissões criadas a uma conta gerencial. Na prática, quando o controle for por títulos, os títulos criados são vinculados a esta conta gerencial. Referência para CONTA_CONTABIL
ATIVO	FLAG(1)	Rqd	Ativo: Indica se a regra está ativa ou não. Regras inativas são ignoradas pelo sistema. Valor padrão = S

Regras

Calcular comissões para um item de pedido(item_pedido)

Calcula as comissões de um item de pedido. O processamento criar, alterar ou excluir registros de comissões para o item conforme as regras de comissionamento ativas.

Calcular comissões de documento(documento)

Calcula as comissões de um documento, totalizando as comissões dos itens.

Calcular comissões de item de documento(item)

Calcula as comissões de um item de documento:

Comissões do respectivo item de pedido (proporcional qtd documento / qtd item)
Regras para comissões de documento

Calcular comissões do pedido(pedido)

Calcula as comissões do pedido que são resultantes do somatório das comissões dos itens do pedido.

Calcular comissões de título(titulo)

Calcula as comissões de um título:

Comissões dos documentos que geraram o título e que devem ser lançadas no evento PAGAMENTO_TITULO.