Fórmulas e Funções do Folha Cloud

Documentação de ajuda para criação de fórmulas de eventos da folha, aqui você encontrará as funções e variáveis reservadas da folha assim como as funções para fórmulas que não são padrões mas no entanto são mantidas atualmente pelo desenvolvimento


Sumário

Funções reservadas

Variáveis reservadas

Enums

Funçoes para fórmulas (mantidas pelo desenvolvimento)


Funções reservadas

Afastamentos

buscaPorPeriodo

Permite buscar os afastamentos de uma matrícula informando uma lista de classificações de afastamentos dentro de um período

Parâmetro Descrição Obrigatório
dataInicial Data inicial da verificação de afastamentos, caso não seja informado será considerado o início da competência Não
dataFinal Data final da verificação de afastamentos, caso não seja informado será considerado o início da competência Não
classificacoes Classificações de afastamentos, use ClassificacaoTipoAfastamento.[classificação de afastamento] Sim
Utilizado na função : afasservmil
Afastamentos.buscaPorPeriodo(ClassificacaoTipoAfastamento.SERVICO_MILITAR).each { afast ->
def diaFim = afast.fim.dia
    def fim = afast.fim
if (diaFim > 30) {
fim = Datas.data(afast.fim.ano, afast.fim.mes, 30)
    }
    dias += Datas.diferencaDias(afast.inicio, fim) + 1
}

AvisoPrevio

dataFimAviso

Retorna a data final do aviso prévio

def dataFimAviso = AvisoPrevio.dataFimAviso

dataPrevistaDesligamento

Retorna a data prevista do desligamento informado no aviso prévio

def dataPrevistaDesligamento = AvisoPrevio.dataPrevistaDesligamento

motivoRescisao

Retorna o motivo da rescisão informado no aviso prévio

def motivoRescisao = AvisoPrevio.motivoRescisao

dataAviso

Retorna a data do aviso prévio

def dataAviso = AvisoPrevio.dataAviso

quantidadeDiasAviso

Retorna a quantidade de dias de aviso prévio

def quantidadeDiasAviso = AvisoPrevio.quantidadeDiasAviso
if ( quantidadeDiasAviso > 0 ){ ...

tipo

Retorna o tipo de aviso prévio

def tipo = AvisoPrevio.tipo
if ( TipoAvisoPrevio.INDENIZADO.equals(tipo) ){ ...

Bases

valor

Permite buscar o valor de uma base no cálculo atual

Parâmetro Descrição Obrigatório
tipo de base Informar um tipo de base, use Bases.[sigla da base] Sim
Utilizado no evento : HORAS EXTRAS 50%
//É importante se atentar a dependências de fórmulas quando for referênciar outra base
if (Eventos.valor(1) > 0) {
base = Bases.valor(Bases.HORAEXTRA)
...

compor

Permite informar um valor para composição de um ou vários tipos de bases de cálculo

Parâmetro Descrição Obrigatório
valor Valor que irá compor a base Sim
tipo(s) de base(s) Um ou vários tipos de bases Sim
Utilizado no evento : HORAS NORMAIS
valorCalculado = funcionario.salario;
Bases.compor(valorCalculado, Bases.SALBASE, Bases.FGTS, Bases.IRRF, Bases.INSS)

valorCalculado

Permite buscar o valor de uma base em um processamento de cálculo que não seja o atual

Parâmetro Descrição Obrigatório
tipo de base Informar um tipo de base, use Bases.[sigla da base] Sim
tipo de processamento Informar um tipo de processamento Sim
subtipo de processamento Informar um subtipo de processamento Sim
competencia Informar uma competência, caso não seja informado será considerada a competência atual Não
tipo de regime Informar o tipo de regime, use TipoRegime.COMPETENCIA ou TipoRegime.CAIXA, caso não seja informado será considerado regime de competência Não
Utilizado no evento : F.G.T.S. 13º SALÁRIO
if (TipoProcessamento.DECIMO_TERCEIRO_SALARIO.equals(calculo.tipoProcessamento) && vaux > 0) {
        baseaux = Bases.valorCalculado(Bases.FGTS, TipoProcessamento.FERIAS, SubTipoProcessamento.INTEGRAL)
        baseaux += Bases.valorCalculado(Bases.FGTS, TipoProcessamento.MENSAL, SubTipoProcessamento.INTEGRAL)
...

BasesOutrasEmpresas

buscaPor

Permite buscar uma lista de bases de outras empresas conforme o tipo de processamento e competência informada

Parâmetro Descrição Obrigatório
tipo de processamento Informar um tipo de processamento Sim
competencia Informar uma competência, caso não seja informado será considerada a competência atual Não
//Use sum() para retornar o valor total de um propriedade em uma lista
return BasesOutrasEmpresas.buscaPor(calculo.tipoProcessamento, calculo.competencia).sum(0, { it.baseInss })

Eventos

valor

Permite buscar o valor calculado de um evento do processamento de cálculo atual(Exceto do próprio evento)

Parâmetro Descrição Obrigatório
codigo Informar o código de uma evento Sim
Utilizado no evento : DESCONTO HORAS AFASTADO
//É importante se atentar a dependências de fórmulas quando for referênciar outro evento
valorCalculado = Eventos.valor(4) + Eventos.valor(5) + Eventos.valor(7) + Eventos.valor(8)

valorReferencia

Permite buscar o valor de referência de um evento do processamento de cálculo atual(Exceto do próprio evento)

Parâmetro Descrição Obrigatório
codigo Informar o código de uma evento Sim
Utilizado no evento : DESCONTO HORAS AFASTADO
//É importante se atentar a dependências de fórmulas quando for referênciar outro evento
if (!funcionario.possuiPrevidenciaFederal) {
valorReferencia = Eventos.valorReferencia(7)
...

valorCalculado

Permite buscar o valor calculado ou de referência de um evento que não seja do processamento de cálculo atual

Parâmetro Descrição Obrigatório
codigo Informar o código de um evento Sim
tipo valor Se deseja retornar o valor calculado ou de referência, use TipoValor.CALCULADO ou TipoValor.REFERENCIA Sim
tipo de processamento Informar um tipo de processamento Sim
subtipo de processamento Informar um subtipo de processamento Sim
competencia Informar uma competência, caso não seja informado será considerada a competência atual Não
tipo de regime Informar o tipo de regime, use TipoRegime.COMPETENCIA ou TipoRegime.CAIXA, caso não seja informado será considerado regime de competência Não
Utilizado no evento : F.G.T.S. 13º SALÁRIO
double vaux;
vaux  = Eventos.valorCalculado(36, TipoValor.CALCULADO , TipoProcessamento.MENSAL, SubTipoProcessamento.INTEGRAL)

EncargosSociais

pisoSalarial

Retorna o piso salarial da entidade

def pisoSalarial = EncargosSociais.pisoSalarial

salarioMinimo

Retorna o salário mínio configurado na manutenção de estabelecimentos

def salarioMinimo = EncargosSociais.salarioMinimo

tetoSalarial

Retorna o teto salarial da entidade

def tetoSalarial = EncargosSociais.tetoSalarial

inicioVigencia

Retorna o inicio da vigência do cadastro de manutenção de estabelecimentos que esta sendo utilizada no cálculo atual

def inicioVigencia = EncargosSociais.inicioVigencia

cnaePreponderante

Retorna o cnae preponderante da entidade, essa informação fica no grupo RGPS

def cnaePreponderante = EncargosSociais.RGPS.cnaePreponderante

codigoFpas

Retorna o código FPAS da entidade, essa informação fica no grupo RGPS

def codigoFpas = EncargosSociais.RGPS.codigoFpas
if ( EncargosSociaisFpas.ENTIDADE_BENEFICENTE.equals(codigoFpas){...

codigoTerceiros

Retorna o código de terceiros da entidade, essa informação fica no grupo RGPS

def codigoTerceiros = EncargosSociais.RGPS.codigoTerceiros

percentualFap

Retorna o percentual do FAP da entidade, essa informação fica no grupo RGPS

def percentualFap = EncargosSociais.RGPS.percentualFap

percentualGilRat

Retorna o percentual do RAT da entidade, essa informação fica no grupo RGPS

def percentualGilRat = EncargosSociais.RGPS.percentualGilRat

percentualInssEmpregador

Retorna o percentual do inss empregador da entidade, essa informação fica no grupo RGPS

def percentualInssEmpregador = EncargosSociais.RGPS.percentualInssEmpregador

percentualIsencaoFilantropia

Retorna o percentual de percentual de isencao de entidade filantrópica, essa informação fica no grupo RGPS

def percentualIsencaoFilantropia = EncargosSociais.RGPS.percentualIsencaoFilantropia

percentualTerceiros

Retorna o percentual de terceiros da entidade, essa informação fica no grupo RGPS

def percentualTerceiros = EncargosSociais.RGPS.percentualTerceiros

SESTAutonomo

Retorna o percentual informado no campo "SEST Autonomo" da tabela vigente na competência do cálculo em (Configurando > Cálculo > Manutenção de estabelecimento)

def SESTAutonomo = EncargosSociais.Geral.SESTAutonomo

SENATAutonomo

Retorna o percentual informado no campo "SENAT Autonomo" da tabela vigente na competência do cálculo em (Configurando > Cálculo > Manutenção de estabelecimento)

def SENATAutonomo = EncargosSociais.Geral.SENATAutonomo

codigoFgts

Retorna o código de saque do FGTS da entidade, essa informação fica no grupo FGTS

def codigoFgts = EncargosSociais.FGTS.codigoFgts

multaFgts

Retorna o percentual da multa FGTS da entidade, essa informação fica no grupo FGTS

def multaFgts = EncargosSociais.FGTS.multaFgts
valorCalculado = (calculo.saldoFgts * multaFgts) / 100

deducaoPorDependente

Retorna o valor de desconto por dependente, essa informação fica no grupo IRRF

Utilizado no evento : DESCONTO POR DEPENDENTE
valorReferencia = servidor.dependentesIrrf
def deducaoPorDependente = EncargosSociais.IRRF.deducaoPorDependente
valorCalculado = valorReferencia * deducaoPorDependente

minimoIrrfDarf

Retorna o valor mínimo configurado para DARF, essa informação fica no grupo IRRF

Utilizado no evento : I.R.R.F.
if (valorCalculado < EncargosSociais.IRRF.minimoIrrfDarf) {
    valorCalculado = 0
} ...

parcelaIsentaAposentadoria

Retorna o valor configurado para a parcela isenta de aposentadoria, essa informação fica no grupo IRRF

def parcelaIsentaAposentadoria = EncargosSociais.IRRF.parcelaIsentaAposentadoria

buscaContribuicao

Retorna um valor da coluna em uma faixa encontrada conforme o valor informado de uma previdência ou de assistência conforme a origem de tipo. Este método pode ser utilizado para todos os tipos de previdências e assistências do RPPS

Parâmetro Descrição Obrigatório
base Valor base para ser comparado Sim
coluna coluna que deve retornar Sim
double valorbase = 1500.00
previdenciaPropria = EncargosSociais.RPPS.PrevidenciaPropria.buscaContribuicao(valorbase, 2)
previdenciaEstadual = EncargosSociais.RPPS.PrevidenciaEstadual.buscaContribuicao(valorbase, 2)
fundoAssistencia = EncargosSociais.RPPS.FundoAssistencia.buscaContribuicao(valorbase, 2)
fundoFinanceiro = EncargosSociais.RPPS.FundoFinanceiro.buscaContribuicao(valorbase, 2)

buscaMaior

Retorna a coluna referente faixa de maior valor encontrada conforme o valor informado de uma previdência ou de assistência conforme a origem de tipo. Este método pode ser utilizado para todos os tipos de previdências e assistências do RPPS

Parâmetro Descrição Obrigatório
coluna coluna que deve retornar Sim
previdenciaPropria = EncargosSociais.RPPS.PrevidenciaPropria.buscaMaior(1)
previdenciaEstadual = EncargosSociais.RPPS.PrevidenciaEstadual.buscaMaior(1)
fundoAssistencia = EncargosSociais.RPPS.FundoAssistencia.buscaMaior(1)
fundoFinanceiro = EncargosSociais.RPPS.FundoFinanceiro.buscaMaior(1)

indiceAporte

Retorna o percentual do índice de aporte de uma previdência ou de assistência conforme a origem de tipo. Este método pode ser utilizado para todos os tipos de previdências e assistências do RPPS

previdenciaPropria = EncargosSociais.RPPS.PrevidenciaPropria.indiceAporte
previdenciaEstadual = EncargosSociais.RPPS.PrevidenciaEstadual.indiceAporte
fundoAssistencia = EncargosSociais.RPPS.FundoAssistencia.indiceAporte
fundoFinanceiro = EncargosSociais.RPPS.FundoFinanceiro.indiceAporte

maximo

Retorna o valor máximo de contribuição de uma previdência ou de assistência conforme a origem de tipo. Este método pode ser utilizado para todos os tipos de previdências e assistências do RPPS

previdenciaPropria = EncargosSociais.RPPS.PrevidenciaPropria.maximo
previdenciaEstadual = EncargosSociais.RPPS.PrevidenciaEstadual.maximo
fundoAssistencia = EncargosSociais.RPPS.FundoAssistencia.maximo
fundoFinanceiro = EncargosSociais.RPPS.FundoFinanceiro.maximo

minimo

Retorna o valor mínimo de contribuição de uma previdência ou de assistência conforme a origem de tipo. Este método pode ser utilizado para todos os tipos de previdências e assistências do RPPS

previdenciaPropria = EncargosSociais.RPPS.PrevidenciaPropria.minimo
previdenciaEstadual = EncargosSociais.RPPS.PrevidenciaEstadual.minimo
fundoAssistencia = EncargosSociais.RPPS.FundoAssistencia.minimo
fundoFinanceiro = EncargosSociais.RPPS.FundoFinanceiro.minimo

taxaAdministrativa

Retorna o percentual da taxa administrativa de contribuição de uma previdência ou de assistência conforme a origem de tipo. Este método pode ser utilizado para todos os tipos de previdências e assistências do RPPS

previdenciaPropria = EncargosSociais.RPPS.PrevidenciaPropria.taxaAdministrativa
previdenciaEstadual = EncargosSociais.RPPS.PrevidenciaEstadual.taxaAdministrativa
fundoAssistencia = EncargosSociais.RPPS.FundoAssistencia.taxaAdministrativa
fundoFinanceiro = EncargosSociais.RPPS.FundoFinanceiro.taxaAdministrativa

Salário Família

buscaContribuicao

Retorno o valor da coluna do salário família conforme a base informada, este método pode ser aplicado para todos os tipos de salário família

Parâmetro Descrição Obrigatório
base Valor base para ser comparado Sim
coluna coluna que deve retornar Sim
double valorbase = 1500.00
celetista = EncargosSociais.SalarioFamilia.Celetista.buscaContribuicao(valorbase, 2)
estatutario = EncargosSociais.SalarioFamilia.Estatutario.buscaContribuicao(valorbase, 2)
especial = EncargosSociais.SalarioFamilia.Especial.buscaContribuicao(valorbase, 2)
aposentado = EncargosSociais.SalarioFamilia.Aposentado.buscaContribuicao(valorbase, 2)

buscaMaior

Retorno o valor da coluna de maior faix encontrada do salário família, este método pode ser aplicado para todos os tipos de salário família

Parâmetro Descrição Obrigatório
coluna coluna que deve retornar Sim
celetista = EncargosSociais.SalarioFamilia.Celetista.buscaMaior(1)
estatutario = EncargosSociais.SalarioFamilia.Estatutario.buscaMaior(1)
especial = EncargosSociais.SalarioFamilia.Especial.buscaMaior(1)
aposentado = EncargosSociais.SalarioFamilia.Aposentado.buscaMaior(1)

Emprestimos

busca

Retorna uma lista de empréstimos que podem ser filtrados pela situação

Parâmetro Descrição Obrigatório
situacaoEmprestimo Situação do empréstimo, caso não seja informado retornará empréstimos em qualquer situação Não
Emprestimos.busca(SituacaoEmprestimo.EM_ANDAMENTO).each { e ->
  e.parcelas.each { p ->
if (Funcoes.primeiroDia(p.dataParcela) == Funcoes.primeiroDia(_dataCompetencia)) {
if (p.situacao == SituacaoEmprestimoParcela.PENDENTE) {
        valor = valor + p.valorParcela
        Emprestimos.pagarParcela(e.id, p.id) //Realiza a baixa
      }
    }
  }
}

pagarParcela

Realiza a baixa da parcela de empréstimo no RH

Parâmetro Descrição Obrigatório
emprestimoId Identificador do empréstimo, será obtido percorrendo Emprestimos.busca() Sim
emprestimoId Identificador da parcela, será obtido percorrendo Emprestimos.busca() > parcelas Sim
Emprestimos.busca(SituacaoEmprestimo.EM_ANDAMENTO).each { e ->
  e.parcelas.each { p ->
if (Funcoes.primeiroDia(p.dataParcela) == Funcoes.primeiroDia(_dataCompetencia)) {
if (p.situacao == SituacaoEmprestimoParcela.PENDENTE) {
        valor = valor + p.valorParcela
        Emprestimos.pagarParcela(e.id, p.id) //Realiza a baixa
      }
    }
  }
}

Funções

Por meio de Funcoes é possível importar funções criadas no cadastro de funções para fórmulas, onde estão scripts criados pelo desenvolvimento à fim de facilitar o uso de recursos em eventos, diminuir código e possibilitar re-uso de recursos

int diasTrabalhados = Funcoes.diastrab()

def avos Funcoes.avos13(12, true)

Lancamentos

valor

Verifica se o evento que esta sendo calculado esta lançado em variáveis e retorna o valor lançado, para buscar o valor de outros eventos use valorPorEventoId

Parâmetro Descrição Obrigatório
evento use evento, não é possível passar literalmente um código de evento Sim
valorPadrao Permite retornar um valor padrão quando não existe lançamento, caso não seja informado o valor padrão para quando não existe lançamento é -1 Não
def vvar = Lancamentos.valor(evento)
if ( vvar >= 0 ){
 valorCalculdo = vvar
...

valorPorEventoId

Verifica se o evento informado esta lançado em variáveis e retorna o valor lançado, para buscar o valor de outros eventos use valorPorEventoId

Parâmetro Descrição Obrigatório
evento use evento, não é possível passar literalmente um código de evento Sim
valorPadrao Permite retornar um valor padrão quando não existe lançamento, caso não seja informado o valor padrão para quando não existe lançamento é -1 Não
def vvar = Lancamentos.valorPorEventoId(390)
if ( vvar >= 0 ){
 valorCalculdo = vvar
...

valorComposicaoMes

Retorna o valor totalizado de todos os lançamentos para eventos que compõem mês

Utilizado no evento : HORAS NORMAIS
def compoemes = Lancamentos.valorComposicaoMes();
vaux = horastrab - compoemes

PlanoSaudeDespesas

buscaDespesasPlanoSaude

Busca uma lista de despesas com planos de saúde

Utilizado no evento : DESPESAS COM PLANO DE SAÚDE - MENSALIDADE
PlanoSaudeDespesas.buscaDespesasPlanoSaude().each { despesa ->
if (despesa.tipo == TipoDespesaPlanoSaude.MENSALIDADE) {
vaux += despesa.valor
    }
}

PeriodosAquisitivos

buscaPeriodosComSaldo

Retorna uma lista de períodos aquisitivos de férias que tenham saldo, ou seja, proporcionais, utilizados parcialmente ou vencidos

int totalDias;
PeriodosAquisitivos.buscaPeriodosComSaldo().each { periodos ->
    totalDias += periodos.saldo
}

buscaVencidos

Retorna uma lista de períodos aquisitivos de férias que estejam com a situação VENCIDOS

Utilizado no evento : FÉRIAS VENCIDAS RESCISÃO
PeriodosAquisitivos.buscaVencidos();.each { feriasvenc ->
    def diasferias = feriasvenc.saldo
...
}

buscaProporcional

_Retorna um período aquisitivo de férias que esteja com a situação EMANDAMENTO

Utilizado no evento : FÉRIAS PROPORCIONAIS RESCISÃO
def feriasprop = PeriodosAquisitivos.buscaProporcional();
def saldo = feriasprop.saldo

quitaPorRescisao

Por meio deste método é possível realizar a baixa de um período aquisitivo de férias e também indicar o valor como parte da composição de uma média ou vantagem

Parâmetro Descrição Obrigatório
periodoAquisitivo O período aquisitivo que esta sendo calculado Sim
valorReferencia O valor de referência do evento que esta sendo calculado, caso sejam informados apenas dois parâmetros neste posição será considerado o valor calculado Não
valorCalculado O valor do evento que esta sendo calculado Não
compoeMediaVantagem Se este evento é uma média ou vantagem, usar true ou false, valor padrão é false Não
Utilizado no evento : MÉDIA HORAS FÉRIAS VENCIDAS RESCISÃO
PeriodosAquisitivos.buscaVencidos().each { feriasvenc ->
...
vtot = valorMedia * diasferias / 30
    PeriodosAquisitivos.quitaPorRescisao(feriasvenc, 0, vtot, true)
    ...
}

PeriodosAquisitivosDecimoTerceiro

buscaPeriodosAquisitivosBySituacao

Retorna uma lista de períodos aquisitivos de décimo terceiro salário conforme a situação informada no argumento

Parâmetro Descrição Obrigatório
situacao A situação do período, use SituacaoPeriodoAquisitivoDecimoTerceiro.[situacao] Sim
int avos;
PeriodosAquisitivosDecimoTerceiro.buscaPeriodosAquisitivosBySituacao(SituacaoPeriodoAquisitivoDecimoTerceiro.EM_ANDAMENTO).each{ periodo ->
avos += p.avosAdquiridos
}

buscaPeriodosAquisitivos

Retorna uma lista de períodos aquisitivos de décimo terceiro salário indiferentemente da situação

PeriodosAquisitivosDecimoTerceiro.buscaPeriodosAquisitivos().each { p ->
if (p.anoExercicio == calculo.competencia.ano) {
        avos = p.avosAdquiridos
    }
}

compoePagamento

Indica que o valor evento é referente a um período aquisitivo de décimo terceiro salário e realiza a baixa do mesmo

Parâmetro Descrição Obrigatório
periodoAquisitivoDecimoTerceiro o período aquisitivo e décimo terceiro salário que esta sendo baixado Sim
valor o valor calculado Sim
PeriodosAquisitivosDecimoTerceiro.buscaPeriodosAquisitivosBySituacao(SituacaoPeriodoAquisitivoDecimoTerceiro.EM_ANDAMENTO).each{ periodo ->
valor = funcionario.salario
    PeriodosAquisitivosDecimoTerceiro.compoePagamento(periodo, valor)
}

Variaveis reservadas

aposentado

formaPagamento

Retorna a Forma de pagamento do aposentado

if ( aposentado.formaPagamento == FormaPagamento.CHEQUE ){
    ...

grupoFuncional

Retorna o Grupo funcional do aposentado

def grupoFuncional =  aposentado.grupoFuncional

dataAposentadoria

Retorna a Data de aposentadoria

def dataAposentadoria =  aposentado.dataAposentadoria
if ( dataAposentadoria < calculo.competencia ){
...

dataCessacaoAposentadoria

Retorna a Data de cessação da aposentadoria

if ( aposentado.dataCessacaoAposentadoria != null){
...

valorBeneficio

Retorna o Valor do benefício do aposentado

valorCalculado = aposentado.valorBeneficio

descricaoOrganograma

Retorna a Descrição do organograma do aposentado

def descricaoOrganograma = aposentado.descricaoOrganograma

codigoOrganograma

Retorna o código do organograma do aposentado

def codigoOrganograma = aposentado.codigoOrganograma
if ( codigoOrganograma == '010102' ){
...

agenciaPagamento

Retorna a Agência de pagamento do aposentado

def agenciaPagamento = aposentado.agenciaPagamento

bancoPagamento

Retorna o Banco de pagamento do aposentado

def bancoPagamento = aposentado.bancoPagamento

calculo

Retorna as informações do cálculo que esta sendo efetuado e dos parâmetros de cálculo

descontarEmprestimoRescisao

Indica se os valores de empréstimo devem ser descontados na rescisão, retorna true ou false

if ( calculo.descontarEmprestimoRescisao ){
...

competencia

Retorna uma data referênte ao último dia da competência que esta sendo calculada

double base = Bases.valorCalculado(Bases.INSS, TipoProcessamento.FERIAS, SubTipoProcessamento.INTEGRAL, calculo.competencia)

quantidadeDiasCompetencia

Retorna a quantidade de dias da competência que esta sendo calculada

int dias = calculo.quantidadeDiasCompetencia
if ( dias < 30 ) dias = 30

abonoSemGozo

Indica se permite abono de férias sem gozo, retorna true ou false

if ( calculo.abonoSemGozo ){
...

tipoProcessamento

Retorna o tipo de processamento do cálculo atual

if ( calculo.tipoProcessamento == TipoProcessamento.MENSAL ){
    ...

dataPagamento

Retorna a data de pagamento do cálculo atual

dataPagamento = calculo.dataPagamento
if ( dataPagamento > calculo.competencia ){
...

dataRescisao

Retorna a Data de rescisão informada, somente quando se esta calculando uma rescisão

def dataRescisao = calculo.dataRescisao

quantidadeDias

Retorna a Quantidade de dias de uma competência informada nos argumentos

Parâmetro Descrição Obrigatório
mes informe um mês de referência, use entre 1 e 12 Sim
ano informe um ano de referência Sim
def data  = Datas.data(2015, 3, 5)
int dias1 = calculo.quantidadeDias(data.mes, data.ano)
int dias2 = calculo.quantidadeDias(3, 2015)

unidade

Retorna a unidade de pagamento configurada nos parâmetros gerais de cálculo

if ( calculo.unidade == UnidadeCalculo.DIAS ){
    ...

pagarUmTercoIntegral

Indicativo se deve pagar um terço integral em férias parciais, retorna true ou false

if ( calculo.pagarUmTercoIntegral ){
    ...

anoDecimoTerceiro

Retorna o ano do cálculo atual para fins de décimo terceiro

def situacao = SituacaoPeriodoAquisitivoDecimoTerceiro.QUITADO_PARCIALMENTE
PeriodosAquisitivosDecimoTerceiro.buscaPeriodosAquisitivosBySituacao(situacao).each{ p->
if (p.anoExercicio == calculo.anoDecimoTerceiro){
        ...

consideraAvosPerdidos

Indicativo se deve considerar avos perdidos na contagem de avos, retorna true ou false

if ( ! calculo.consideraAvosPerdidos ){
    ...

pagarDecimoTerceiroFerias

Indicativo se deve deve pagar décimo terceiro nas férias, retorna true ou false

if ( calculo.pagarDecimoTerceiroFerias ){
    ...

individual

Retorna verdadeiro se cálculo atual foi executado de forma individual

if ( ! calculo.individual ){
    ...

rescisaoAutomaticaVincTemp

Indicativo se o parâmetro geral de cálculo para gerar rescisão automática do vínculo temporário esta setado, retorna true ou false

if ( calculo.rescisaoAutomaticaVincTemp ){
    ...

descontarFaltasSobreFerias

Indicativo se o parâmetro de cálculo para descontar faltas sobre férias esta setado, retorna true ou false

if ( calculo.descontarFaltasSobreFerias ){
    ...

soma

Soma os valores totais do cálculo para um tipo de evento passado no argumento

Parâmetro Descrição Obrigatório
TipoEvento o tipo do evento. use TipoEvento.[tipo do evento] Sim
if ( calculo.descontarFaltasSobreFerias ){
...

estagiario

formaPagamento

Retorna a Forma de pagamento do estagiário

if ( estagiario.formaPagamento == FormaPagamento.DINHEIRO ){
    ...

grupoFuncional

Retorna o Grupo funcional do estagiário

def grupoFuncional =  estagiario.grupoFuncional

cargo

Retorna a descrição do Cargo do estagiário

def cargo =  estagiario.cargo
if ( cargo == 'ESTAGIÁRIO SAÚDE' ){
    ...

planoSalarial

Retorna o plano salarial do estagiário

def planoSalarial =  estagiario.planoSalarial

classeSalarial

Retorna a classe salarial do estagiário

def classeSalarial =  estagiario.classeSalarial

dataProrrogacao

Retorna a data da prorrogação do estágio

if ( estagiario.dataProrrogacao != null ){
    ...

nivelSalarial

Retorna o nível salarial do estagiário

def nivel = estagiario.nivelSalarial

quantidadeHorasMes

Retorna a quantidade de horas mês do estagiário

def quantidadeHorasMes = estagiario.quantidadeHorasMes
if ( quantidadeHorasMes.equals(100) ){
quantidadeHorasMes * vaux / 100;
}

descricaoOrganograma

Retorna a descrição do organograma do estagiário

def descricaoOrganograma = estagiario.descricaoOrganograma

recebeDecimoTerceiro

Indicativo se o estagiário recebe décimo terceiro salário conforme a configuração do cargo, retorna true ou false

if ( ! estagiario.recebeDecimoTerceiro ){
suspender 'O estagiário não recebe décimo terceiro salário'
}

diasDireitoFerias

Retorna os Dias de direito de férias conforme configuração de férias

int diasDireitoFerias = estagiario.diasDireitoFerias

mesesAquisicaoFerias

Retorna os Meses para aquisição de férias conforme configuração de férias

int mesesAquisicaoFerias = estagiario.mesesAquisicaoFerias

dataInicioEstagio

Retorna a Data de início do estágio

def dataInicioEstagio = estagiario.dataInicioEstagio
if ( dataInicioEstagio > calculo.competencia ){
    ...

bolsaEstudos

Retorna o valor da bolsa de estudos, essa é a remuneração do estagiário

valorCalculado = estagiario.bolsaEstudos

dataFinalEstagio

Retorna a Data final do estágio

def dataFinalEstagio = estagiario.dataFinalEstagio

agenciaPagamento

Retorna a Agencia de pagamento do estagiário

def agenciaPagamento = estagiario.agenciaPagamento

bancoPagamento

Retorna o Banco de pagamento do estagiário

def bancoPagamento = estagiario.bancoPagamento

nivelSalarialCoeficiente

Retorna o Coenficiente do nível salarial do estagiário

def nivelSalarialCoeficiente = estagiario.nivelSalarialCoeficiente

evento

Os dados de evento retornam informações do evento que esta sendo calculado mas também são as mesmas propriedade de quando percorremos dados de uma folha

codigo

Retorna o Código do evento

//Dados do evento atual
if ( evento.codigo == 1 ){
    ...
}

//Percorrendo uma folha
folhasPeriodo.buscaFolhas().each { folha ->
folha.eventos.each { evento ->
if (evento.codigo == 1 ) {
            referencia += e.referencia
valor += e.valor
        }
    }
}

taxa

Retorna a taxa do evento atual

def taxa = evento.taxa
valorCalculado = funcionario.salario * taxa / 100

getTaxa

Retorna a taxa de um outro evento passado por parâmetro

Parâmetro Descrição Obrigatório
codigoEvento código do evento que deseja buscar a taxa Sim
def taxa = evento.getTaxa(26)
valorCalculado = funcionario.salario * taxa / 100

getTaxa

Retorna a taxa de um outro evento passado por parâmetro

Parâmetro Descrição Obrigatório
codigoEvento código do evento que deseja buscar a taxa Sim
def descricao = evento.descricao
if ( descricao.startsWith('HORAS EXTRAS'){
    ...

descricao

Retorna a descrição do evento

def descricao = evento.descricao
if ( descricao.startsWith('HORAS EXTRAS')){
...

tipo

Retorna o tipo do evento

if ( evento.tipo == TipoEvento.VENCIMENTO ){
    ...

unidade

Retorna a unidade do evento

if ( evento.unidade == UnidadeEvento.DIAS ){
...

descricaoClassificacao

Retorna a descrição da classificação do evento

def descricaoClassificacao = evento.descricaoClassificacao

classificacao

Retorna a classificação do evento

def classificacao = evento.classificacao
if ( classificacao == ClassificacaoEvento.INSS ){
    ...

folha

Permite buscar informações da folha atual, as propriedades são também as mesmas de quando se esta percorrendo uma folha

tipoProcessamento

Retorna o Tipo de processamento da folha

//Dados da folha atual
if ( folha.tipoProcessamento == TipoProcessamento.MENSAL ){
...
}

//Percorrendo uma folha
folhasPeriodo.buscaFolhas().each { folha ->
    if ( folha.tipoProcessamento == TipoProcessamento.MENSAL ){
...
}

subTipoProcessamento

Retorna o subtipo de processamento

if ( folha.subTipoProcessamento == SubTipoProcessamento.INTEGRAL ){
    ...

eventos

Retorna uma lista de eventos calculados, essa variável só terá o efeito desejado se o evento esta calculando por último

folha.eventos.each{ e ->
    ...
}

diasGozo

Retorna os dias de gozo de férias quando o tipo de processamento é férias

int diasGozo = folha.diasGozo

diasAbono

Retorna os dias de abono de férias quando o tipo de processamento é férias

int diasAbono = folha.diasAbono

dataPagamento

Retorna a data de pagamento da folha

def dataPagamento = folha.dataPagamento

totalBruto

Retorna o total bruto da folha, essa variável só terá o efeito desejado se o evento esta calculando por último

def totalBruto = folha.totalBruto

totalDesconto

Retorna o total de desconto da folha, essa variável só terá o efeito desejado se o evento esta calculando por último

def totalDesconto = folha.totalDesconto

totalLiquido

Retorna o total líquido da folha, essa variável só terá o efeito desejado se o evento esta calculando por último

def totalLiquido = folha.totalLiquido

competencia

Retorna a competência da folha

def competencia = folha.competencia

folhaPagamento

Indica se é uma folha de pagamento, quando não é uma folha de pagamento esta será uma folha interna de férias

if ( folha.folhaPagamento ){
    ...
}else{
    ...

folhas

Permite buscar folhas tanto do cálculo atual como de outras competências e tipo de processamento conforme o método e parâmetros utilizados

valorCalculadoEvento

Retorna a soma de um evento em todos os cálculos da competência atual

Parâmetro Descrição Obrigatório
codigo código do evento que deseja buscar o valor calculado Sim
double valorCalculadoEvento = folhas.valorCalculadoEvento(22)

valorReferenciaEvento

Retorna a soma da referência de um evento em todos os cálculos da competência atual

Parâmetro Descrição Obrigatório
codigo código do evento que deseja buscar o valor de referência Sim
double valorReferenciaEvento = folhas.valorReferenciaEvento(22)

buscaFolhas

Busca dados da folha atual, deve ser usado marcando o evento para calcular por último caso queira buscar valores totalizados

folhas.buscaFolhas().each{ folha ->
...
}

buscaFolhasOutrasCompetencias

Busca dados de folhas de outras competências ou tipos de processamentos, não retorna dados da folha atual

Parâmetro Descrição Obrigatório
competência informe uma competência para buscar as folhas Sim
tipoProcessamento informe um tipo de processamento, caso não seja informado retornará todos os tipos de processamento Não
subTipoProcessamento informe um subtipo de processamento, caso não seja informado retornará todos os subtipos de processamento Não
def competenciaConsulta = Datas.data(2019, 1, 1)
def tipoProcessamento = TipoProcessamento.MENSAL
def subTipoProcessamento = SubTipoProcessamento.INTEGRAL
folhas.buscaFolhasOutrasCompetencias(competenciaConsulta,tipoProcessamento, subTipoProcessamento ).each{ folha ->
    ...
}

folhasPeriodo

Permite consultar folhas do período (competência atual)

buscaFolhas

Busca dados da folha atual, deve ser usado marcando o evento para calcular por último caso queira buscar valores totalizados

folhasPeriodo.buscaFolhas().each{ folha ->
    ...
}

buscaFolhasProcessamento

Busca de folhas de outros tipos de processamentos da mesma competência

Parâmetro Descrição Obrigatório
tipoProcessamento informe um tipo de processamento Sim
folhasPeriodo.buscaFolhasProcessamento(TipoProcessamento.FERIAS).each{ folha ->
...
}

buscaFolhasInternas

Busca de folhas internas (folhas de férias) da mesma competência

Parâmetro Descrição Obrigatório
tipoProcessamento informe um tipo de processamento Sim
folhasPeriodo.buscaFolhasInternas(TipoProcessamento.FERIAS).each{ folha ->
    ...
}

funcionario

Retorna dados do funcionário que esta sendo calculado

cargoOrigemRendimento

Retorna o cargo conforme a origem do rendimento informada

Parâmetro Descrição Obrigatório
OrigemRendimento informe a origem do rendimento do cargo ou cargo comissionado Sim
def cargo = funcionario.cargoOrigemRendimento(OrigemRendimento.CARGO)

planoSalarialOrigemRendimento

Retorna o plano salarial conforme a origem do rendimento informada

Parâmetro Descrição Obrigatório
OrigemRendimento informe a origem do rendimento do cargo ou cargo comissionado Sim
def plano = funcionario.planoSalarialOrigemRendimento(OrigemRendimento.CARGO)

classeSalarialOrigemRendimento

Retorna a classe salarial conforme a origem do rendimento informada

Parâmetro Descrição Obrigatório
OrigemRendimento informe a origem do rendimento do cargo ou cargo comissionado Sim