_Fórmulas e Funções do Folha Cloud_

Fórmulas e Funções do Folha Cloud

IMPORTANTE - As linguagens groovy/bfc-script tem tipagem opcional. Nos exemplos deste documento, as variáveis, em sua maioria estão tipadas, no entanto isso é apenas para demonstrar o tipo de retorno. Durante o uso, fica a critério do desenvolvedor da fórmula definir ou não o tipo da variável

Sumário

Funções reservadas
Ir para Funções reservadas

AdicionaisTempoServico
Ir para AdicionaisTempoServico

Afastamentos
Ir para Afastamentos

AvisoPrevio
Ir para AvisoPrevio

Bases
Ir para Bases

BasesOutrasEmpresas
Ir para BasesOutrasEmpresas

Eventos
Ir para Eventos

EncargosSociais
Ir para EncargosSociais

FuncoesGratificadas
Ir para FuncoesGratificadas

Emprestimos
Ir para Emprestimos

Lancamentos
Ir para Lancamentos

PlanoSaudeDespesas
Ir para PlanoSaudeDespesas

PeriodosAquisitivos
Ir para PeriodosAquisitivos

PeriodosAquisitivosDecimoTerceiro
Ir para PeriodosAquisitivosDecimoTerceiro

ValesTransporte
Ir para ValesTransporte

Variáveis reservadas

aposentado
Ir para aposentado

autonomo
Ir para autonomo

calculo
Ir para calculo

estagiario
Ir para estagiario

evento
Ir para evento

folha
Ir para folha

folhas
Ir para folhas

folhasPeriodo
Ir para folhasPeriodo

folhasMultiplosVinculosPeriodo
Ir para folhasMultiplosVinculosPeriodo

funcionario
Ir para funcionario

mediaVantagem
Ir para mediaVantagem

matricula
Ir para matricula

periodoAquisitivo
Ir para periodoAquisitivo

periodoConcessao
Ir para periodoConcessao

pensionista
Ir para pensionista

periodoAquisitivoDecimoTerceiro
Ir para periodoAquisitivoDecimoTerceiro

servidor
Ir para servidor

valorReferencia
Ir para valorReferencia

valorCalculado
Ir para valorCalculado

Funções para fórmulas




Funções reservadas

AdicionaisTempoServico

busca()

Busca no sistema RH a quantidade (em valor ou percentual) de adicionais adquiridos conforme a classificação de adicional

Parâmetro Descrição Obrigatório
tipoAdicional Informe um tipo de adicional Sim
classificacaoAdicional Informe uma classificação de adicional Sim
Utilizado no evento : Anuênio if (rh == 1) { valorReferencia = AdicionaisTempoServico.busca(TipoAdicional.QUANTIDADE_ADICIONAIS, ClassificacaoAdicional.ANUENIO) }


Afastamentos

buscaPorPeriodo()

Permite buscar os afastamentos de uma matrícula informando uma lista de classificações de tipos 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 Informe uma Classificação de Tipo 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 }


Afastamentos

buscaDiasAcidenteOuDoencaEmpregadorIsentosInss()

Retorna a quantidade de dias dentro da competência dos acidentes ou auxílios doença pagos pelo empregador e que originem um acidente ou auxílio doença pago pela previdência. O sistema usa a informação do afastamento de origem para conectar vários afastamentos e calcular os dias isentos. Obs.: os dias de isenção serão calculados apenas para competência posteriores a 10/2015, para os tipos de processamento Mensal e Rescisão e para matrículas cujo a categoria Sefip do vínculo seja: Empregado, Contrato por prazo determinado (CLT) ou Menor aprendiz.

int dias = Afastamentos.buscaDiasAcidenteOuDoencaEmpregadorIsentosInss()


AvisoPrevio

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

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

dataAviso - Retorna a data do aviso prévio

dataFimAviso - Retorna a data final do aviso prévio

quantidadeDiasAviso - Retorna a quantidade de dias de aviso prévio

tipo - Retorna o tipo de aviso prévio

Retorna a data final do aviso prévio

//Retorna a data fim do aviso prévio Date dataFimAviso = AvisoPrevio.dataFimAviso //Retorna a data prevista do desligamento informado no aviso prévio Date dataPrevistaDesligamento = AvisoPrevio.dataPrevistaDesligamento //Retorna o motivo da rescisão informado no aviso prévio String motivoRescisao = AvisoPrevio.motivoRescisao //Retorna a data do aviso prévio Date dataAviso = AvisoPrevio.dataAviso //Retorna a quantidade de dias de aviso prévio int quantidadeDiasAviso = AvisoPrevio.quantidadeDiasAviso //Retorna o tipo de aviso prévio (TipoAvisoPrevio) if ( AvisoPrevio.tipo.equals(TipoAvisoPrevio.INDENIZADO) ){ imprimir "O tipo de aviso prévio é indenizado" }


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) ...

Bases

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)

Bases

valorCalculado()

Permite buscar o valor de uma base de um 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, caso não seja informado será considerado regime de competência Não
//Utilizado no evento : F.G.T.S. 13º SALÁRIO BigDecimal baseaux = BigDecimal.valueOf(0); if (TipoProcessamento.DECIMO_TERCEIRO_SALARIO.equals(calculo.tipoProcessamento) && vaux > 0) { baseaux = Bases.valorCalculado(Bases.FGTS, calculo.tipoProcessamento, calculo.subTipoProcessamento) 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(TipoProcessamento.MENSAL, calculo.competencia).sum(0, { it.baseInss }) //Percorra os valores BasesOutrasEmpresas.buscaPor(TipoProcessamento.MENSAL, calculo.competencia).each{ b -> imprimir "Base de inss : $b.baseInss" imprimir "Base de irrf : $b.baseIrrf" imprimir "Valor de inss : $b.valorRetidoInss" imprimir "Valor de irrf : $b.valorRetidoIrrf" }
  1. baseInss - Valor de base do INSS
  2. baseIrrf - Valor de base do IRRF
  3. valorRetidoInss - Valor do INSS descontado em outra empresa
  4. valorRetidoIrrf - Valor do IRRF descontado em outra empresa


Eventos

valor()

Permite o valor calculado de um evento do cálculo atual

Parâmetro Descrição Obrigatório
codigo Informar o código de um 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)


Eventos

valorReferencia()

Permite o valor de referência de um evento do cálculo atual

Parâmetro Descrição Obrigatório
codigo Informar o código de um 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) ...


Eventos

valorCalculado()

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

Parâmetro Descrição Obrigatório
codigo Informar o código de uma evento Sim
tipo valor Se deseja retornar o valor calculado ou de referência, use TipoValor 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, 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) referencia = Eventos.valorCalculado(evento.codigo, TipoValor.REFERENCIA , TipoProcessamento.MENSAL, SubTipoProcessamento.INTEGRAL)


Eventos

valorCalculadoMultiplosVinculos()

Permite buscar calculado ou de referência de um evento dos outros vínculos do servidor calculados em ordem anterior ao cálculo atual, esta função retorna apenas cálculos da mesma competência

Parâmetro Descrição Obrigatório
codigo ou classificacaoEvento Informe um código ou classificação de evento Sim
tipo valor Se deseja retornar o valor calculado ou de referência, use TipoValor Sim
tipo de processamento Informar um tipo de processamento Sim
subtipo de processamento Informar um subtipo de processamento Sim
//Utilizado na função para fórmula : getValorBaseMultiplosVinculos() //Busca o valor da base de inss de outros vínculos no processamento mensal integral BigDecimal base = Bases.valorCalculadoMultiplosVinculos(Bases.INSS, TipoProcessamento.MENSAL, SubTipoProcessamento.INTEGRAL) //Busca e soma o valor da base de inss de outros vínculos no processamento rescisão integral base += Bases.valorCalculadoMultiplosVinculos(Bases.INSS, TipoProcessamento.RESCISAO, SubTipoProcessamento.INTEGRAL)


EncargosSociais

pisoSalarial - Retorna o piso salarial da entidade

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

tetoSalarial - Retorna o teto salarial da entidade

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

/** * Retorna as informações conforme o cadastro de manutenção de estabelecimentos, considerando a vigência do cálculo */ BigDecimal pisoSalarial = EncargosSociais.pisoSalarial BigDecimal salarioMinimo = EncargosSociais.salarioMinimo BigDecimal tetoSalarial = EncargosSociais.tetoSalarial //Retorna um YearMonth, no exemplo convertido para uma string em formato 'yyyy-MM' inicioVigencia = EncargosSociais.inicioVigencia.toString();


EncargosSociais

RGPS

cnaePreponderante - Retorna o cnae preponderante da entidade

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

codigoTerceiros - Retorna o código de terceiros da entidade

percentualFap - Retorna o percentual do FAP da entidade

percentualGilRat - Retorna o percentual do RAT da entidade

percentualInssEmpregador - Retorna o percentual do inss empregador da entidade

percentualIsencaoFilantropia - Retorna o percentual de percentual de isencao de entidade filantrópica

percentualTerceiros - Retorna o percentual do inss empregador da entidade

/** * As variáveis abaixo estão dentro das informações de RGPS em > Configurando > CálculoManutenções de estabelecimento, * elas sempre estão acessiveis dentro de EncargosSociais.RGPS... */ //Retorna o cnae preponderante da entidade, essa informação fica no grupo RGPS def cnaePreponderante = EncargosSociais.RGPS.cnaePreponderante //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){ imprimir "É uma entidade beneficiente" ) //Retorna o código de terceiros da entidade, essa informação fica no grupo RGPS def codigoTerceiros = EncargosSociais.RGPS.codigoTerceiros //Retorna o percentual do FAP da entidade, essa informação fica no grupo RGPS def percentualFap = EncargosSociais.RGPS.percentualFap //Retorna o percentual do RAT da entidade, essa informação fica no grupo RGPS def percentualGilRat = EncargosSociais.RGPS.percentualGilRat //Retorna o percentual do inss empregador da entidade, essa informação fica no grupo RGPS def percentualInssEmpregador = EncargosSociais.RGPS.percentualInssEmpregador //Retorna o percentual de percentual de isencao de entidade filantrópica, essa informação fica no grupo RGPS def percentualIsencaoFilantropia = EncargosSociais.RGPS.percentualIsencaoFilantropia //Retorna o percentual de terceiros da entidade, essa informação fica no grupo RGPS_ def percentualTerceiros = EncargosSociais.RGPS.percentualTerceiros


EncargosSociais

RGPS

buscaContribuicao()

Retorna um valor da coluna em uma faixa encontrada conforme o valor informado de uma previdência federal

Parâmetro Descrição Obrigatório
base Valor base para ser comparado Sim
coluna coluna que deve retornar Sim
BigDecimal valorbase = 1500.00 def aliquotaInss = EncargosSociais.RGPS.buscaContribuicao(valorbase, 2) //Exemplo no evento 50 - I.N.S.S. if (funcionario.conselheiroTutelar) { valorReferencia = 11 } else { valorReferencia = EncargosSociais.RGPS.buscaContribuicao(vaux2, 2) }


EncargosSociais

RGPS

buscaMaior()

Retorna a coluna referente faixa de maior valor encontrada conforme o valor informado de uma previdência federal

Parâmetro Descrição Obrigatório
coluna coluna que deve retornar Sim
BigDecimal tetoInss = EncargosSociais.RGPS.buscaMaior(1) BigDecimal maiorAliquota = EncargosSociais.RGPS.buscaMaior(2)


EncargosSociais

FGTS

codigoFgts - Retorna o código de saque do FGTS da entidade

multaFgts - Retorna o percentual de multa do FGTS

//Retorna o código de saque do FGTS da entidade, essa informação fica no grupo FGTS String codigoFgts = EncargosSociais.FGTS.codigoFgts //Retorna o percentual da multa FGTS da entidade, essa informação fica no grupo FGTS BigDecimal multaFgts = EncargosSociais.FGTS.multaFgts valorCalculado = (calculo.saldoFgts * multaFgts) / 100


EncargosSociais

IRRF

deducaoPorDependente - Retorna o valor de dedução por dependente

minimoIrrfDarf - Retorna o valor mínimo de desconto de IRRF

parcelaIsentaAposentadoria - Retorna o da parcela de isenta de aposetadoria

deducaoPorDependente - Retorna o valor de dedução por dependente

//Retorna o valor de desconto por dependente, essa informação fica no grupo IRRF_ //Utilizado no evento : DESCONTO POR DEPENDENTE valorReferencia = servidor.dependentesIrrf BigDecimal deducaoPorDependente = EncargosSociais.IRRF.deducaoPorDependente valorCalculado = valorReferencia * deducaoPorDependente //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 } //Retorna o valor configurado para a parcela isenta de aposentadoria, essa informação fica no grupo IRRF_ BigDecimal parcelaIsentaAposentadoria = EncargosSociais.IRRF.parcelaIsentaAposentadoria


EncargosSociais

IRRF

buscaContribuicao()

Retorna um valor da coluna em uma faixa encontrada conforme o valor informado no fundo financeiro

Parâmetro Descrição Obrigatório
base Valor base para ser comparado Sim
coluna coluna que deve retornar Sim
BigDecimal valorbase = 1500.00 BigDecimal aliquotaInss = EncargosSociais.IRRF.buscaContribuicao(valorbase, 2)


EncargosSociais

RPPS

PrevidenciaPropria - Retorna os dados da previdência própria

minimo - Valor mínimo de desconto da previdência própria

maximo - Valor máximo de desconto da previdência própria

indiceAporte - Retorna o índice do aporte da previdência própria

taxaAdministrativa - Retorna a taxa administrativa da previdência própria

//ìndice do aporte indiceAportePrevidenciaPropria = EncargosSociais.RPPS.PrevidenciaPropria.indiceAporte //Máximo de desconto maximoPrevidenciaPropria = EncargosSociais.RPPS.PrevidenciaPropria.maximo //Mínimo de desconto minimoPrevidenciaPropria = EncargosSociais.RPPS.PrevidenciaPropria.minimo //Taxa administrativa taxaAdministrativaPrevidenciaPropria = EncargosSociais.RPPS.PrevidenciaPropria.taxaAdministrativa


EncargosSociais

RPPS

PrevidenciaPropria

buscaContribuicao()

Retorna um valor da coluna em uma faixa encontrada conforme o valor informado na previdência própria

Parâmetro Descrição Obrigatório
base Valor base para ser comparado Sim
coluna coluna que deve retornar Sim
BigDecimal valorbase = 1500.00 BigDecimal aliquotaInss = EncargosSociais.RPPS.PrevidenciaPropria.buscaContribuicao(valorbase, 2)


EncargosSociais

RPPS

PrevidenciaPropria

buscaMaior()

Retorna a coluna referente faixa de maior valor encontrada conforme o valor informado na previdência própria

Parâmetro Descrição Obrigatório
coluna coluna que deve retornar Sim
BigDecimal tetoInss = EncargosSociais.RPPS.PrevidenciaPropria.buscaMaior(1) BigDecimal maiorAliquota = EncargosSociais.RPPS.PrevidenciaPropria.buscaMaior(2)


EncargosSociais

RPPS

PrevidenciaEstadual - Retorna os dados da previdência estadual

minimo - Valor mínimo de desconto da previdência estadual

maximo - Valor máximo de desconto da previdência estadual

indiceAporte - Retorna o índice do aporte da previdência estadual

taxaAdministrativa - Retorna a taxa administrativa da previdência estadual

//ìndice do aporte indiceAportePrevidenciaEstadual = EncargosSociais.RPPS.PrevidenciaEstadual.indiceAporte //Máximo de desconto maximoPrevidenciaEstadual = EncargosSociais.RPPS.PrevidenciaEstadual.maximo //Mínimo de desconto minimoPrevidenciaEstadual = EncargosSociais.RPPS.PrevidenciaEstadual.minimo //Taxa administrativa taxaAdministrativaPrevidenciaEstadual = EncargosSociais.RPPS.PrevidenciaEstadual.taxaAdministrativa


EncargosSociais

RPPS

PrevidenciaEstadual

buscaContribuicao()

Retorna um valor da coluna em uma faixa encontrada conforme o valor informado na previdência estadual

Parâmetro Descrição Obrigatório
base Valor base para ser comparado Sim
coluna coluna que deve retornar Sim
BigDecimal valorbase = 1500.00 BigDecimal aliquotaInss = EncargosSociais.RPPS.PrevidenciaEstadual.buscaContribuicao(valorbase, 2)


EncargosSociais

RPPS

PrevidenciaEstadual

buscaMaior()

Retorna a coluna referente faixa de maior valor encontrada conforme o valor informado na previdência estadual

Parâmetro Descrição Obrigatório
coluna coluna que deve retornar Sim
BigDecimal tetoInss = EncargosSociais.RPPS.PrevidenciaEstadual.buscaMaior(1) BigDecimal maiorAliquota = EncargosSociais.RPPS.PrevidenciaEstadual.buscaMaior(2)


EncargosSociais

RPPS

FundoAssistencia - Retorna os dados do fundo de assistência

minimo - Valor mínimo de desconto do fundo de assistência

maximo - Valor máximo de desconto do fundo de assistência

indiceAporte - Retorna o índice do aporte do fundo de assistência

taxaAdministrativa - Retorna a taxa administrativa do fundo de assistência

//ìndice do aporte indiceAporteFundoAssistencia = EncargosSociais.RPPS.FundoAssistencia.indiceAporte //Máximo de desconto maximoFundoAssistencia = EncargosSociais.RPPS.FundoAssistencia.maximo //Mínimo de desconto minimoFundoAssistencia = EncargosSociais.RPPS.FundoAssistencia.minimo //Taxa administrativa taxaAdministrativaFundoAssistencia = EncargosSociais.RPPS.FundoAssistencia.taxaAdministrativa


EncargosSociais

RPPS

FundoAssistencia

buscaContribuicao()

Retorna um valor da coluna em uma faixa encontrada conforme o valor informado no fundo de assistência

Parâmetro Descrição Obrigatório
base Valor base para ser comparado Sim
coluna coluna que deve retornar Sim
BigDecimal valorbase = 1500.00 BigDecimal aliquotaInss = EncargosSociais.RPPS.FundoAssistencia.buscaContribuicao(valorbase, 2)


EncargosSociais

RGPS

FundoAssistencia

buscaMaior()

Retorna a coluna referente faixa de maior valor encontrada conforme o valor informado no fundo de assistência

Parâmetro Descrição Obrigatório
coluna coluna que deve retornar Sim
BigDecimal tetoInss = EncargosSociais.RPPS.FundoAssistencia.buscaMaior(1) BigDecimal maiorAliquota = EncargosSociais.RPPS.FundoAssistencia.buscaMaior(2)


EncargosSociais

RPPS

FundoFinanceiro - Retorna os dados do fundo financeiro

minimo - Valor mínimo de desconto do fundo financeiro

maximo - Valor máximo de desconto do fundo financeiro

indiceAporte - Retorna o índice do fundo financeiro própria

taxaAdministrativa - Retorna a taxa administrativa do fundo financeiro

//ìndice do aporte indiceAporteFundoFinanceiro = EncargosSociais.RPPS.FundoFinanceiro.indiceAporte //Máximo de desconto maximoFundoFinanceiro = EncargosSociais.RPPS.FundoFinanceiro.maximo //Mínimo de desconto minimoFundoFinanceiro = EncargosSociais.RPPS.FundoFinanceiro.minimo //Taxa administrativa taxaAdministrativaFundoFinanceiro = EncargosSociais.RPPS.FundoFinanceiro.taxaAdministrativa


EncargosSociais

RPPS

FundoFinanceiro

buscaContribuicao()

Retorna um valor da coluna em uma faixa encontrada conforme o valor informado no fundo financeiro

Parâmetro Descrição Obrigatório
base Valor base para ser comparado Sim
coluna coluna que deve retornar Sim
BigDecimal valorbase = 1500.00 BigDecimal aliquotaInss = EncargosSociais.RPPS.FundoFinanceiro.buscaContribuicao(valorbase, 2)


EncargosSociais

RGPS

FundoFinanceiro

buscaMaior()

Retorna a coluna referente faixa de maior valor encontrada conforme o valor informado no fundo financeiro

Parâmetro Descrição Obrigatório
coluna coluna que deve retornar Sim
BigDecimal tetoInss = EncargosSociais.RPPS.FundoFinanceiro.buscaMaior(1) BigDecimal maiorAliquota = EncargosSociais.RPPS.FundoFinanceiro.buscaMaior(2)


EncargosSociais

SalarioFamilia

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
/** * Observe que para cada tipo de salário família será utilizada uma rota diferente (Celetista, Estatutario, Especial e Aposentado) */ 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)

EncargosSociais

SalarioFamilia

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
/** * Observe que para cada tipo de salário família será utilizada uma rota diferente (Celetista, Estatutario, Especial e Aposentado) */ 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 -> imprimir "dataInicial : $e.dataInicial" imprimir "dataFinal : $e.dataFinal" imprimir "pessoaJuridica : $e.pessoaJuridica" imprimir "quantidade parcelas : " + e.parcelas.size() imprimir "quantidade pendentes : " + e.parcelas.sum(0, { SituacaoEmprestimoParcela.PENDENTE.equals(it.situacao) ? 1 : 0 }) e.parcelas.each { p -> if (Funcoes.primeiroDia(p.dataParcela) == Funcoes.primeiroDia(_dataCompetencia)) { if (p.situacao == SituacaoEmprestimoParcela.PENDENTE) { valor = valor + p.valorParcela imprimir "valorParcela : $p.valorParcela" imprimir "situacao : $p.situacao" Emprestimos.pagarParcela(e.id, p.id) //Realiza a baixa } } } }

Campos disponíveis em Emprestimos.busca()

  1. id - Id do empréstimo
  2. dataInicial - Data inicial do empréstimo
  3. dataFinal - Data de final do empréstimo (última parcela)
  4. pessoaJuridica - Data de fim do atestado no formato yyyy-MM-dd
  5. dataInicioDesconto - Data inicial do desconto (primeira parcela)
  6. numeroContrato - Número do contrato do empréstimo
  7. verba - Verba do empréstimo
  8. valorTotal - Valor total do empréstimo
  9. numeroParcelas - Número total de parcelas
  10. situacao - Situação do empréstimo
  11. parcelas - Lista de parcelas do empréstimo
  12. id - Id da parcela
  13. numero - Número da parcela
  14. valorParcela - Valor da parcela
  15. dataPagamento - Data de pagamento da parcela
  16. situacao - Situação da parcela


Emprestimos

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 } } } }


FuncoesGratificadas

busca()

Retorna os dias em função gratificada na competência com o id da função gratificada

Parâmetro Descrição Obrigatório
idFuncaoGratificada id da função, pode ser obtido na edição do cadastro da função gratificada, na url do navegador Sim
//Utilizado no evento : FUNÇÃO GRATIFICADA I int diasFuncao = FuncoesGratificadas.busca(123) //onde 123 é o id da função gratificada


Lancamentos

valor()

Verifica se o evento que esta sendo calculado está lançado em variáveis e retorna o valor lançado caso encontrado. Do contrário, retornará o valor padrão. Para buscar o valor de outros eventos, use valorPorEventoId

Parâmetro Descrição Obrigatório
evento Código do 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 exista um lançamento, retornará -1 Não
//Quando não existe lançamento para este evento o retorno padrão é -1 def vvar = Lancamentos.valor(evento) if (vvar >= 0) { valorCalculdo = vvar }


Lancamentos

valorPorEventoId()

Verifica se o evento informado esta lançado em variáveis e retorna o valor lançado caso encontrado. Do contrário, retornará o valor padrão

Parâmetro Descrição Obrigatório
eventoId Código do 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 exista um lançamento, retornará -1 Não
def vvar = Lancamentos.valorPorEventoId(390) if (vvar >= 0) { valorCalculdo = vvar }


Lancamentos

gerar()

Permite inserir um valor de lançamento de evento para qualquer competência e tipo de processamento, com exceção do cálculo atual

Parâmetro Descrição Obrigatório
tipoProcessamento Informe um tipo de processamento Sim
subTipoProcessamento Informe um subtipo de processamento Sim
competencia Informe uma competência (Date) Sim
codigoEvento Informe um código de evento Sim
valor Informe o valor a ser lançado Sim
observação Informe uma observação para ser inserida no lançamento de evento Não
Datas.configurar([usarCorrecaoCalculo:true]) competenciaInicial = Datas.data(2020, 1, 1) competenciaFinal = Datas.removeMeses(calculo.competencia, 1) meses = Datas.diferencaMeses(competenciaInicial, competenciaFinal) BigDecimal valorTotal = BigDecimal.valueOf(0) for (int mes = 0; mes <= meses; mes ++) { competencia = Datas.adicionaMeses(competenciaInicial, mes) folhasAnteriores = folhas.buscaFolhasOutrasCompetencias(competencia, calculo.tipoProcessamento) totalFolha += folhasAnteriores.sum(0, { it.folha.totalBruto }) } BigDecimal correcao10PorCento = (totalFolha * 10) / 100 Lancamentos.gerar(calculo.tipoProcessamento, calculo.subTipoProcessamento, competenciaLancamento, evento.codigo, correcao10PorCento, "Correção de 10% do bruto das folhas anteriores")


Lancamentos

valorComposicaoMes()

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

//Utilizado no evento : HORAS NORMAIS BigDecimal 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 } }

Campos disponíveis em PlanoSaudeDespesas.buscaDespesasPlanoSaude()

  1. planoSaude - Plano de saúde
    1. id - Id do plano de saúde
    2. configuracao - Configuração do plano de saúde
      1. id - Id da configuração do plano de saúde
      2. descrição - Descrição da da configuração do plano de saúde
      3. empresa - Empresa de plano de saúde
        1. id - Id da empresa
        2. razaoSocial - Razão social da empresa
        3. cnpj - CNPJ da empresa
    3. numeroContrato - Número de contrato
    4. carteiraIdentificacao - Carteira de identificação
    5. subsidioDiferenciado - Subsídio diferenciado
  2. beneficiario - Beneficiário do plano
    1. nome - Nome do beneficiário
    2. cpf - CPF do beneficiário
    3. dataNascimento - Data de nascimento do beneficiário
    4. sexo - Sexo do beneficiário
  3. procedimentoMedico - Procedimento realizado
  4. valor - Valor da despesa (com subsídio)
  5. tipo - Tipo de despesa
  6. valorTotal - Valor total da despesa
  7. titular - Titular do plano
    1. nome - Nome do títular
    2. cpf - CPF do títular
    3. dataNascimento - Data de nascimento do títular
    4. sexo - Sexo do títular


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 }

Campos disponíveis em PeriodosAquisitivos.buscaPeriodosComSaldo()

  1. dataInicial - Data inicial do período aquisitivo
  2. dataFinal - Data final do período aquisitivo
  3. faltas - Quantidade de faltas
  4. faltasBrutas - Quantidade de faltas brutas
  5. faltasEnquadradas - Quantidade de faltas enquadradas
  6. diasPagosRescisao - Dias de férias pagos em rescisão
  7. cancelados - Quantidade de dias cancelados
  8. suspensos - Quantidade de dias suspensos
  9. configuracaoFerias - Configuração de férias
    1. id - Id da configuração
    2. diasParaAdquirirNoPeriodo - Dias para adiquirir no período
    3. mesesParaAquisicao - Meses para aquisição
    4. mesesParaConcessao - Meses para concessão
    5. diasAbono - Quantidade de dias para abono
    6. pagamentoFerias - Pagamento de férias (proporcional ou integral)
    7. periodoNovoFeriasProporcional - Período novo de férias proporcionais
    8. inicioPeriodo - Tipo de início do período
    9. diaMesInicioPeriodo - Mês e ano de início (quando Início do período é Dia e mês específicos)
  10. situacao - Situação do período aquisitivo
  11. saldo - saldo de dias do período aquisitivos
  12. cancelamentos - Lista de configuração de cancelamentos
    1. descricao - Descrição da configuração
    2. numeroDiasParaCancelar - Número de dias para cancelar
    3. diasContinuos - Dias contínuos
    4. quandoCancelar - Quando cancelar
    5. tiposAfastamento - Tipo de afastamento
      1. descricao - Descrição do tipo de afastamento
      2. diasPrevistos - Dias previstos
      3. perdeTempoServico - Perde tempo de serviço
      4. consideraVencimento - Considera vencimento
      5. reduzFerias - Reduz férias
      6. reduzFgts - Reduz 13º salário
      7. justificado - Justificado
      8. classificacao - Classificação do afastamento
  13. suspensoes - Lista de configurações de suspensões
    1. tiposAfastamento - Tipo de afastamento
      1. descricao - Descrição do tipo de afastamento
      2. diasPrevistos - Dias previstos
      3. perdeTempoServico - Perde tempo de serviço
      4. consideraVencimento - Considera vencimento
      5. reduzFerias - Reduz férias
      6. reduzFgts - Reduz 13º salário
      7. justificado - Justificado
      8. classificacao - Classificação do afastamento
    2. quantidadeDiasSuspender - Quantidade de dias para suspender
  14. descontosFaltas - Configuração de descontos de faltas
    1. quantidadeInicial - Quantidade inicial
    2. quantidadeFinal - Quantidade final
    3. quantidadeDiasDescontados - Quantidade de dias à descontar


PeriodosAquisitivos

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 ... }

Campos disponíveis em PeriodosAquisitivos.buscaVencidos()

  1. dataInicial - Data inicial do período aquisitivo
  2. dataFinal - Data final do período aquisitivo
  3. faltas - Quantidade de faltas
  4. faltasBrutas - Quantidade de faltas brutas
  5. faltasEnquadradas - Quantidade de faltas enquadradas
  6. diasPagosRescisao - Dias de férias pagos em rescisão
  7. cancelados - Quantidade de dias cancelados
  8. suspensos - Quantidade de dias suspensos
  9. configuracaoFerias - Configuração de férias
    1. id - Id da configuração
    2. diasParaAdquirirNoPeriodo - Dias para adiquirir no período
    3. mesesParaAquisicao - Meses para aquisição
    4. mesesParaConcessao - Meses para concessão
    5. diasAbono - Quantidade de dias para abono
    6. pagamentoFerias - Pagamento de férias (proporcional ou integral)
    7. periodoNovoFeriasProporcional - Período novo de férias proporcionais
    8. inicioPeriodo - Tipo de início do período
    9. diaMesInicioPeriodo - Mês e ano de início (quando Início do período é Dia e mês específicos)
  10. situacao - Situação do período aquisitivo
  11. saldo - saldo de dias do período aquisitivos
  12. cancelamentos - Lista de configuração de cancelamentos
    1. descricao - Descrição da configuração
    2. numeroDiasParaCancelar - Número de dias para cancelar
    3. diasContinuos - Dias contínuos
    4. quandoCancelar - Quando cancelar
    5. tiposAfastamento - Tipo de afastamento
      1. descricao - Descrição do tipo de afastamento
      2. diasPrevistos - Dias previstos
      3. perdeTempoServico - Perde tempo de serviço
      4. consideraVencimento - Considera vencimento
      5. reduzFerias - Reduz férias
      6. reduzFgts - Reduz 13º salário
      7. justificado - Justificado
      8. classificacao - Classificação do afastamento
  13. suspensoes - Lista de configurações de suspensões
    1. tiposAfastamento - Tipo de afastamento
      1. descricao - Descrição do tipo de afastamento
      2. diasPrevistos - Dias previstos
      3. perdeTempoServico - Perde tempo de serviço
      4. consideraVencimento - Considera vencimento
      5. reduzFerias - Reduz férias
      6. reduzFgts - Reduz 13º salário
      7. justificado - Justificado
      8. classificacao - Classificação do afastamento
    2. quantidadeDiasSuspender - Quantidade de dias para suspender
  14. descontosFaltas - Configuração de descontos de faltas
    1. quantidadeInicial - Quantidade inicial
    2. quantidadeFinal - Quantidade final
    3. quantidadeDiasDescontados - Quantidade de dias à descontar


PeriodosAquisitivos

buscaProporcional()

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

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

Campos disponíveis em PeriodosAquisitivos.buscaProporcional()

  1. dataInicial - Data inicial do período aquisitivo
  2. dataFinal - Data final do período aquisitivo
  3. faltas - Quantidade de faltas
  4. faltasBrutas - Quantidade de faltas brutas
  5. faltasEnquadradas - Quantidade de faltas enquadradas
  6. diasPagosRescisao - Dias de férias pagos em rescisão
  7. cancelados - Quantidade de dias cancelados
  8. suspensos - Quantidade de dias suspensos
  9. configuracaoFerias - Configuração de férias
    1. id - Id da configuração
    2. diasParaAdquirirNoPeriodo - Dias para adiquirir no período
    3. mesesParaAquisicao - Meses para aquisição
    4. mesesParaConcessao - Meses para concessão
    5. diasAbono - Quantidade de dias para abono
    6. pagamentoFerias - Pagamento de férias (proporcional ou integral)
    7. periodoNovoFeriasProporcional - Período novo de férias proporcionais
    8. inicioPeriodo - Tipo de início do período
    9. diaMesInicioPeriodo - Mês e ano de início (quando Início do período é Dia e mês específicos)
  10. situacao - Situação do período aquisitivo
  11. saldo - saldo de dias do período aquisitivos
  12. cancelamentos - Lista de configuração de cancelamentos
    1. descricao - Descrição da configuração
    2. numeroDiasParaCancelar - Número de dias para cancelar
    3. diasContinuos - Dias contínuos
    4. quandoCancelar - Quando cancelar
    5. tiposAfastamento - Tipo de afastamento
      1. descricao - Descrição do tipo de afastamento
      2. diasPrevistos - Dias previstos
      3. perdeTempoServico - Perde tempo de serviço
      4. consideraVencimento - Considera vencimento
      5. reduzFerias - Reduz férias
      6. reduzFgts - Reduz 13º salário
      7. justificado - Justificado
      8. classificacao - Classificação do afastamento
  13. suspensoes - Lista de configurações de suspensões
    1. tiposAfastamento - Tipo de afastamento
      1. descricao - Descrição do tipo de afastamento
      2. diasPrevistos - Dias previstos
      3. perdeTempoServico - Perde tempo de serviço
      4. consideraVencimento - Considera vencimento
      5. reduzFerias - Reduz férias
      6. reduzFgts - Reduz 13º salário
      7. justificado - Justificado
      8. classificacao - Classificação do afastamento
    2. quantidadeDiasSuspender - Quantidade de dias para suspender
  14. descontosFaltas - Configuração de descontos de faltas
    1. quantidadeInicial - Quantidade inicial
    2. quantidadeFinal - Quantidade final
    3. quantidadeDiasDescontados - Quantidade de dias à descontar


PeriodosAquisitivos

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](#SituacaoPeriodoAquisitivoDecimoTerceiroEnum Sim
int avos; PeriodosAquisitivosDecimoTerceiro.buscaPeriodosAquisitivosBySituacao(SituacaoPeriodoAquisitivoDecimoTerceiro.EM_ANDAMENTO).each{ periodo -> avos += p.avosAdquiridos }

Campos disponíveis em PeriodosAquisitivosDecimoTerceiro.buscaPeriodosAquisitivosBySituacao()

  1. dataInicial - Data inicial do período aquisitivo
  2. dataFinal - Data final do período aquisitivo
  3. avosAdquiridos - Avos adquiridos
  4. avosAdquiridosFgts - Avos adquiridos para FGTS
  5. avosPerdidos - Avos perdido
  6. avosDireito - Avos de direito
  7. situacao - Situação do período aquisitivo
  8. anoExercicio - Ano de exercício do período aquisitivo
  9. competenciaFechamentoProvisao - Competência de fechamento da provisão
  10. competenciasAvosPerdidos - Competências dos avos perdidos


PeriodosAquisitivosDecimoTerceiro

buscaPeriodosAquisitivos()

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

//Retorna uma lista de períodos aquisitivos independentemente das situações PeriodosAquisitivosDecimoTerceiro.buscaPeriodosAquisitivos().each { p -> imprimir "situacao : $p.situacao" imprimir "avosAdquiridos : $p.avosAdquiridos" imprimir "anoExercicio : $p.anoExercicio" imprimir "dataInicial : $p.dataInicial" imprimir "dataFinal : $p.dataFinal" if (p.anoExercicio == calculo.competencia.ano) { avos = p.avosAdquiridos } }

Campos disponíveis em PeriodosAquisitivosDecimoTerceiro.buscaPeriodosAquisitivos()

  1. dataInicial - Data inicial do período aquisitivo
  2. dataFinal - Data final do período aquisitivo
  3. avosAdquiridos - Avos adquiridos
  4. avosAdquiridosFgts - Avos adquiridos para FGTS
  5. avosPerdidos - Avos perdido
  6. avosDireito - Avos de direito
  7. situacao - Situação do período aquisitivo
  8. anoExercicio - Ano de exercício do período aquisitivo
  9. competenciaFechamentoProvisao - Competência de fechamento da provisão
  10. competenciasAvosPerdidos - Competências dos avos perdidos


PeriodosAquisitivosDecimoTerceiro

compoePagamento()

Indica que o valor evento é referente a um período aquisitivo de décimo terceiro salário e realiza a baixa do mesmo
> > Esta função não possui retorno

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 //Esta função não possui retorno PeriodosAquisitivosDecimoTerceiro.compoePagamento(periodo, valor) }


ValesTransporte

busca()

Retorna do RH o valor ou quantidade de vales transporte conforme argumento

Parâmetro Descrição Obrigatório
tipoRetornoValeTransporte Tipo de retorno do vale transporte Sim
Utilizado no evento : Vale transporte BigDecimal valor = ValesTransporte.busca(TipoRetornoValeTransporte.VALOR) int quantidadeVales = ValesTransporte.busca(TipoRetornoValeTransporte.QUANTIDADE)

Campos disponíveis em ValesTransporte.busca()

  1. valorTotal - Valor total do vale transporte
  2. tipoRetorno - Tipo de retorno



Variáveis reservadas

aposentado Retorna os dados da matrícula que sejam do tipo aposentado no cálculo

formaPagamento - Retorna a Forma de pagamento do aposentado

grupoFuncional - Retorna o Grupo funcional do aposentado

dataAposentadoria - Retorna a Data de aposentadoria

dataCessacaoAposentadoria - Retorna a Data de cessação da aposentadoria

valorBeneficio - Retorna o Valor do benefício do aposentado

descricaoOrganograma - Retorna a Descrição do organograma

codigoOrganograma - Retorna o código do organograma

agenciaPagamento - Retorna a Agência de pagamento

bancoPagamento - Retorna o Banco de pagamento

//Forma de pagamento if ( aposentado.formaPagamento == FormaPagamento.CHEQUE ){ imprimir "A forma de pagamento é cheque" } //Retorna o Grupo funcional do aposentado String grupoFuncional = aposentado.grupoFuncional //Retorna a Data de aposentadoria Date dataAposentadoria = aposentado.dataAposentadoria //Retorna a Data de cessação da aposentadoria if ( aposentado.dataCessacaoAposentadoria != null){ Date dataCessacaoAposentadoria = aposentado.dataCessacaoAposentadoria } //Retorna o Valor do benefício do aposentado BigDecimal valorCalculado = aposentado.valorBeneficio //Retorna a Descrição do organograma do aposentado String descricaoOrganograma = aposentado.descricaoOrganograma //Retorna o código do organograma do aposentado String codigoOrganograma = aposentado.codigoOrganograma if ( codigoOrganograma == '010102' ){ imprimir "codigoOrganograma é '010102'" } //Retorna a Agência de pagamento do aposentado String agenciaPagamento = aposentado.agenciaPagamento //Retorna o Banco de pagamento do aposentado String bancoPagamento = aposentado.bancoPagamento


autonomo Retorna os dados da matrícula que sejam do tipo autônomo no cálculo

codESocial - Retorna o código eSocial informado na categoria do trabalhador autônomo

String codigoESocial = autonomo.codEsocial


calculo Retorna as informações dos parâmetros de cálculo e também do cálculo que está sendo executado

descontarEmprestimoRescisao - Indica se os valores de empréstimo devem ser descontados na rescisão

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

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

abonoSemGozo - Indica se permite abono de férias sem gozo

tipoProcessamento - Retorna o tipo de processamento do cálculo atual

subTipoProcessamento - Retorna o subtipo de processamento do cálculo atual

dataPagamento - Retorna a data de pagamento do cálculo atual

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

quantidadeDias(mes, ano) - Retorna a Quantidade de dias de uma competência informada nos argumentos

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

pagarUmTercoIntegral - Indicativo se deve pagar um terço integral em férias parciais

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

consideraAvosPerdidos - Indicativo se deve considerar avos perdidos na contagem de avos

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

rescisaoAutomaticaVincTemp - Indicativo se parâmetro de cálculo de rescisão automática esta setado

descontarFaltasSobreFerias - Indicativo se o parâmetro de cálculo para descontar faltas esta setado

descontarEmprestimoRescisao - Indicativo se parâmetro para descontar empréstimos na rescisão esta setado

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

motivoRescisao - Retorna o motivo da rescisão

saldoFgts - Retorna o saldo do FGTS informado no parâmetro de cálculo da rescisão

fgtsMesAnterior - Retorna o saldo do mês anterior foi depositado

avisoPrevioIndenizado - Retorna se é aviso prévio indenizado

quantidadeDiasAvisoPrevio - Retorna a quantidade de dias do aviso prévio

trabalhouDiaRescisao - Retorna o campo repor vaga informado no parâmetro de cálculo da rescisão

reporVaga - Retorna o campo trabalhou no dia da rescisão informado no parâmetro de cálculo da rescisão

//Indica se os valores de empréstimo devem ser descontados na rescisão, retorna true ou false if ( calculo.descontarEmprestimoRescisao ){ imprimir "Marcado para descontar empréstimos na rescisão" } //Retorna uma data referênte ao último dia da competência que esta sendo calculada BigDecimal base = Bases.valorCalculado(Bases.INSS, TipoProcessamento.FERIAS, SubTipoProcessamento.INTEGRAL, calculo.competencia) //Retorna a quantidade de dias da competência que esta sendo calculada int dias = calculo.quantidadeDiasCompetencia if ( dias < 30 ) dias = 30 //Indica se permite abono de férias sem gozo, retorna true ou false if ( calculo.abonoSemGozo ){ imprimir "Configuraão permite abono sem gozo" } //Retorna o tipo de processamento do cálculo atual if ( calculo.tipoProcessamento == TipoProcessamento.MENSAL ){ imprimir "Tipo de processamento igual a mensal" } //Retorna a data de pagamento do cálculo atual Date dataPagamento = calculo.dataPagamento //Retorna a Data de rescisão informada, somente quando se esta calculando uma rescisão if ( calculo.dataRescisao != null ){ Date dataRescisao = calculo.dataRescisao; } //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 | */ Date data = Datas.data(2015, 3, 5) int dias1 = calculo.quantidadeDias(data.mes, data.ano) int dias2 = calculo.quantidadeDias(3, 2015) //Retorna a unidade de pagamento configurada nos parâmetros gerais de cálculo if ( calculo.unidade == UnidadeCalculo.DIAS ){ imprimir "Unidade de cálculo configurada em dias" } //Indicativo se deve pagar um terço integral em férias parciais, retorna true ou false if ( calculo.pagarUmTercoIntegral ){ imprimir "Configurado para pagar um terço integral em férias parciais" } //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){ imprimir "Aqui terá somente os dados do período aquisitivo do ano exercício do cálculo" } } //Indicativo se deve considerar avos perdidos na contagem de avos, retorna true ou false if ( calculo.consideraAvosPerdidos ){ imprimir "Configuração considera avos perdidos" } //Indicativo se deve deve pagar décimo terceiro nas férias, retorna true ou false if ( calculo.pagarDecimoTerceiroFerias ){ imprimir "Configurado para pagar adiantamento de décimo terceiro nas férias" } //Retorna verdadeiro se cálculo atual foi executado de forma individual if ( calculo.individual ){ imprimir "Este cálculo foi feito de forma individual" } //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 ){ imprimir "Configurado para gerar rescisão automática de vínculos temporários" } //Indicativo se o parâmetro de cálculo para descontar faltas sobre férias esta setado, retorna true ou false if ( calculo.descontarFaltasSobreFerias ){ imprimir "Configurado para descontar faltas sobre férias" } //Soma os valores totais do cálculo para um tipo de evento passado no argumento //Eventos que usem este método devem ser calculado por último, marcando o parâmetro 'Calcular por último' no cadastro de eventos /** * | Parâmetro | Descrição | Obrigatório | * | ---------- | ------------------------------------------------- | ----------- | * | TipoEvento | o tipo do evento. use TipoEvento.[tipo do evento] | Sim | */ BigDecimal vencimentos = calculo.soma(TipoEvento.VENCIMENTO) BigDecimal descontos = calculo.soma(TipoEvento.DESCONTO) BigDecimal liquido = vencimentos - descontos; //Retorna o motivo da rescisão String motivo = calculo.motivoRescisao //Retorna o saldo do FGTS informado no parâmetro de cálculo da rescisão BigDecimal saldoFgts = calculo.saldoFgts //Retorna se é aviso prévio indenizado Boolean avisoPrevioIndenizado = calculo.avisoPrevioIndenizado //Retorna a quantidade de dias do aviso prévio int quantidadeDiasAvisoPrevio = calculo.quantidadeDiasAvisoPrevio //Retorna o campo repor vaga informado no parâmetro de cálculo da rescisão Boolean reporVaga = calculo.reporVaga //Retorna o campo trabalhou no dia da rescisão informado no parâmetro de cálculo da rescisão Boolean trabalhouDiaRescisao = calculo.trabalhouDiaRescisao


estagiario Retorna os dados da matrícula que sejam do tipo estagiário no cálculo

formaPagamento - Retorna a Forma de pagamento do estagiário

grupoFuncional - Retorna o Grupo funcional do estagiário

planoSalarial - Retorna o plano salarial do estagiário

classeSalarial - Retorna a classe salarial do estagiário

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

nivelSalarial - Retorna o nível salarial do estagiário

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

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

recebeDecimoTerceiro - Indicativo se o estagiário recebe décimo terceiro salário conforme a configuração do cargo

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

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

dataInicioEstagio - Retorna a Data de início do estágio

dataFinalEstagio - Retorna a Data final do estágio

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

agenciaPagamento - Retorna a Agencia de pagamento do estagiário

bancoPagamento - Retorna o Banco de pagamento do estagiário

nivelSalarialCoeficiente - Indica se o nível salarial do estagiário possui coefiente

//Retorna a Forma de pagamento do estagiário if ( estagiario.formaPagamento == FormaPagamento.DINHEIRO ){ imprimir "Forma de pagamento é em dinheiro" } //Retorna o Grupo funcional do estagiário String grupoFuncional = estagiario.grupoFuncional //Retorna a descrição do Cargo do estagiário String cargo = estagiario.cargo //Retorna o plano salarial do estagiário String planoSalarial = estagiario.planoSalarial //Retorna a classe salarial do estagiário String classeSalarial = estagiario.classeSalarial //Retorna a data da prorrogação do estágio if ( estagiario.dataProrrogacao != null ){ Date dataProrrogacao = estagiario.dataProrrogacao } //Retorna o nível salarial do estagiário String nivel = estagiario.nivelSalarial //Retorna a quantidade de horas mês do estagiário BigDecimal quantidadeHorasMes = estagiario.quantidadeHorasMes if ( quantidadeHorasMes < BigDecimal.valueOf(100) ){ imprimir "Quantidade de horas mês é menor que 100" } //Retorna a descrição do organograma do estagiário String descricaoOrganograma = estagiario.descricaoOrganograma //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' } //Retorna os Dias de direito de férias conforme configuração de férias int diasDireitoFerias = estagiario.diasDireitoFerias //Retorna os Meses para aquisição de férias conforme configuração de férias int mesesAquisicaoFerias = estagiario.mesesAquisicaoFerias //Retorna a Data de início do estágio Date dataInicioEstagio = estagiario.dataInicioEstagio //Retorna o valor da bolsa de estudos, essa é a remuneração do estagiário BigDecimal bolsaEstudos = estagiario.bolsaEstudos //Retorna a Data final do estágio Date dataFinalEstagio = estagiario.dataFinalEstagio //Retorna a Agencia de pagamento do estagiário String agenciaPagamento = estagiario.agenciaPagamento //Retorna o Banco de pagamento do estagiário String bancoPagamento = estagiario.bancoPagamento //Retorna o Coenficiente do nível salarial do estagiário Boolean nivelSalarialCoeficiente = estagiario.nivelSalarialCoeficiente


evento Retorna as informações da configuração do evento

codigo - Retorna o Código do evento

taxa - Retorna a taxa do evento atual

getTaxa() - Retorna a taxa de um outro evento passado por parâmetro

tipo - Retorna

unidade - Retorna

descricaoClassificacao - Retorna

classificacao - Retorna a classificação do evento

replicado - Seta um evento como replicado no cálculo

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

//Retorna o Código do evento Long codigo = evento.codigo //Retorna a taxa do evento atual BigDecimal taxa = evento.taxa valorCalculado = funcionario.salario * taxa / 100 //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 | */ BigDecimal taxa = evento.getTaxa(26) valorCalculado = funcionario.salario * taxa / 100 //Retorna a descrição do evento String descricao = evento.descricao if ( descricao.startsWith('HORAS EXTRAS'){ imprimir "$evento.descricao inicia com 'HORAS NORMAIS'" } //Retorna o tipo do evento if ( evento.tipo == TipoEvento.VENCIMENTO ){ imprimir "tipo do evento é vencimento" } //Retorna a unidade do evento if ( evento.unidade == UnidadeEvento.DIAS ){ imprimir "unidade do evento é em dias" } //Retorna a descrição da classificação do evento String descricaoClassificacao = evento.descricaoClassificacao //Retorna a classificação do evento if ( evento.classificacao == ClassificacaoEvento.INSS ){ imprimir "a classificação do evento é inss" } //Seta um evento como replicado no cálculo, este método é reponsável por marcar um evento na mensal como replicado de férias if ( valorCalculado > 0){ evento.replicado(true) }


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

subTipoProcessamento - Retorna o subtipo de processamento

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

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

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

dataPagamento - Retorna a data de pagamento da folha

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

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

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

competencia - Retorna a competência da folha

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

inicioGozoFeriasCalculadas - Retorna o inicio do gozo de férias se for uma folha de férias

fimGozoFeriasCalculadas - Retorna o inicio do gozo de férias se for uma folha de férias

calculoVirtual - Indica se é um calculo virtual de férias ou décimo terceiro salário

//Retorna o Tipo de processamento da folha if ( folha.tipoProcessamento == TipoProcessamento.MENSAL ){ imprimir "É uma folha mensal" } //Retorna o subtipo de processamento if ( folha.subTipoProcessamento == SubTipoProcessamento.INTEGRAL ){ imprimir "subtipo de processamento integral" } //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 -> imprimir "codigo do evento : $e.codigo" imprimir "descricao do evento : $e.descricao" imprimir "taxa do evento : $e.taxa" } //Retorna os dias de gozo de férias quando o tipo de processamento é férias int diasGozo = folha.diasGozo //Retorna os dias de abono de férias quando o tipo de processamento é férias int diasAbono = folha.diasAbono //Retorna a data de pagamento da folha String dataPagamento = folha.dataPagamento.toString() //retorna um localdate 'yyyy-MM-dd' //Retorna o total bruto da folha, essa