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
tipoPessoa
codigo
nome
apelido
portal_nivelAcesso
portal_senha
dataNascimento
estadoCivil
cpf
pis
end_logradouro
end_numero
end_cep
end_complemento
end_bairro
end_cidade
end_uf
idHorarioTrabalho
racaCor
deficiente
codNacionalidade
anoChegada
idEscolaridade
sexo
rg_Numero
rg_Orgao
rg_DataEmissao
reservista_Numero
naturalidade
nomePai
nomeMae
fone_DDD
fone_Numero
celular_DDD
celular_Numero
email
emailEmpresa
cracha
idAgencia
contaCorrente_Numero
contaCorrente_DV
contaCorrente_Tipo
ctps_Numero
ctps_Serie
ctps_DataEmissao
ctps_Uf
eleitor_Numero
eleitor_Zona
eleitor_Secao
eleitor_Municipio
habilitacao_Numero
habilitacao_DataEmissao
habilitacao_DataValidade
habilitacao_DataPrimeira
habilitacao_Categoria
conselho_Numero
conselho_Sigla
ufOrigem
tipoSanguineo
fatorRh
IdAreaGeografica
remuneracao
tipoSalario
idSindicato
dataAdmissao
codVinculo
codOcorrencia
codCategoria
codCargo
codFuncao
codDepartamento
codHierarquia
sindicato_MesDesconto
percAdiantamento
idCargaHoraria
tipoAdmissao
fgts_Agencia
fgts_DataOpcao
fgts_contaCorrente_Numero
fgts_contaCorrente_DV
pat
alvaraJudicial
bancoHoras
estabilidade_DataFim
estabilidade_Motivo
dataTransferenciaEntrada
dataAdmissaoServPub
ponto_nivelAcesso
idGrupoBatimento
idGrupoPagamento
pir_codfornecedor

numérico
caracter
caracter
caracter
numérico
numérico
caracter
caracter
caracter
data
caracter
caracter
caracter
caracter
caracter
caracter
caracter
caracter
caracter
caracter
caracter
numérico
caracter
caracter
caracter
caracter
caracter
data
caracter
caracter
caracter
caracter
caracter
caracter
data
data
data
caracter
caracter
caracter
caracter
caracter
caracter
numérico
numérico
caracter
numérico
data
caracter
caracter
caracter
caracter
caracter
caracter
caracter
numérico
numérico
numérico
caracter
numérico
data
caracter
caracter
caracter
caracter
caracter
data
caracter
data
data
numérico
numérico
numérico
caracter | ID
Tipo da colaborador
Código
Nome
Apelido
Nível de acesso ao portal web
Senha ao portal web
Data de nascimento
Estado civil
CPF
PIS
Logradouro
Número da casa/prédio
CEP
Complemento do endereço
Bairro
Cidade
Estado
ID do horário de trabalho
Raça/Cor
Deficiência física
Nacionalidade
Ano de chegada
Grau de escolaridade
Sexo
Identidade - Número
Identidade - Órgão expedidor
Identidade - Data de emissão
Reservista
Naturalidade
Nome do Pai
Nome da Mãe
DDD Telefone fixo
Telefone fixo
DDD Telefone celular
Celular
E-mail
E-mail na empresa
Número do crachá
ID da Agência bancária
Conta corrente - Número
Conta corrente - Dígito
Conta corrente - Tipo
TPS - Número
CTPS - Série
CTPS - Data de emissão
CTPS - UF
Título de eleitor - Número
Título de eleitor - Zona
Título de eleitor - Seção
Título de eleitor - Município
Habilitação - Número
Habilitação - Data de emissão
Habilitação - Validade
Habilitação - Data da 1ª habilitação
Habilitação - Categoria
Conselho
Conselho - Sigla
Estado de origem
Sangue - Tipo
Sangue - Fator RH
ID da área geográfica
Salário
Tipo de salário
ID do Sindicato
Data de admissão
Vínculo empregatício
Ocorrência
Categoria
Código do Cargo
ID da Função
Código do Departamento
Código da Hierarquia
Mês de desconto sindical
Valor do adiantamento
ID da Carga horária
Tipo de admissão
FGTS - Agência
FGTS - Data de opção
FGTS - Conta corrente
FGTS - Dígito da conta corrente
PAT
Alvará judicial
Banco de horas
Estabilidade - Data de término
Estabilidade - Motivo
Data de entrada (transferência)
Data de admissão do servidor público
ID do nível de acesso
ID do grupo de batimento
ID do grupo de pagamento
Código do Fornecedor |