Identificador de Regra

COM-000ALISS01

Módulo: COM - Comercial.

Finalidade: Alterar o percentual, valor e a base de ISS quando é feito um cálculo do mesmo.

Características: Chamado sempre que um item de serviço executar um cálculo do valor do ISS. A regra não é chamada se o item não calcular o valor de ISS, ou seja, caso exista algum parâmetro que faça com que o sistema não calcule ISS, a regra também não será chamada.

A partir da versão 5.5.2.7 foram adicionadas as variáveis VSPERCRT, VSPERPIT, VSPERCSL e VSPEROUR para representar respectivamente os percentuais de Cofins [PerCrt], PIS [PerPit], CSLL [PerCsl] e Outras Retenções [PerOur].

A partir da versão 5.8.2.1, o identificador foi alterado para permitir retornar o valor de dedução através da variável VSVLRDED, caso a base de calculo para o ISS foi alterada e não foi informado um valor de dedução, o ERP vai calcular o valor de dedução comparando o valor base de ISS original com o valor base de ISS retornado da regra.

Tela: Notas Fiscais de Entrada e Saída, Pedidos e Ordens de Compra

Transação: Utiliza a Transação de Serviço

Funcionamento do identificador de regras nas interfaces mapeadas, com suas operações e retornos:

Inserção

Descrição	F120GPC	F120GPD	Web service SimularPedido	Web service GravarPedido	F140GNF
Executa identificador na inserção³ Ver considerações abaixo	Sim	Sim	Sim	Sim	Sim
Sistema acata valores devolvidos pela regra	Sim	Sim	Sim	Sim	Sim
Identificador disponibiliza tabelas de pedido para consulta com campo de usuário	Sim	Sim	Sim	Sim	Não
Calcula com base no percentual devolvido pela regra²Ver considerações abaixo	Não	Não	Não	Sim	Não

Alteração

Descrição	F120GPC	F120GPD	Web service SimularPedido	Web service GravarPedido	F140GNF
Executa identificador na alteração	Sim	Sim	Operação inexistente	Sim	Sim
Sistema acata valores devolvidos pela regra	Sim	Sim	Operação inexistente	Sim	Sim
Identificador disponibiliza tabelas de pedido para consulta com campo de usuário	Sim	Sim	Operação inexistente	Sim	Não
Calcula com base no percentual devolvido pela regra²Ver considerações abaixo	Não	Não	Operação inexistente	Sim	Não

Recálculo

Descrição	F120GPC	F120GPD	Web service SimularPedido	Web service GravarPedido	F140GNF
Executa identificador no recálculo	Sim	Sim	Operação inexistente	Operação inexistente	Sim
Sistema acata valores devolvidos pela regra	Sim	Sim	Operação inexistente	Operação inexistente	Sim
Identificador disponibiliza tabelas de pedido para consulta com campo de usuário	Sim	Regra¹Ver considerações abaixo	Operação inexistente	Operação inexistente	Não
Calcula com base no percentual devolvido pela regra²Ver considerações abaixo	Não	Não	Operação inexistente	Operação inexistente	Não

Fechamento

Descrição	F120GPC	F120GPD	Web service SimularPedido	Web service GravarPedido	F140GNF
Executa identificador no fechamento	Sim	Sim	Operação inexistente	Sim	Não
Sistema acata valores devolvidos pela regra	Sim	Sim	Operação inexistente	Sim	Não
Identificador disponibiliza tabelas de pedido para consulta com campo de usuário	Sim	Regra¹Ver considerações abaixo	Operação inexistente	Sim	Não
Calcula com base no percentual devolvido pela regra²Ver considerações abaixo	Não	Não	Operação inexistente	Sim	Não

Considerações:

¹ Regra: Nesses cenários, não será possível acessar os campos das Tabelas de Dados Gerais e Itens de Serviço do Pedido por meio do formato Tabela.Campo. É necessário criar um cursor para as Tabelas E120PED e E120ISP para buscar valores dos campos nativos e/ou de usuário.

² Calcula com base no percentual devolvido pela regra: Nesses cenários o sistema não calcula o Valor de ISS com base no percentual devolvido pela regra. É necessário retornar os três valores referentes ao ISS, nas variáveis "VSVlrBis", "VSVlrIss" e "VSPerIss" da regra. O sistema acatará os valores retornados. Atenção! Se for retornado apenas valor para o campo PerIss, o sistema não calcula o novo valor de ISS com base no novo percentual, apenas acata esse percentual.

³ Executa identificador na inserção: Se na inserção do Item de Serviço não é sugerido um Percentual de ISS pelo sistema, então a Base, o Valor e o Percentual de ISS são enviados com valor Zero (0) para Regra. Nesse cenário, sugere-se calcular a Base do ISS por meio do mesmo cálculo efetuado pelo sistema: (VlrBru - (VlrDsc + VlrDs1 + VlrDs2 + VlrDs3 + VlrDs4 + VlrDs5));

Regra:

Exemplo de regra:

Trata diversos cenário das rotinas de pedido.
Acessa campos de usuário dos Dados Gerias e Itens de Serviço do Pedido de uma base de dados. Caso esses campos não existam na base de dados, o sistema apresentará erro ao compilar e/ou executar a regra, por isso é importante adaptar a regra para a base de dados em que for aplicada.
Trata de forma genérica o calculo de ISS para as demais rotinas que não sejam Pedido.

/*
Definição da Variável relativa a Origem da Chamada do Identificador de Regras.
Valore Possíveis:
PED = Pedido;
NFS = Nota Fiscal de Saída;
OCT = Orçamento;
NFE = Nota Fiscal de Entrada;
OCP = Ordem de Compra.
*/
Definir Alfa VSOrigem;

/*
Definição das Variáveis relativas as Chaves do Documento de Origem.
*/
Definir Numero VSCodEmp;
Definir Numero VSCodFil;
Definir Numero VSNumero;
Definir Numero VsSeqIte;

/*
Definição das Variáveis relativa aos campos de Percentual, Base e Valor de ISS.
O Valor dessas variáveis é devolvido para o sistema.
*/
Definir Numero VSPerIss;
Definir Numero VSVlrIss;
Definir Numero VSVlrBis;

/*
Definição das Variáveis de Valores Diversos do Item do Documento de Origem.
*/
Definir Numero VSVlrBru;
Definir Numero VSPerDsc;
Definir Numero VSPerDs1;
Definir Numero VSPerDs2;
Definir Numero VSPerDs3;
Definir Numero VSPerDs4;
Definir Numero VSPerDs5;

/*
Definição das Variáveis relativas a Disponibilidade das Tabelas de Pedido em Regra.
*/
Definir Alfa VSDisp_E120Ped;
Definir Alfa VSDisp_E120Isp;

/*
Definição das Variáveis de Uso Genérico.
Essas variáveis são utilizadas apenas na função EntradaValor.
*/
Definir Alfa PRETALFA;
Definir Numero PRETNUM;
Definir Numero PTIPSAI;
Definir Alfa xValorCampoUsuarioPed;
Definir Alfa xValorCampoUsuarioItem;

Definir Funcao Carregar_CamposUsuario();
Definir Funcao Carregar_CamposUsuario_Banco();
Definir Funcao Tratar_SugestaoIss();
Definir Funcao Tratar_InsercaoPercentualZero();
Definir Funcao Tratar_CalculoIss();

/*
ENTRADAVALOR("Digite o Percentual de ISS:", "Digite o Percentual:",2, "ZZ9,999", "1", 1, PRETALFA, PRETNUM, PTIPSAI);
SE (PTIPSAI = 1)
INICIO
  VSPerIss = PRETNUM;
  
  SE (VSVLRBIS = 0)
  Inicio
    VSVLRBIS = (VSVlrBru - (VSPerDsc + VSPerDs1 + VSPerDs2 + VSPerDs3 + VSPerDs4 + VSPerDs5)); 
  Fim;
  
  VSVLRISS = (VSVLRBIS * (VSPerIss / 100));
FIM;
*/

Se (VsOrigem = "PED")
Inicio
  Carregar_CamposUsuario();
  Tratar_SugestaoIss();
  Tratar_InsercaoPercentualZero();
  Tratar_CalculoIss();
Fim
SeNao
Inicio
  Tratar_InsercaoPercentualZero();
  Tratar_CalculoIss();
Fim;

x = y;

Funcao Carregar_CamposUsuario(); 
Inicio
  Se ((VSDisp_E120Ped = "S") E (VSDisp_E120Isp = "S"))
  Inicio
    xValorCampoUsuarioPed  = E120PED.Usu_Teste;
    xValorCampoUsuarioItem = E120ISP.Usu_CodPro;      
  Fim
  SeNao
  Inicio
    Carregar_CamposUsuario_Banco();
  Fim;
Fim;

Funcao Carregar_CamposUsuario_Banco(); 
Inicio
  Definir Alfa xSql;
  Sql_Criar(xCursor);
  xSql = "SELECT E120PED.USU_TESTE, E120ISP.Usu_CodPro " + 
         "  FROM E120PED, E120ISP      " +
         " WHERE E120PED.CODEMP = E120ISP.CODEMP " +
         "   AND E120PED.CODFIL = E120ISP.CODFIL " +
         "   AND E120PED.NUMPED = E120ISP.NUMPED " +
         "   AND E120PED.CODEMP = :VSCODEMP      " +
         "   AND E120PED.CODFIL = :VSCODFIL      " +
         "   AND E120PED.NUMPED = :VSNUMPED      " +
         "   AND E120ISP.SEQISP = :VSSEQITE";
  Sql_DefinirComando(xCursor, xSql);
  Sql_DefinirInteiro(xCursor, "VSCODEMP", VSCodEmp);
  Sql_DefinirInteiro(xCursor, "VSCODFIL", VSCodFil);
  Sql_DefinirInteiro(xCursor, "VSNUMPED", VSNumero);
  Sql_DefinirInteiro(xCursor, "VSSEQITE", VSSeqIte);
  Sql_AbrirCursor(xCursor);
  Se(Sql_EOF(xCursor) = 0)
  Inicio
    Sql_RetornarAlfa(xCursor, "USU_Teste", xValorCampoUsuarioPed);
    Sql_RetornarAlfa(xCursor, "Usu_CodPro", xValorCampoUsuarioItem);
  Fim;
  Sql_FecharCursor(xCursor);
  Sql_Destruir(xCursor);
Fim;

Funcao Tratar_SugestaoIss();
Inicio
  Se (xValorCampoUsuarioPed = "50") 
  Inicio
    VSPerIss = 50; 
  Fim
  SeNao
  Inicio
    VSPerIss = 25;
  Fim;
Fim;

Funcao Tratar_InsercaoPercentualZero();
Inicio
  /*
  Tratamento do cenário especifico que acontece na inserção de um registro, 
  quando não existe Percentual de ISS sugerido ao item. 
  
  Nesse cenário, o sistema não calcula a Base e o Valor de ISS, ou seja, 
  esses valores estão zerados na Regra. 
  Por isso, a base deve ser montada e o valor deve ser calculado de forma manual. 
  Os três campos devem ser retornados ao sistema (VSPerIss, VSVlrBis, VSVlrIss).
  */
  
  SE (VsVlrBis = 0)
  Inicio
    VsVlrBis = (VSVlrBru - (VSPerDsc + VSPerDs1 + VSPerDs2 + VSPerDs3 + VSPerDs4 + VSPerDs5)); 
  Fim;
Fim; 

Funcao Tratar_CalculoIss();
Inicio
  VSVlrIss = (VsVlrBis * (VSPerIss / 100));
Fim;

Variáveis Disponibilizadas:

Nome	Tipo	Observações	Retorna Valor
VSORIGEM	ALFA	Origem da chamada da Regra (PED - Pedido, NFS - Nota Fiscal Saída, OCP - Ordem de Compra, NFE - Nota Fiscal Entrada, OCT - Orçamento)	N
VSCODEMP	INTEIROS	Código da Empresa	N
VSCODFIL	INTEIROS	Código da Filial	N
VSCODSNF	ALFA	Código da Série, só existe se VSOrigem = NFS e NFE	N
VSNUMERO	NÚMERO	Número do Documento gerado de acordo com a origem	N
VSSEQITE	NÚMERO	Sequência do Item	N
VSDATA	DATA	Data de Entrada para a NF Entrada e Data de Emissão para os outros processos.	N
VSTNSSER	ALFA	Transação de Serviço do item	N
VSCLIFOR	NÚMERO	Código do Cliente ou Fornecedor de acordo com a origem	N
VSCODSER	ALFA	Código do Serviço	N
VSCODFAM	ALFA	Código da Família	N
VSPREUNI	NÚMERO	Preço unitário do serviço	N
VSPERDSC	NÚMERO	Percentual de desconto do serviço	N
VSPERIRF	NÚMERO	Percentual do IRRF do serviço	N
VSVLRENC	NÚMERO	Valor encargos financeiros	N
VSVLROUT	NÚMERO	Valor outras despesas	N
VSVLRDAR	NÚMERO	Valor para arredondamento	N
VSVLRBRU	NÚMERO	Valor bruto do serviço	N
VSVLRDSC	NÚMERO	Valor do desconto do serviço	N
VSVLRDS1	NÚMERO	Valor do desconto-1	N
VSVLRDS2	NÚMERO	Valor do desconto-2	N
VSVLRDS3	NÚMERO	Valor do desconto-3	N
VSVLRDS4	NÚMERO	Valor do desconto-4	N
VSVLRBIR	NÚMERO	Valor base IRRF	N
VSVLRIRF	NÚMERO	Valor do IRRF sobre o serviço	N
VSVLRLSE	NÚMERO	Valor do serviço	N
VSVLRLOU	NÚMERO	Valor dos outros valores	N
VSVLRLIQ	NÚMERO	Valor líquido do item de serviço	N
VSVLRFIN	NÚMERO	Valor do item válido para o financeiro	N
VSPERIPI	NÚMERO	Percentual de IPI do item	N
VSPERICM	NÚMERO	Percentual do ICM do item	N
VSVLRDZF	NÚMERO	Valor do desconto referente zona franca	N
VSVLRBIP	NÚMERO	Valor base IPI	N
VSVLRIPI	NÚMERO	Valor do IPI do item	N
VSVLRBIC	NÚMERO	Valor base ICMS	N
VSVLRICM	NÚMERO	Valor do ICMS do item	N
VSVLRBSI	NÚMERO	Valor base ICMS substituído	N
VSVLRICS	NÚMERO	Valor do ICMS substit. do item	N
VSPERINS	NÚMERO	Percentual do INSS	N
VSVLRINS	NÚMERO	Valor do INSS	N
VSVLROUD	NÚMERO	Valor outras despesas destacado	N
VSVLRBIN	NÚMERO	Valor base do INSS	N
VSFILPEDNFV	NÚMERO	Filial do pedido do item da nota fiscal	N
VSNUMPEDNFV	NÚMERO	Número do pedido do item da nota fiscal	N
VSSEQISPNFV	NÚMERO	Seqüencia do item de serviço do pedido da nota fiscal de saída	N
VSQTDITE	NÚMERO	Quantidade do Item (Qtdade.Aberta quando VSOrigem = "PED" ou "OCP", Qtdade.Recebida quando VSOrigem = "NFE" e Qtdade.Faturada quando VSOrigem = "NFS")	N
VSFORISS	NÚMERO	Código do fornecedor p/ geração do título de ISS	N
VSSEQIPDNFV	NÚMERO	Sequência do item de produto do pedido	N
VSPERCRT	NÚMERO	Percentual de Cofins	N
VSPERPIT	NÚMERO	Percentual de PIS	N
VSPERCSL	NÚMERO	Percentual de CSLL	N
VSPEROUR	NÚMERO	Percentual de Outras Retenções	N
VSVLRDED	NÚMERO	Valor de Dedução	S
VSPERISS	NÚMERO	Percentual do ISS do serviço	S
VSVLRISS	NÚMERO	Valor do ISS sobre o serviço	S
VSVLRBIS	NÚMERO	Valor base ISS	S
VSREDISS	NÚMERO	Percentual de Redução do Valor Base ISS	S
VSDisp_E120Ped	ALFA	Variável responsável por indicar para a regra se a Tabela dos Dados Gerais do Pedido está disponível para ser acessada por meio do formato Tabela.Campo(E120PED.Campo). Quando a variável estiver igual a "S", indica que é possível acessar os campos da tabela dos Dados Gerais (incluindo campos de usuário) diretamente, sem cursor. Quando a variável estiver igual a "N", indica que não é possível acessar os campos da tabela dos Dados Gerais diretamente sem cursor. Quando a variável estiver igual a "N", caso for utilizada a Tabela dos Dados Gerais do Pedido, no formato Tabela.Campo, o sistema apresentará erro, ou seja, quando esse campo está com valor igual a "N" não deve ser feito o acesso utilizando o formato Tabela.Campo. Essa variável está disponível a partir das versões 5.10.3.83 e 5.10.4.29.	N
VSDisp_E120Isp	ALFA	Variável responsável por indicar para a regra se a Tabela de Item de Serviço do Pedido está disponível para ser acessada por meio da Tabela.Campo(E120ISP.Campo). Quando a variável estiver igual a "S", indica que é possível acessar os campos da Tabela do Item de Serviço do Pedido (incluindo campos de usuário) diretamente sem cursor. Quando a variável estiver igual a "N", indica que não é possível acessar os campos da Tabela do Item de Serviço do Pedido diretamente sem cursor. Quando a variável estiver igual a "N", caso for utilizada a Tabela do Item de Serviço do Pedido, no formato Tabela.Campo, o sistema apresentará erro, ou seja, quando esse campo está com valor igual a "N" não deve ser feito o acesso utilizando o formato Tabela.Campo. Essa variável está disponível a partir das versões 5.10.3.83 e 5.10.4.29.	N
CPRNRAICLF	NÚMERO	Código RAIS do fornecedor (disponível para a Nota Fiscal de Entrada)	N
CPRNCODRAI	NÚMERO	Código RAIS do documento (disponível para a Nota Fiscal de Entrada). Essa variável é preenchida com a informação definida no Código da Cidade ISS.	N
CprNOldVlrIss	NÚMERO	Valor do ISS antes deste ser recalculado. Esta variável está disponível apenas no web service de notas fiscais de entrada.	N
CprNOldVlrBis	NÚMERO	Número - Valor base do ISS antes deste ser recalculado. Esta variável está disponível apenas no web service de notas fiscais de entrada.	N
CprNOldPerIss	NÚMERO	Número - Percentual do ISS antes deste ser recalculado. Esta variável está disponível apenas no web service de notas fiscais de entrada.	N
CprNOldRedIss	Número	Valor de redução do ISS antes deste ser recalculado. Esta variável está disponível apenas no web service de notas fiscais de entrada.	N
VSDisp_E140Nfv	ALFA	A variável é responsável por indicar à regra se a tabela dos Dados Gerais da Nota Fiscal de Saída está disponível para acesso por meio do formato Tabela.Campo (E140NFV.Campo). Quando configurada com o valor "S", permite acessar os campos da tabela dos Dados Gerais, incluindo campos de usuário, diretamente, sem o uso de cursor. Quando configurada com o valor "N", não é possível acessar os campos da tabela diretamente sem cursor. Caso a tabela dos Dados Gerais da Nota Fiscal seja utilizada no formato Tabela.Campo enquanto a variável estiver com o valor "N", o sistema apresentará um erro. Assim, quando esse campo estiver com valor "N", o acesso utilizando o formato Tabela.Campo não deve ser realizado. Essa variável está disponível a partir das versões 5.10.3.94 e 5.10.4.40.	N
VSDisp_E140Isv	ALFA	A variável é responsável por indicar à regra se a Tabela de Item de Serviço da Nota Fiscal de Saída está disponível para acesso por meio do formato Tabela.Campo (E140ISV.Campo). Quando configurada com o valor "S", permite acessar os campos da Tabela de Item de Serviço da Nota Fiscal de Saída, incluindo campos de usuário, diretamente, sem o uso de cursor. Quando configurada com o valor "N", indica que não é possível acessar os campos da tabela diretamente sem cursor. Caso a tabela de Item de Serviço da Nota Fiscal de Saída seja utilizada no formato Tabela.Campo enquanto a variável estiver com o valor "N", o sistema apresentará um erro. Assim, quando essa variável estiver com o valor "N", o acesso utilizando o formato Tabela.Campo não deve ser realizado. Essa variável está disponível a partir das versões 5.10.3.94 e 5.10.4.40.	N

Importante

A variável VSREDISS retorna valor, porém o percentual alterado não é aplicado automaticamente ao Valor Base ISS. A alteração do Valor Base ISS e do Valor do ISS deve ser feita via regra.
A partir das versões 5.10.3.83 e 5.10.4.29 o identificador de regras disponibiliza a Tabela de Dados Gerais do Pedido e Item de Serviço do Pedido para consulta. As tabelas podem ser acessadas apenas quando as variáveis VSDisp_E120Ped e VSDisp_E120Isp estiverem iguais a "S", conforme segue:
- Quando a variável VSDisp_E120Ped estiver igual a "S", terá acesso a Tabela dos Dados Gerias (E120PED) em regra para consulta dos campos (de usuário ou não) dessa tabela;
- Quando a Variável VSDisp_E120Isp estiver igual a "S", terá acesso a Tabela de Itens de Serviço do Pedido (E120ISP) em regra para consulta dos campos (de usuário ou não) dessa tabela.

Atenção

Caso o parâmetro global LisVarReg esteja habilitado, a variável ListaVariaveis estará disponível em todos os identificadores de regras do sistema. O conteúdo desta variável lista os campos disponibilizados no identificador de regras em questão.

Não é aconselhada a ativação desse parâmetro global para o uso cotidiano. Esse recurso de listagem dos campos de identificadores auxilia a construção de regras e o Suporte para, por exemplo, depuração ou quando não houver acesso à documentação dos identificadores de regras.

PORTAL DE DOCUMENTAÇÃO
Gestão Empresarial \| ERP - versão 5.10.4 (XTended)