Essa é uma revisão anterior do documento!



Manual de fórmulas

As fórmulas servem para dar maior flexibilidade ao sistema, e através delas podem ser feitos vários ajustes e automatizações.

A sintaxe da fórmula foi desenvolvida da forma mais simples possível, afim de possibilitar que usuários menos experientes consigam desenvolver suas fórmulas.

Sintaxe

Declaração

As variáveis são declaradas automaticamente pelo compilador, que assume como tipo de dados o primeiro valor atribuído à mesma.

Estrutura condicional: 

se expressão lógica
  bloco de código executado se a expressão lógica for verdadeira
senao
  bloco de código executado se a expressão lógica for falsa
fimse

Estrutura de laço: 

percorra objeto
  bloco de código executado enquanto houver objetos
fimpercorra

Nota: A estrutura de laço atualmente só funciona para o objeto dependente e para formulas da folha.

Operadores aritméticos: 

+ Adição
- Subtração
* Multiplicação
/ Divisão

Operadores lógicos: 

>  Maior
<  Menor
>= Maior ou igual
<= Menor ou igual
<> Diferente

Agrupadores lógicos: 

e  => Exemplo: a = b e c > d
ou => Exemplo: a > b ou c <= d

Tipos de dados: 

Numérico => Exemplos: 3 ; 45.08
Caracter => Exemplo: 'abc'
Lógico   => Exemplos: verdadeiro ; falso
Data ( Formatos: {dd/mm/aaaa} ou {d/m/aaaa} ) => Exemplos: {25/04/2008} ; {1/1/2008}

Variáveis

Fórmulas gerais

Nome Tipo Descrição
resultado lógico/numérico Resultado da fórmula
dataAtual Data Data atual

Fórmulas específicas para o layout

Nome Tipo Descrição
registroAtual caracter Linha atual do layout
valorAtual caracter valor que está sendo processado ( apenas retorno do layout )

Fórmulas específicas para a folha

Nome Tipo Descrição
pisoSalarial numérico Piso salarial do colaborador
valorInformado numérico Valor informado no evento
salarioMinimo numérico Salário mínimo vigente
salarioMes numérico Salário contratual mês do funcionário
salarioDia numérico Salário contratual dia do funcionário
salarioHora numérico Salário contratual hora do funcionário
salarioBaseMes numérico Salário base mês do funcionário
salarioBaseDia numérico Salário base dia do funcionário
salarioBaseHora numérico Salário base hora do funcionário
horasMes numérico Carga horária mensal
horasSemana numérico Carga horária semanal
horasDsr numérico Carga horária de descanso remunerado
NumFeriados numérico Quantidade de feriados no mes
numDsr numérico Quantidade de dsr no mês
valorSemana1 numérico Quantidade de dsr da primeira semana
feriadoSemana1 numérico Quantidade de feriado da primeira semana
valorSemana2 numérico Quantidade de dsr da segunda semana
feriadoSemana2 numérico Quantidade de feriado da segunda semana
valorSemana3 numérico Quantidade de dsr da terceira semana
feriadoSemana3 numérico Quantidade de feriado da terceira semana
valorSemana4 numérico Quantidade de dsr da quarta semana
feriadoSemana4 numérico Quantidade de feriado da quarta semana
valorSemana5 numérico Quantidade de dsr da quinta semana
feriadoSemana5 numérico Quantidade de feriado da quinta semana
totalVantagens numérico Total de vantagens
totalDescontos numérico Total de descontos
totalLiquido numérico Total líquido
baseInssNormal numérico Base de cálculo de INSS
BaseInssFerias numérico Base de cálculo de INSS sobre férias
baseInssDecimo numérico Base de cálculo de INSS sobre 13º salário
basePrevEspecialNormal numérico Base de cálculo de Previdência especial
basePrevEspecialFerias numérico Base de cálculo de Previdênvia especial sobre férias
basePrevEspecialDecimo numérico Base de cálculo de Previdência especial sobre 13º salário
baseIrrfNormal numérico Base de cálculo de IRRF
baseIrrfFerias numérico Base de cálculo de IRRF sobre férias
baseIrrfDecimo numérico Base de cálculo de IRRF sobre 13º salário
baseFgtsNormal numérico Base de cálculo de FGTS
baseFgtsDecimo numérico Base de cálculo de FGTS sobre 13º salário
baseSalarioFamilia numérico Base de cálculo do salário família
baseRais numérico Remuneração base para a RAIS
dtProcInicio data Data início do período de processamento
dtProcFim data Data final do período de processamento
qtdDependenteIR numérico Quantidade de dependentes de IRRF
qtdDependenteSF numérico Quantidade de dependentes de salário família
quotasPensao Numérico Quantidade de quotas para cálculo de pensão
competenciaMes numérico Mês da competência atual
competenciaAno numérico Ano da competência atual
diasUteis numérico Variável leva em consideração data de admissão no período ou data de demissão e no final é subtraída da variável diasNaoUteis
diasNaoUteis numérico Variável que retorna o número de dias não úteis levando em consideração os feriados inclusive
diasCalculo numérico Número de dias para cálculo da folha, dependendo dos parâmetros pode ser o número de dias do mês ou 30 (trinta dias)
diasMes numérico Número de dias do mês
diasAfastado numérico Número de dias afastado no período
diasTrabalhados numérico Número de dias trabalhados no período
diasLicencaMaternidade numérico Dias em licença maternidade no período
diasAtestado numérico Dias de atestado médico no período
diasFerias numérico Dias em gozo de férias no período processado
diasGozo numérico Número de dias de gozo das férias
retornoDeFerias lógico Indica se o colaborador está retornando de férias no período processado
abonoPecuniario lógico Indica se o colaborador de férias vendeu 1/3 de suas férias
processamento carácter Código do processamento atual:

fer – Férias;
res – Rescisão;
adt – Adiantamento;
sem – Folha semanal;
qui – Folha quinzenal;
a13 – Adiantamento de 13° salário;
f13 – Folha de 13° salário;
c13 – Folha complemento de 13° salário;
fol – Folha mensal; \\cfo – Folha complementar

Fórmulas específicas para integrações

Nome Tipo Descrição
competenciaMes numérico Mês da competência de geração
competenciaAno numérico Ano da competência de geração
dataPgtoMes numérico Mês da competência do processo
dataPgtoAno numérico Ano da competência do processo

Funções

Fórmulas gerais

Nome Parâmetros Tipo de retorno Descrição
maximo valor1 numérico
…
valorN numérico 		numérico Maior valor entre os valores informados
minimo valor1 numérico
…
valorN numérico 		numérico Menor valor entre os valores informados
media valor1 numérico
…
valorN numérico 		numérico Média aritmética dos valores informados
modulo dividendo numérico
divisor numérico 		numérico Módulo de uma divisão
inteiro valor numérico numérico Parte inteira de um decimal
arredondar valor numérico numérico Arredonda para 2 casas decimais
dia dataX data numérico Captura o dia de uma data
mes dataX data numérico Captura o mês de uma data
ano dataX data numérico Captura o ano de uma data
idade dataNasc data numérico Idade (data de nascimento até a data atual)
idadeDataBase dataNasc data
dataReferência data 		numérico Idade (data de nascimento até uma data de referência)
somaDia dataX data
dias numérico 		data Adiciona dias a uma data
somaMes dataX data
meses numérico 		data Adiciona meses a uma data
somaAno dataX data
anos numérico 		data Adiciona anos a uma data
dataParaTexto dataX carácter Converte data em carácter
textoParaData caracter data Converte texto para data ( data válida ) conforme especificação acima
numeroParaTexto numérico carácter Converte número para texto
textoParaNumero carácter numérico Converte texto para número
subTexto carácter
valor1 numérico(inteiro)
valor2 numérico(inteiro) 		carácter Retorna um pedaço do texto especificado no primeiro parâmetro iniciando do segundo parâmetro e terminando após x caracteres passado no terceiro parâmetro
tamanho carácter numérico Retorna o tamanho do texto passado com parâmetro
nomeMes Numérico Carácter Retorna o nome do mês
contido Str1 Carácter
Str2 Carácter 		Lógico Retorna verdadeiro se str1 estiver contido em str2
diasEntre Data1 data
Data2 data 		numérico Retorna o número de dias entre duas datas
mesesEntre Data1 data
Data2 data 		numérico Retorna o número de meses entre duas datas

Fórmulas específicas para a folha

Nome Parâmetros Tipo de retorno Descrição
valorCalculado evento1 carácter
…
eventoN carácter 		numérico Valor de um evento calculado
referenciaCalculado evento carácter numérico Referência de um evento calculado
valorExtra evento carácter numérico Valor de um evento informado no movimento extra
valorFixo evento carácter numérico Valor de um evento informado no movimento fixo ( para processo atual )
valorFixoGeral Evento carácter numérico Valor de um evento informado no fixo em qualquer processo
pensaoAlimenticia baseCalc numérico
percentual numérico
quotas numérico 		numérico Calcula a pensão alimentícia
calcularEvento Evento carácter
Referencia numérico (opcional)
Valor numérico 		numérico Grava o evento especificado no primeiro parâmetro para o processo atual. Caso não coloque referência o mesmo ficará com o valor zerado
removerEvento Evento carácter numérico Remove do cálculo um evento já processado
valorFicha Evento carácter
Ano inicial
Mês inicial
Ano final
Mês final 		numérico Retorna o valor de um determinado evento na ficha financeira de acordo com o período informado
informadoFixo Evento carácter lógico Retorna se o evento for informado no fixo
informadoExtra Evento carácter lógico Retorna se o evento for informado no extra
valorBeneficioColaborador evento carácter numérico Retorna o valor total utilizado pelo colaborador naquele beneficio valor este apenas vindo da movimentação mensal
CodigoSaque Numérico carácter Retorna o código do afastamento
causaRescisao Numérico carácter Retorna o código corresponde a causa da rescisão

Objetos

Específicos para o layout

Nome Propriedades Tipo Descrição
dados Todos os campos da tabela informada no registro atual Tipo do campo especificado Objeto específico da remessa do layout

Específicas para integrações

Nome Propriedades Tipo Descrição
Evento Todos os campos Tabela de eventos

Específicas para a folha

Nome Propriedades Tipo Descrição
colaborador ID numérico ID
tipoPessoa caracter Tipo da colaborador
codigo caracter Código
nome caracter Nome
apelido caracter Apelido
portal_nivelAcesso numérico Nível de acesso ao portal web
portal_senha caracter Senha ao portal web
dataNascimento data Data de nascimento
estadoCivil caracter Estado civil
cpf caracter CPF
pis caracter PIS
end_logradouro caracter Logradouro
end_numero caracter Número da casa/prédio
end_cep caracter CEP
end_complemento caracter Complemento do endereço
end_bairro caracter Bairro
end_cidade caracter Cidade
end_uf caracter Estado
idHorarioTrabalho numérico ID do horário de trabalho
racaCor caracter Raça/Cor
deficiente caracter Deficiência física
codNacionalidade caracter Nacionalidade
anoChegada numérico Ano de chegada
idEscolaridade numérico Grau de escolaridade
sexo caracter Sexo
rg_Numero caracter Identidade - Número
rg_Orgao caracter Identidade - Órgão expedidor
rg_DataEmissao data Identidade - Data de emissão
reservista_Numero caracter Reservista
naturalidade caracter Naturalidade
nomePai caracter Nome do Pai
nomeMae caracter Nome da Mãe
fone_DDD caracter DDD Telefone fixo
fone_Numero caracter Telefone fixo
celular_DDD caracter DDD Telefone celular
celular_Numero caracter Celular
email caracter E-mail
emailEmpresa caracter E-mail na empresa
cracha caracter Número do crachá
idAgencia numérico ID da Agência bancária
contaCorrente_Numero caracter Conta corrente - Número
contaCorrente_DV caracter Conta corrente - Dígito
contaCorrente_Tipo caracter Conta corrente - Tipo
ctps_Numero caracter CTPS - Número
ctps_Serie caracter CTPS - Série
ctps_DataEmissao data CTPS - Data de emissão
ctps_Uf caracter CTPS - UF
eleitor_Numero caracter Título de eleitor - Número
eleitor_Zona caracter Título de eleitor - Zona
eleitor_Secao caracter Título de eleitor - Seção
eleitor_Municipio caracter Título de eleitor - Município
habilitacao_Numero caracter Habilitação - Número
habilitacao_DataEmissao data Habilitação - Data de emissão
habilitacao_DataValidade data Habilitação - Validade
habilitacao_DataPrimeira data Habilitação - Data da 1ª habilitação
habilitacao_Categoria caracter Habilitação - Categoria
conselho_Numero caracter Conselho
conselho_Sigla caracter Conselho - Sigla
ufOrigem caracter Estado de origem
tipoSanguineo caracter Sangue - Tipo
fatorRh caracter Sangue - Fator RH
IdAreaGeografica numérico ID da área geográfica
remuneracao numérico Salário
tipoSalario caracter Tipo de salário
idSindicato numérico ID do Sindicato
dataAdmissao data Data de admissão
codVinculo caracter Vínculo empregatício
codOcorrencia caracter Ocorrência
codCategoria caracter Categoria
codCargo caracter Código do Cargo
codFuncao caracter ID da Função
codDepartamento caracter Código do Departamento
codHierarquia caracter Código da Hierarquia
sindicato_MesDesconto numérico Mês de desconto sindical
percAdiantamento numérico Valor do adiantamento
idCargaHoraria numérico ID da Carga horária
tipoAdmissao caracter Tipo de admissão
fgts_Agencia numérico FGTS - Agência
fgts_DataOpcao data FGTS - Data de opção
fgts_contaCorrente_Numero caracter FGTS - Conta corrente
fgts_contaCorrente_DV caracter FGTS - Dígito da conta corrente
pat caracter PAT
alvaraJudicial caracter Alvará judicial
bancoHoras caracter Banco de horas
estabilidade_DataFim data Estabilidade - Data de término
estabilidade_Motivo caracter Estabilidade - Motivo
dataTransferenciaEntrada data Data de entrada (transferência)
dataAdmissaoServPub data Data de admissão do servidor público
ponto_nivelAcesso numérico ID do nível de acesso
idGrupoBatimento numérico ID do grupo de batimento
idGrupoPagamento numérico ID do grupo de pagamento
pir_codfornecedor caracter Código do Fornecedor
grupoPagamento ID numérico ID
nome caracter Nome do grupo
tipoFolha caracter Tipo da folha
variosAdiantamentos caracter Vários adiantamentos
adiant_Desconto caracter Desconto do adiantamento
adiant_Diamaximo numérico Dia máximo do adiantamento
adiant_Percentual numérico Percentual de adiantamento
adiant_Provento caracter Provento de adiantamento
adiant13_Provento caracter Adiantamento do 13º (Provento)
adiant13_Desconto caracter Adiantamento do 13º (Desconto)
arred_Desconto caracter Desconto do arredondamento
arred_Provento caracter Provento de arredondamento
arred_Valor numérico Valor do arredondamento
contribSindical_Evento caracter Contribuição sindical
emprestimo_Desconto caracter Desconto empréstimo
emprestimo_Provento caracter Provento de empréstimo
irrf_Decimo caracter IRRF sobre décimo
irrf_Evento caracter IRRF
irrf_Ferias caracter IRRF sobre férias
evento_adicionalFerias caracter Adicional de férias
evento_adicionalFerInd caracter Adicional de férias indenizadas
evento_avisoPrevioInd caracter Aviso prévio indenizado
evento_avisoPrevioTrab caracter Aviso prévio trabalhado
evento_decimo caracter Décimo terceiro salário
evento_decimoIndenizado caracter Décimo terceiro indenizado
evento_difSalMaternidade caracter Diferença salário maternidade
evento_ferias caracter Férias
evento_feriasIndenizadas caracter Férias indenizadas
evento_feriasProporcionais caracter Férias proporcionais
evento_indenizacao479 caracter Indenização Art.479
evento_licencaRemunerada caracter Licença remunerada
evento_PensaoAlimenticia caracter Pensão alimentícia
evento_pis caracter PIS
evento_SalarioFamilia caracter Salário família
evento_SalarioHorista caracter Salário horista
evento_SalarioMaternidade caracter Salário maternidade
evento_SalarioMensalista caracter Salário mensalista
evento_saldoFeriasColetivas caracter Saldo férias coletivas
evento_saldoSalario caracter Saldo de salário
evento_ValeRefeicao caracter Vale refeição
evento_ValeTransporte caracter Vale transporte
ferias_abonoPecuniario caracter Abono pecuniário (Férias)
ferias_adicionalAbono caracter Abono pecuniário (1/3 de Férias)
ferias_difAbonoPecuniario caracter Diferença abono pecuniário (Férias)
ferias_difAdicionalAbono caracter Diferença adicional abono férias
ferias_Diferenca caracter Diferença (Férias)
ferias_DiferencaAdicional caracter Diferença adicional férias
ferias_Liquido caracter Líquido de férias
prevSocial_Decimo caracter Previdência Social (Décimo)
prevSocial_Evento caracter Previdência Social
prevSocial_Ferias caracter Previdência Social (Férias)
rescisao_Liquido caracter Líquido de rescisão
salarioProporcionalDiasMes caracter Salário proporcional aos dias do mês
sindicato Todos os campos Tabela de sindicato
dependente Todos os campos Tabela de dependentes
evento Todos os campos Tabela de eventos

Exemplos de Fórmula

Correção de Prova

A fórmula de correção de Prova estará atrelada ao(s) evento (s) que referem-se a esse provento: 

se competenciames=4 ou competenciames=7 ou competenciames=11
  resultado:=valorinformado*totalvantagens/100
senao
  resultado:=0
fimse