Gestão de comissões e royalties

Índice

Regras de comissionamento

COMISSOES.CAD_REGRAS_COMISSIONAMENTO

Descrição

Interface para manutenção de Regra de comissionamento

Campos:

Nome dado para identificar a regra de comissionamento.
Texto livre contendo uma descrição da regra. Meramente informativo.
Define o tipo de operação da comissão.
  • Pagar - A comissão será paga pelo estabelecimento para a pessoa comissionada.
  • Receber - A comissão será cobrada da pessoa comissionada.
Indica quando uma regra de comissionamento pode ser inserida manualmente nos respectivos elementos originadores.
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.
  • Item do pedido - Comissão definida pelo item do pedido. Pode variar conforme o produto.
  • Pedido - As comissões são definidas no pedido. Não pode variar conforme o produto.
  • Item de documento - Comissão definida pelo item do documento. Pode variar conforme o produto.
  • Documento - As comissões são definidas em um documento de entrada ou saída.
  • Título - As comissões são definidas em títulos de um determinado cliente.
  • Cumprimento de metas - As comissões são determinadas a partir do atingimento de determinados valores de indicadores de qualidade.
  • Manual - A contratação da comissão somente pode ser registrada manualmente.
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 para aplicação das regras de um grupo. Deve ser informado apenas quando existir um grupo informado.
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.).
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.
Indica a forma com que a regra será definida.
  • Parametrizada - A regra é definida através de um conjunto de parâmetros que definem filtros e valores utilizados para calcular o parâmetro.
  • SQL - O comissionamento é calculado através de uma expressão SQL que determina os valores e as pessoas comissionados.
Nome (ou código) de identificação do estabelecimento. Na maioria das vezes, apenas os estabelecimentos que o usuário tem acesso estarão disponíveis como opção.
Ex:
  • MATRIZ
  • FILIAL 1
  • FILIAL 2
  • CD-RS
Código (único) de identificação da pessoa (física ou jurídica).
Código (único) de identificação da pessoa (física ou jurídica).
Nome dado para identificar o tipo de pedido.

Os tipos de pedidos são apresentados de acordo com o estabelecimento selecionado.
Ex:
  • VENDA
  • COMPRA
  • AMOSTRA
  • ORDEM_DE_SERVICO
  • PRODUCAO
  • TRANSFERENCIA
  • REPRESENTACAO
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.
  • Compra - Tipos de pedidos que irão gerar uma entrada de produtos no estoque. Ex: Ordem de Compra.
  • Orçamento - Tipos de pedidos que representam apenas algum tipo de orçamento ou cotação. Estes pedidos não irão movimentar estoque.
  • Representação - O tipo de pedido de representação é quando o estabelecimento não é o Fornecedor ou Cliente.
  • Pedido de serviço - Define um pedido para prestação de serviço. Ex, consultoria, mão-de-obra, etc.
  • Transferência - Pedidos de transferência entre uma filial e sua matriz, ou filial para filial ou matriz para filial.
  • Outro - Define um pedido especial. Ex, um pedido interno que não é um pedido de venda nem de compra.
  • Venda - Tipos de pedidos que representam uma venda.
Código de identificação do produto. Calculado automaticamente ou informado conforme parametrização da respectiva engenharia de produto.
Nome da marca.
Ex:
  • COCA-COLA
  • PEPSI
  • FRUKI
Nome dado para identificar o tipo de produto.
Quando informado, indica que a comissão é válida apenas para os itens do pedido de produtos deste tipo.
  • Mercadoria para revenda
  • Matéria-prima
  • Embalagem
  • Produto em processo
  • Produto acabado
  • Subproduto
  • Produto intermediário
  • Material de uso e consumo
  • Ativo imobilizado
  • Serviços
  • Outros insumos
  • Outros
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.
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.
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.
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.
  • Vendedor do pedido - O comissionado para esta regra deve ser o vendedor que está informado no pedido.
  • Vendedor do cliente - O comissionado para esta regra será o vendedor registrado no cadastro do cliente do pedido.
  • Representante do pedido - Pessoa que está informada como representante no pedido.
  • Representante do cliente - O comissionado para esta regra será o representante registrado no cadastro do cliente do pedido.
  • Cliente / Destinatário - O comissionado para esta regra será o cliente/destinatário do pedido.
  • Fornecedor / Emitente - O comissionado para esta regra será o fornecedor do pedido.
  • Transportador - O comissionado para esta regra será o transportador registrado no pedido.
  • Usuário / Digitador - O comissionado para esta regra será o usuário que cadastrou o pedido.
  • Agente de vendas - Agente de vendas registrado no pedido.
  • Técnico responsável - A comissão será creditada para o técnico que ficou responsável pelo pedido.
  • 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 (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.
Código (único) de identificação da pessoa (física ou jurídica).
Indica qual o valor de base a ser utilizado para o cálculo da comissão.
  • 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).
  • Valor líquido do item - O valor base é o valor líquido do item (preço bruto - descontos - impostos - frete, etc.).
  • Balanço (do pedido) - O valor de base utilizado para o calculo da comissão é o balanço (rentabilidade) do respectivo processo comercial (pedido).
  • 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".
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.
Indica como é definido o percentual de comissão.
  • Informado no cadastro do vendedor/representante - O percentual de comissão é aquele definido no cadastro do respectivo vendedor/representante.
  • 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.
  • Informado no cadastro do cliente - O percentual de comissão é aquele definido no cadastro do respectivo cliente.
  • Informado (fixo) - O percentual de comissão é definido pela própria regra de comissionamento. Neste caso, o campo "Percetual" deve ser obrigatoriamente preenchido.
  • 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 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".
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".
Indica quando a comissão deve ser lançada no conta-corrente do comissionado.
  • Na emissão do pedido - No momento em que o pedido for emitido, a comissão é calculado e lançada no conta-corrente.
  • Entrega do pedido - Os lançamentos das comissões são realizados conforme a quantidade entregue do pedido.
  • Na emissão do documento - Os lançamentos das comissões são realizados no momento da emissão do documento.
  • 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 do título - O lançamento das comissões ocorre no pagamento de um título.
  • Publicação do indicador - A comissão será devida no momento que o respectivo indicador de qualidade seja publicado.
Determina como se deseja fazer o controle das comissões.
  • Conta corrente - As comissões são apenas lançadas em um conta-corrente.
  • Títulos financeiros - As comissões geram títulos (a pagar ou a receber).
  • 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.
Tipo de caixa que será utilizado para creditar/debitar comissões.
Apenas tipos de caixa que possuem históricos para lançar créditos/débitos são disponibilizados como opção.
Determina o histórico que deve ser utilizado para registrar lançamentos de crédito na conta-corrente.
Código ou identificação do histórico.
Determina o histórico que deve ser utilizado para lançamentos de débito no conta-corrente de comissões.
Código ou identificação do histórico.
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.
Ex:
  • Comissão referente ao documento: ${ref}
Quando o controle for por títulos, indica o tipo de título a ser criado.
Ex:
  • ESPÉCIE
  • DUPLICATA
  • FATURA
  • RECIBO
  • NOTA PROMISSÓRIA
  • NFE
  • NFS
  • CF
  • DEPÓSITO
  • PIX
  • TED
  • DOC
  • DARF
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.
Indica se a regra está ativa ou não. Regras inativas são ignoradas pelo sistema.

Operações

Topo

Pesquisar

Ao pesquisar, o usuário poderá informar critérios de filtro para listar apenas os registros desejados. Normalmente depois de informar os filtros desejados, o usuário deverá executar a operação [b:Listar].
Obtenha maiores detalhes em Como utilizar a tela de pesquisa?.
Comportamento:Topo

Listar

Apresenta uma lista com os registros que atendem aos filtros informados.
A lista possui diversos recursos práticos e importantes para o usuário:
PagarNãoItem do pedidoConta corrente
ReceberSimPedidoTítulos financeiros
PagarNãoItem de documentoRelatório
ReceberSimDocumentoConta corrente
Topo

Consultar

A consulta de um registro é realizada quando o usuário clica no primeiro link de um dos registros resultantes a operação [b:Listar]. A tela apresenta as informações detalhadas do registro, bem como as ações que o usuário pode disparar a partir dele (alterar, excluir, cancelar, etc.).
Comportamento:Topo

Novo

Permite criar novos registros no sistema. Ao ser executado, o sistema apresenta um formulário com todos os campos do registro que deverão ser preenchidos. Quando todos os campos desejados estiverem preenchidos, clique em [b:Salvar].
Comportamento:Topo

Alterar

A partir da tela de consulta de um registro, esta operação permite alterar os dados do mesmo.
O sistema abre um formulário com os campos editáveis. Após alterar os campos, o usuário deverá clicar em [b:Salvar].
Comportamento:Topo

Excluir

Exclui o registro selecionado. A exclusão do registro pode ser disparada a partir da tela de consulta e/ou de manutenção do mesmo.
O registro somente será excluído se todas as condições necessárias forem encontradas, gerando um erro, caso alguma destas condições não estiver sendo atendida.
Topo

Ativar regras

Habilita o uso das regras de comissionamento. Enquanto as regras de comissionamento não estiverem ativas, a interface ficará emitindo um alerta para o usuário.
Topo

Exportar

Funcionalidade que permite exportar os dados de um bloco.
PagarNãoItem do pedidoParametrizadaMATRIZVENDACompraCOCA-COLAMercadoria para revendaVendedor do pedidoValor bruto do itemInformado no cadastro do vendedor/representanteNa emissão do pedidoConta correnteComissão referente ao documento: ${ref}ESPÉCIENão
ReceberSimPedidoSQLFILIAL 1COMPRAOrçamentoPEPSIMatéria-primaVendedor do clienteValor líquido do itemInformado no item da lista de preçosEntrega do pedidoTítulos financeirosComissão referente ao documento: ${ref}DUPLICATASim
PagarNãoItem de documentoParametrizadaFILIAL 2AMOSTRARepresentaçãoFRUKIEmbalagemRepresentante do pedidoBalanço (do pedido)Informado no cadastro do clienteNa emissão do documentoRelatórioComissão referente ao documento: ${ref}FATURANão
ReceberSimDocumentoSQLCD-RSORDEM_DE_SERVICOPedido de serviçoCOCA-COLAProduto em processoRepresentante do clienteCustomizadoInformado (fixo)Entrega do documentoConta correnteComissão referente ao documento: ${ref}RECIBOSim
Topo

Importar

Funcionalidade que permite importar dados para o bloco desejado.

Regras

Ajustar campo categoria do tipo de pedido

Caso informado um tipo de pedido, o campo de categoria do tipo de pedido não deve ser apresentado, caso contrário, deve ser apresentado.
Eventos que disparam esta regra:
  • Antes de apresentar cada registro formulário "Alterar"
  • Ao alterar campo "Tipo de pedido" do formulário "Alterar"
  • Ao alterar campo "Tipo de pedido" do formulário "Novo"

Ajustar campo conforme o valor de base

Caso o valor de base seja "CUSTOM", deve apresentar o campo "Fórmula para valor base" como requerido, caso contrário, o campo nem deve ser visível.
Eventos que disparam esta regra:
  • Antes de apresentar cada registro formulário "Alterar"
  • Antes de apresentar uma tela formulário "Novo"
  • Ao alterar campo "Valor base da comissão" do formulário "Alterar"
  • Ao alterar campo "Valor base da comissão" do formulário "Novo"

Ajustar campo da pessoa comissionada

Quando o comissionado for "OUTRO", então o campo "Pessoa comissionada" deve ser visível e de preenchidmento requerido, caso contrário, o campo não deve ser visível.
Eventos que disparam esta regra:
  • Antes de apresentar cada registro formulário "Alterar"
  • Antes de apresentar uma tela formulário "Novo"
  • Ao alterar campo "Comissionado" do formulário "Alterar"
  • Ao alterar campo "Comissionado" do formulário "Novo"

Ajustar campos conforme controle

Quando o controle for por conta-corrente, apresenta os campos de definição do lançamento. Quando o controle for por título, apresenta o tipo de título.
Eventos que disparam esta regra:
  • Antes de apresentar cada registro formulário "Alterar"
  • Antes de apresentar cada registro formulário "Consultar"
  • Ao alterar campo "Controle" do formulário "Alterar"
  • Ao alterar campo "Controle" do formulário "Novo"

Ajustar campos conforme grupo

Caso o grupo não estiver informado, não é necessário informar sequencia. Caso informar um grupo, o campo sequencia deve ser obrigatoriamente preenchido
Eventos que disparam esta regra:
  • Antes de apresentar cada registro formulário "Alterar"
  • Antes de apresentar uma tela formulário "Novo"
  • Ao alterar campo "Grupo" do formulário "Alterar"
  • Ao alterar campo "Grupo" do formulário "Novo"

Ajustar campos conforme origem da comissão

Se a origem da comissão é no item do pedido, apresenta os campos relacionados aos itens de pedidos e pedidos.
Se a origem da comissão é no pedido, apresenta os campos relacionados aos pedidos.
Se a origem da comissão é no documento, apresenta apenas os campos relacionados a documentos.
Eventos que disparam esta regra:
  • Antes de apresentar cada registro formulário "Alterar"
  • Antes de apresentar uma tela formulário "Novo"
  • Ao alterar campo "Origem" do formulário "Alterar"
  • Ao alterar campo "Origem" do formulário "Novo"

Ajustar campos conforme percentual escolhido

Caso o percentual escolhido seja "CUSTOM", então campo "Fórmula para o percentual" deve ser apresentado e obrigatório, caso contrário, nem deve ser apresentadp.
Caso o percentual escolhido seja "INFORMADO", então campo "Percentual informado" deve ser apresentado e obrigatório, caso contrário, nem deve ser apresentadp.
Eventos que disparam esta regra:
  • Antes de apresentar cada registro formulário "Alterar"
  • Antes de apresentar uma tela formulário "Novo"
  • Ao alterar campo "Percentual" do formulário "Alterar"
  • Ao alterar campo "Percentual" do formulário "Novo"

Ajustar campos do produto

Caso um produto específico seja informado, não faz sentido apresentar os campos "Tipo de item", "Marca", "Fabricante" e "Tipo de produto".
Eventos que disparam esta regra:
  • Antes de apresentar cada registro formulário "Alterar"
  • Ao alterar campo "Produto" do formulário "Alterar"
  • Ao alterar campo "Produto" do formulário "Novo"

Alertar que não está usando regras de comissionamento

Caso o sistema não esteja configurado para utilizar regras de comissionamento (preferencia COMISSOES.USA_REGRAS_COMISSIONAMENTO), apresenta um alerta.
Eventos que disparam esta regra:
  • Antes de apresentar uma tela formulário "Pesquisar"

Popular históricos para conta-corrente

Popula as opções de históricos de conta-corrente compatíveis com o respectivo tipo de conta-corrente.
Eventos que disparam esta regra:
  • Antes de apresentar cada registro formulário "Alterar"
  • Antes de apresentar cada registro formulário "Novo"
  • Ao alterar campo "Tipo de caixa" do formulário "Alterar"
  • Ao alterar campo "Tipo de caixa" do formulário "Novo"

Popular regras

Popula apenas as regras que podem ser incluídas manualmente neste escopo.
Eventos que disparam esta regra:
  • Antes de apresentar uma tela formulário "Novo"

Verificar se job está criado e ativo

Caso o controle da regra for por conta corrente é necessário que exista um job para lançar os movimentos periodicamente. Caso o job não exista ou esteja inativo deve apresentar uma mensagem e orientações para ativar/criar o mesmo.
Eventos que disparam esta regra:
  • Depois de alterar formulário "Alterar"
  • Depois de inserir formulário "Novo"