Fórmulas e Funções

Mantenha seu pacote de eventos para migração atualizado

Aqui você encontra a última versão do pacote de eventos para migração, clique e baixe.

Atualizado em 14/05/2024.

Fórmulas e Funções

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

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

buscaPorFaltas()

Permite buscar os afastamentos do tipo "Faltas" de uma matrícula, informando se deseja buscar as faltas a partir da competência de desconto ou se deseja buscar os abonos a partir da competência de abono.

Parâmetro	Descrição	Obrigatório
abono/falta	Informe se vai buscar um tipo de abono ou falta	Sim
competência de abono ou falta	Competência que será utilizada para buscar faltas ou os abonos das faltas. Caso a opção "abono/falta" esteja informada como "Abono", será considerada a competência de abono informada e caso esteja informada como "Falta", será considerada a competência de desconto da falta	Sim

//Utilizada na função para fórmula: buscaPorFaltas
def faltas = Afastamentos.buscaPorFaltas(AbonoFalta.FALTA, calculo.competencia)

def inicioAfast
def fimAfast
double horas
double dias

faltas.each { falta ->
    inicioAfast = Datas.data(Datas.ano(falta.inicio),Datas.mes(falta.inicio),Datas.dia(falta.inicio))
    fimAfast = Datas.data(Datas.ano(falta.fim),Datas.mes(falta.fim),Datas.dia(falta.fim))
    if (falta.unidade.toString() == 'DIAS') {
        dias += falta.quantidade
    } else {
        horas += falta.quantidade
    }
}

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

//Utilizada na função para fórmula: 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()

Busca os dias dentro da competência dos acidentes ou auxílio 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.

Exemplo: caso o afastamento 1 seja um acidente de trabalho do empregador, que origine o afastamento 2 sendo esse também um acidente de trabalho do empregador, o qual origine o afastamento 3 que é um afastamento de trabalho da previdência, a função retornará os dias dos afastamentos 1 e 2 que estejam dentro da competência de cálculo, mesmo que o afastamento 3 já esteja em uma competência posterior.

Observação: os dias de isenção serão calculados apenas para competências 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: Agente público, Agente político, Servidor Público (Cargo Comissionado), Servidor Público (Cargo Efetivo), 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)
...

valorRra()

Permite buscar os valores da base de cálculo de um Rendimento Recebido Acumuladamente (RRA) informados no período de referência da parcela quando realizado o lançamento da folha principal de pagamento anterior.

Parâmetro	Descrição	Obrigatório
tipo de base	Informar um tipo de base, use Bases.[sigla da base]	Sim

/**
* Utilizado no evento: BASE I.R.R.F. RRA
*/

//É importante se atentar a dependências de fórmulas quando for referênciar outra base
base = Bases.valorRra(Bases.IRRF) + Bases.valorRra(Bases.IRRF13)
...

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

baseInss - Valor de base do INSS
baseIrrf - Valor de base do IRRF
valorRetidoInss - Valor do INSS descontado em outra empresa
valorRetidoIrrf - Valor do IRRF descontado em outra empresa

Diarias

buscaPorPeriodo()

Busca as diárias lançadas para a matrícula no sistema de Recursos Humanos conforme o período informado. A função possui duas variações: uma que permite carregar as diárias vigentes durante a data inicial e data final informadas e outra que permite carregar as diárias conforme a data inicial, data final e descrição da natureza da diária informadas

Parâmetro	Descrição	Obrigatório
dataInicial	Informe a data inicial para buscar as diárias	Sim
dataFinal	Informe a data final para buscar as diárias	Sim

def dataInicial = Funcoes.inicioCompetencia()
def dataFinal = Funcoes.fimCompetencia()

def diarias = Diarias.buscaPorPeriodo(dataInicial, dataFinal)
if (diarias.size() <= 0) { suspender "Não foram encontradas diárias no período informado" }

diarias.each { diaria ->
    imprimir "Data da autorização: " + diaria.dataAutorizacao
    imprimir "Total de despesas: " + diaria.totalDespesas
    diaria.despesas.each { despesa -> 
        imprimir "Quantidade: "  + despesa.quantidade
        imprimir "Valor unitário: " + despesa.valorUnitario
        imprimir "Valor total: " + despesa.valorTotal
        if (despesa.naturezaDiaria != null) {
            imprimir "ID da natureza da diária: " + despesa.naturezaDiaria.id
            imprimir "Natureza da diária: " + despesa.naturezaDiaria.descricao
        }
    }
}

Parâmetro	Descrição	Obrigatório
dataInicial	Informe a data inicial para buscar as diárias	Sim
dataFinal	Informe a data final para buscar as diárias	Sim
descricaoNaturezaDiaria	Descrição da natureza de diária a ser considerada	Sim

def dataInicial = Funcoes.inicioCompetencia()
def dataFinal = Funcoes.fimCompetencia()
def descricaoNaturezaDiaria = 'Diaria'

def diarias = Diarias.buscaPorPeriodo(dataInicial, dataFinal, descricaoNaturezaDiaria)
if (diarias.size() <= 0) { suspender "Não foram encontradas diárias que tenham a natureza de diária no período informado" }

diarias.each { diaria ->
    imprimir "Data da autorização: " + diaria.dataAutorizacao
    imprimir "Total de despesas: " + diaria.totalDespesas
    diaria.despesas.each { despesa -> 
        imprimir "Quantidade: "  + despesa.quantidade
        imprimir "Valor unitário: " + despesa.valorUnitario
        imprimir "Valor total: " + despesa.valorTotal
        if (despesa.naturezaDiaria != null) {
            imprimir "ID da natureza da diária: " + despesa.naturezaDiaria.id
            imprimir "Natureza da diária: " + despesa.naturezaDiaria.descricao
        }
    }
}

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)

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

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)

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

//Utilizada 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 configurado na manutenção de estabelecimentos para a vigência calculada

salarioMinimo - Retorna o salário mínimo configurado na manutenção de estabelecimentos para a vigência calculada

tetoSalarial - Retorna o teto salarial configurado na manutenção de estabelecimentos para a vigência calculada

inicioVigencia - Retorna o inicio da vigência configurada na manutenção de estabelecimentos para a vigência calculada

cnaePreponderante - Retorna o CNAE preponderante configurado na manutenção de estabelecimentos para a vigência calculada

codigoFpas - Retorna o código FPAS configurado na manutenção de estabelecimentos para a vigência calculada

codigoTerceiros - Retorna o código de terceiros configurado na manutenção de estabelecimentos para a vigência calculada

percentualFap - Retorna o percentual do FAP configurado na manutenção de estabelecimentos para a vigência calculada

percentualGilRat - Retorna o percentual do RAT configurado na manutenção de estabelecimentos para a vigência calculada

percentualInssEmpregador - Retorna o percentual do INSS empregador configurado na manutenção de estabelecimentos para a vigência calculada

percentualIsencaoFilantropia - Retorna o percentual de isenção de entidade filantrópica configurado na manutenção de estabelecimentos para a vigência calculada

percentualTerceiros - Retorna o percentual de terceiros configurado na manutenção de estabelecimentos para a vigência calculada

/**
 * As variáveis abaixo buscarão as informações em "Configurando > Cálculo > Manutenções de Estabelecimento"
 * conforme vigência e competência calculada
 */

//Retorna o piso salarial informado para a entidade
BigDecimal pisoSalarial = EncargosSociais.pisoSalarial

//Retorna o salário mínimo informado para a entidade
BigDecimal salarioMinimo = EncargosSociais.salarioMinimo

//Retorna o teto salarial da entidade
BigDecimal tetoSalarial = EncargosSociais.tetoSalarial

//Retorna a vigência no formato YearMonth - no exemplo foi convertido para uma string em formato 'yyyy-MM'
inicioVigencia = EncargosSociais.inicioVigencia.toString()

//Retorna o CNAE preponderante da entidade
def cnaePreponderante = EncargosSociais.cnaePreponderante

//Retorna o código FPAS da entidade
def codigoFpas = EncargosSociais.codigoFpas
if (EncargosSociaisFpas.ENTIDADE_BENEFICENTE.equals(codigoFpas) {
    imprimir "É uma entidade beneficiente"
)

//Retorna o código de terceiros da entidade
def codigoTerceiros = EncargosSociais.codigoTerceiros

//Retorna o percentual do FAP da entidade
def percentualFap = EncargosSociais.percentualFap

//Retorna o percentual do RAT da entidade
def percentualGilRat = EncargosSociais.percentualGilRat

//Retorna o percentual do INSS empregador da entidade
def percentualInssEmpregador = EncargosSociais.percentualInssEmpregador

//Retorna o percentual de isenção de entidade filantrópica
def percentualIsencaoFilantropia = EncargosSociais.percentualIsencaoFilantropia

//Retorna o percentual de terceiros da entidade
def percentualTerceiros = EncargosSociais.percentualTerceiros

Encargos Sociais:

EncargosSociais
AssistenciaMunicipal - Grupo de informações relacionadas a assistência municipal
buscaContribuicao() - Retorna um valor da coluna em uma faixa encontrada conforme o valor informado na assistência municipal

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.AssistenciaMunicipal.buscaContribuicao(valorbase, 2)

EncargosSociais
AssistenciaMunicipal - Grupo de informações relacionadas a assistência municipal
buscaMaior() - Retorna a coluna referente faixa de maior valor encontrada conforme o valor informado na assistência municipal

Parâmetro	Descrição	Obrigatório
coluna	coluna que deve retornar	Sim

BigDecimal tetoInss = EncargosSociais.AssistenciaMunicipal.buscaMaior(1)

BigDecimal maiorAliquota = EncargosSociais.AssistenciaMunicipal.buscaMaior(2)

EncargosSociais
AssistenciaMunicipal - Grupo de informações relacionadas a assistência municipal
buscaTabela() - Retorna a tabela da assistência municipal vigente na competência de cálculo com as respectivas alíquota e valor máximo estabelecidos

//exemplo semelhante ao cálculo progressivo do INSS existente na função para fórmula "calculoProgressivoINSS"
double baseAssistMun = Bases.valor(Bases.FUNDASS)

double valorLimiteFaixa
double valorLimiteFaixaAnterior
double valorDaAliquota
double resultado

def tabela = EncargosSociais.AssistenciaMunicipal.buscaTabela().sort { it.aliquota }
for (faixa in tabela) {
    valorLimiteFaixa = faixa.valorMaximo
    if (baseAssistMun < valorLimiteFaixa) { valorLimiteFaixa = baseAssistMun }

    valorDaAliquota = (valorLimiteFaixa - valorLimiteFaixaAnterior) * faixa.aliquota / 100
    if (valorDaAliquota < 0.01) valorDaAliquota = 0

    resultado += Numeros.trunca(valorDaAliquota, 2)
    valorLimiteFaixaAnterior = faixa.valorMaximo

    if (baseAssistMun <= valorLimiteFaixa) break
}
return resultado

EncargosSociais
AssistenciaMunicipal - Grupo de informações relacionadas a assistência municipal
maximo - Valor máximo de desconto de assistência municipal
minimo - Valor mínimo de desconto de assistência municipal
indiceAporte - Retorna o índice do aporte de assistência municipal
taxaAdministrativa - Retorna a taxa administrativa de assistência municipal

//Máximo de desconto
maximoFundoAssistencia = EncargosSociais.AssistenciaMunicipal.maximo

//Mínimo de desconto
minimoFundoAssistencia = EncargosSociais.AssistenciaMunicipal.minimo

//Índice do aporte
indiceAporteFundoAssistencia = EncargosSociais.AssistenciaMunicipal.indiceAporte

//Taxa administrativa
taxaAdministrativaFundoAssistencia = EncargosSociais.AssistenciaMunicipal.taxaAdministrativa

EncargosSociais
FGTS - Grupo de informações relacionadas ao 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 - Grupo de informações relacionadas ao IRRF
buscaContribuicao() - Retorna um valor da coluna em uma faixa encontrada conforme o valor informado de um IRRF

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
IRRF - Grupo de informações relacionadas ao IRRF
buscaMaior() - Retorna a coluna referente faixa de maior valor encontrada conforme o valor informado de um IRRF

Parâmetro	Descrição	Obrigatório
coluna	coluna que deve retornar	Sim

BigDecimal tetoInss = EncargosSociais.IRRF.buscaMaior(1)

BigDecimal maiorAliquota = EncargosSociais.IRRF.buscaMaior(2)

EncargosSociais
IRRF - Grupo de informações relacionadas ao IRRF
deducaoPorDependente - Retorna o valor de dedução por dependente
deducaoSimplificadaIrrf - Retorna o valor da dedução simplificada do IRRF
minimoIrrfDarf - Retorna o valor mínimo de desconto de IRRF
parcelaIsentaAposentadoria - Retorna o da parcela de isenta de aposentadoria

//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 configurado para a dedução simplificada do I.R.R.F., essa informação fica no grupo IRRF_
//Utilizado no evento: DEDUCAO DO IRRF MENSAL - SIMPLIFICADO
BigDecimal deducaoSimplificadaIrrf = EncargosSociais.IRRF.deducaoSimplificadaIrrf

//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
RGPS - Grupo de informações relacionadas a previdência federal
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 - Grupo de informações relacionadas a previdência federal
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
RGPS - Grupo de informações relacionadas a previdência federal
buscaTabela() - Retorna a tabela da previdência federal vigente na competência de cálculo com as respectivas alíquota e valor máximo estabelecidos

//exemplo semelhante ao existente na função para fórmula "calculoProgressivoINSS"
double baseInss = Bases.valor(Bases.INSS)

double valorLimiteFaixa
double valorLimiteFaixaAnterior
double valorDaAliquota
double resultado

def tabela = EncargosSociais.RGPS.buscaTabela().sort { it.aliquota }
for (faixa in tabela) {
    valorLimiteFaixa = faixa.valorMaximo
    if (baseInss < valorLimiteFaixa) { valorLimiteFaixa = baseInss }

    valorDaAliquota = (valorLimiteFaixa - valorLimiteFaixaAnterior) * faixa.aliquota / 100
    if (valorDaAliquota < 0.01) valorDaAliquota = 0

    resultado += Numeros.trunca(valorDaAliquota, 2)
    valorLimiteFaixaAnterior = faixa.valorMaximo

    if (baseInss <= valorLimiteFaixa) break
}
return resultado

EncargosSociais
RPPS - Grupo de informações relacionadas ao Regime Próprio da Previdência Social
FundoFinanceiro - Retorna os dados do fundo financeiro
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
RPPS - Grupo de informações relacionadas ao Regime Próprio da Previdência Social
FundoFinanceiro - Retorna os dados do fundo financeiro
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
RPPS - Grupo de informações relacionadas ao Regime Próprio da Previdência Social
FundoFinanceiro - Retorna os dados do fundo financeiro
buscaTabela() - Retorna a tabela da fundo financeiro vigente na competência de cálculo com as respectivas alíquota e valor máximo estabelecidos

//exemplo semelhante ao cálculo progressivo do INSS existente na função para fórmula "calculoProgressivoINSS"
double baseFundoFin = Bases.valor(Bases.FUNDFIN)

double valorLimiteFaixa
double valorLimiteFaixaAnterior
double valorDaAliquota
double resultado

def tabela = EncargosSociais.RPPS.FundoFinanceiro.buscaTabela().sort { it.aliquota }
for (faixa in tabela) {
    valorLimiteFaixa = faixa.valorMaximo
    if (baseFundoFin < valorLimiteFaixa) { valorLimiteFaixa = baseFundoFin }

    valorDaAliquota = (valorLimiteFaixa - valorLimiteFaixaAnterior) * faixa.aliquota / 100
    if (valorDaAliquota < 0.01) valorDaAliquota = 0

    resultado += Numeros.trunca(valorDaAliquota, 2)
    valorLimiteFaixaAnterior = faixa.valorMaximo

    if (baseFundoFin <= valorLimiteFaixa) break
}
return resultado

EncargosSociais
RPPS - Grupo de informações relacionadas ao Regime Próprio da Previdência Social
FundoFinanceiro - Retorna os dados do fundo financeiro
maximo - Valor máximo de desconto do fundo financeiro
minimo - Valor mínimo de desconto do fundo financeiro
indiceAporte - Retorna o índice do fundo financeiro própria
taxaAdministrativa - Retorna a taxa administrativa do fundo financeiro

//Máximo de desconto
maximoFundoFinanceiro = EncargosSociais.RPPS.FundoFinanceiro.maximo

//Mínimo de desconto
minimoFundoFinanceiro = EncargosSociais.RPPS.FundoFinanceiro.minimo

//Índice do aporte
indiceAporteFundoFinanceiro = EncargosSociais.RPPS.FundoFinanceiro.indiceAporte

//Taxa administrativa
taxaAdministrativaFundoFinanceiro = EncargosSociais.RPPS.FundoFinanceiro.taxaAdministrativa

EncargosSociais
RPPS - Grupo de informações relacionadas ao Regime Próprio da Previdência Social
PrevidenciaEstadual - Retorna os dados da previdência estadual
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 - Grupo de informações relacionadas ao Regime Próprio da Previdência Social
PrevidenciaEstadual - Retorna os dados da previdência estadual
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 - Grupo de informações relacionadas ao Regime Próprio da Previdência Social
PrevidenciaEstadual - Retorna os dados da previdência estadual
buscaTabela() - Retorna a tabela da previdência estadual vigente na competência de cálculo com as respectivas alíquota e valor máximo estabelecidos

//exemplo semelhante ao cálculo progressivo do INSS existente na função para fórmula "calculoProgressivoINSS"
double basePrevEst = Bases.valor(Bases.PREVEST)

double valorLimiteFaixa
double valorLimiteFaixaAnterior
double valorDaAliquota
double resultado

def tabela = EncargosSociais.RPPS.PrevidenciaEstadual.buscaTabela().sort { it.aliquota }
for (faixa in tabela) {
    valorLimiteFaixa = faixa.valorMaximo
    if (basePrevEst < valorLimiteFaixa) { valorLimiteFaixa = basePrevEst }

    valorDaAliquota = (valorLimiteFaixa - valorLimiteFaixaAnterior) * faixa.aliquota / 100
    if (valorDaAliquota < 0.01) valorDaAliquota = 0

    resultado += Numeros.trunca(valorDaAliquota, 2)
    valorLimiteFaixaAnterior = faixa.valorMaximo

    if (basePrevEst <= valorLimiteFaixa) break
}
return resultado

EncargosSociais
RPPS - Grupo de informações relacionadas ao Regime Próprio da Previdência Social
PrevidenciaEstadual - Retorna os dados da previdência estadual
maximo - Valor máximo de desconto da previdência estadual
minimo - Valor mínimo 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

//Máximo de desconto
maximoPrevidenciaEstadual = EncargosSociais.RPPS.PrevidenciaEstadual.maximo

//Mínimo de desconto
minimoPrevidenciaEstadual = EncargosSociais.RPPS.PrevidenciaEstadual.minimo

//Índice do aporte
indiceAportePrevidenciaEstadual = EncargosSociais.RPPS.PrevidenciaEstadual.indiceAporte

//Taxa administrativa
taxaAdministrativaPrevidenciaEstadual = EncargosSociais.RPPS.PrevidenciaEstadual.taxaAdministrativa

EncargosSociais
RPPS - Grupo de informações relacionadas ao Regime Próprio da Previdência Social
PrevidenciaPropria - Retorna os dados da previdência própria
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 - Grupo de informações relacionadas ao Regime Próprio da Previdência Social
PrevidenciaPropria - Retorna os dados da previdência própria
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 - Grupo de informações relacionadas ao Regime Próprio da Previdência Social
PrevidenciaPropria - Retorna os dados da previdência própria
buscaTabela() - Retorna a tabela da previdência própria vigente na competência de cálculo com as respectivas alíquota e valor máximo estabelecidos

//exemplo semelhante ao cálculo progressivo do INSS existente na função para fórmula "calculoProgressivoINSS"
double baseFundoPrev = Bases.valor(Bases.FUNDOPREV)

double valorLimiteFaixa
double valorLimiteFaixaAnterior
double valorDaAliquota
double resultado

def tabela = EncargosSociais.RPPS.PrevidenciaPropria.buscaTabela().sort { it.aliquota }
for (faixa in tabela) {
    valorLimiteFaixa = faixa.valorMaximo
    if (baseFundoPrev < valorLimiteFaixa) { valorLimiteFaixa = baseFundoPrev }

    valorDaAliquota = (valorLimiteFaixa - valorLimiteFaixaAnterior) * faixa.aliquota / 100
    if (valorDaAliquota < 0.01) valorDaAliquota = 0

    resultado += Numeros.trunca(valorDaAliquota, 2)
    valorLimiteFaixaAnterior = faixa.valorMaximo

    if (baseFundoPrev <= valorLimiteFaixa) break
}
return resultado

EncargosSociais
RPPS - Grupo de informações relacionadas ao Regime Próprio da Previdência Social
PrevidenciaPropria - Retorna os dados da previdência própria
maximo - Valor máximo de desconto da previdência própria
minimo - Valor mínimo 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

//Máximo de desconto
maximoPrevidenciaPropria = EncargosSociais.RPPS.PrevidenciaPropria.maximo

//Mínimo de desconto
minimoPrevidenciaPropria = EncargosSociais.RPPS.PrevidenciaPropria.minimo

//Índice do aporte
indiceAportePrevidenciaPropria = EncargosSociais.RPPS.PrevidenciaPropria.indiceAporte

//Taxa administrativa
taxaAdministrativaPrevidenciaPropria = EncargosSociais.RPPS.PrevidenciaPropria.taxaAdministrativa

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)

Empréstimos

Emprestimos
busca()

Retorna uma lista de empréstimos cadastrados no RH. Permite que os resultados sejam filtrados conforme a situação do empréstimo.

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

id - Id do empréstimo
dataInicial - Data inicial do empréstimo
dataFinal - Data de final do empréstimo (última parcela)
pessoaJuridica - Data de fim do atestado no formato yyyy-MM-dd
dataInicioDesconto - Data inicial do desconto (primeira parcela)
numeroContrato - Número do contrato do empréstimo
verba - Verba do empréstimo
valorTotal - Valor total do empréstimo
numeroParcelas - Número total de parcelas
situacao - Situação do empréstimo
parcelas - Lista de parcelas do empréstimo
id - Id da parcela
numero - Número da parcela
valorParcela - Valor da parcela
dataPagamento - Data de pagamento da parcela
situacao - Situação da parcela

Emprestimos
pagarParcela()

Realiza a baixa da parcela de empréstimo no RH conforme os parâmetros informados na função.

Parâmetro	Descrição	Obrigatório
emprestimoId	Identificador do empréstimo. A informação pode ser obtida percorrendo Emprestimos.busca()	Sim
parcelaId	Identificador da parcela. A informação pode ser obtida 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

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

Lançamentos

Lancamentos
valor()

Verifica se o evento que está 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 está 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

PlanoSaudeDespesas
buscaDespesasPlanoSaude()

Busca uma lista de despesas com planos de saúde.

/*
    Utilizando o formato abaixo, carregará todas as despesas de planos de saúde da matrícula
    cadastradas para o ano em que o cálculo está sendo efetuado
*/
PlanoSaudeDespesas.buscaDespesasPlanoSaude().each { despesa ->
    if (despesa.tipo == TipoDespesaPlanoSaude.MENSALIDADE) {
        vaux += despesa.valor
    }
}

/*
    Utilizando o formato abaixo, carregará apenas as despesas de planos de saúde da matrícula
    cadastradas na competência informada - no caso abaixo, será a competência de cálculo
*/
PlanoSaudeDespesas.buscaDespesasPlanoSaude(calculo.competencia).each { despesa ->
    if (despesa.tipo == TipoDespesaPlanoSaude.MENSALIDADE) {
        vaux += despesa.valor
    }
}

Campos disponíveis em PlanoSaudeDespesas.buscaDespesasPlanoSaude()

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
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
procedimentoMedico - Procedimento realizado
valor - Valor da despesa (com subsídio)
tipo - Tipo de despesa
valorTotal - Valor total da despesa
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

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

dataInicial - Data inicial do período aquisitivo
dataFinal - Data final do período aquisitivo
faltas - Quantidade de faltas
faltasBrutas - Quantidade de faltas brutas
faltasEnquadradas - Quantidade de faltas enquadradas
diasPagosRescisao - Dias de férias pagos em rescisão
cancelados - Quantidade de dias cancelados
suspensos - Quantidade de dias suspensos
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)
situacao - Situação do período aquisitivo
saldo - saldo de dias do período aquisitivos
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
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
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().

dataInicial - Data inicial do período aquisitivo
dataFinal - Data final do período aquisitivo
faltas - Quantidade de faltas
faltasBrutas - Quantidade de faltas brutas
faltasEnquadradas - Quantidade de faltas enquadradas
diasPagosRescisao - Dias de férias pagos em rescisão
cancelados - Quantidade de dias cancelados
suspensos - Quantidade de dias suspensos
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)
situacao - Situação do período aquisitivo
saldo - saldo de dias do período aquisitivos
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
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
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().

dataInicial - Data inicial do período aquisitivo
dataFinal - Data final do período aquisitivo
faltas - Quantidade de faltas
faltasBrutas - Quantidade de faltas brutas
faltasEnquadradas - Quantidade de faltas enquadradas
diasPagosRescisao - Dias de férias pagos em rescisão
cancelados - Quantidade de dias cancelados
suspensos - Quantidade de dias suspensos
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)
situacao - Situação do período aquisitivo
saldo - saldo de dias do período aquisitivos
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
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
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 está sendo calculado	Sim
valorReferencia	O valor de referência do evento que está 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 está 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)
    ...
}

Periodos Aquisitivos Decimo Terceiro

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

dataInicial - Data inicial do período aquisitivo
dataFinal - Data final do período aquisitivo
avosAdquiridos - Avos adquiridos
avosAdquiridosFgts - Avos adquiridos para FGTS
avosPerdidos - Avos perdido
avosDireito - Avos de direito
situacao - Situação do período aquisitivo
anoExercicio - Ano de exercício do período aquisitivo
competenciaFechamentoProvisao - Competência de fechamento da provisão
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().

dataInicial - Data inicial do período aquisitivo
dataFinal - Data final do período aquisitivo
avosAdquiridos - Avos adquiridos
avosAdquiridosFgts - Avos adquiridos para FGTS
avosPerdidos - Avos perdido
avosDireito - Avos de direito
situacao - Situação do período aquisitivo
anoExercicio - Ano de exercício do período aquisitivo
competenciaFechamentoProvisao - Competência de fechamento da provisão
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 está 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)
}

Periodos Aquisitivos Férias

Para calcular as férias dos funcionários com alteração de carga horária durante o período aquisitivo, o sistema permite fazer o cálculo das férias pagando a média dos meses do período aquisitivo.

Temos a função MediaHoras.calcular() que considera a Média da carga horária do período, permitindo indicar o período desejado, composta por:

Período:

Data ou Competência inicial = Definir data a ser considerada.

Caso a data ou competência inicial não seja informada, o sistema considera a data inicial da competência de cálculo.

Data ou Competência final = Definir data a ser considerada.

Lembramos que quando a data ou competência final não for informada, o sistema considera a data ou competência cálculo.

Vamos compreender melhor esse cálculo:

Exemplo 1:

Período aquisitivo 01/05/2022 à 30/04/2023, sendo a carga horária mensal de 01/05/2022 a 30/11/2022 de 150 horas, e a partir de 01/12/2022 a 30/04/2023 alterou para 200 horas.

Ao calcular as férias, o evento de férias vai considerar o salário atual do funcionário e pagar sobre 170,83 horas:

(01/05/2022 à 30/11/2022) = 7 * 150 = 1050

(01/12/2022 à 30/04/2023) = 5 * 200 = 1000

Somatória de carga horária no período = 2050 2050/12 = 170,83

Considerando salário mensal na competência de gozo de férias com valor de R$ 1.000,00, o valor do evento de horas férias seria de R$ 854,15 (1000 (Salário) / 200 (Carga horária atual) * 170,83 (carga horária no período) = 854,15 (valor que deve ser calculado no evento).

Exemplo 2:

Período 01/05/2022 à 30/04/2023, sendo a carga horária de 150 horas até 10/11/2022, e a partir de 11/11/2022 alterado para 200 horas.

Neste caso, ao calcular as férias deve ser calculado carga horária de 173,61:

(01/05/2022 à 31/10/2022) = 6 * 150 = 900

(01/11/2022 à 10/11/2022) = 150 / 30 = 5 * 10 = 50

(11/11/2022 à 30/11/2022) = 200 / 30 = 6,66 * 20 = 133,33

(01/12/2022 à 30/04/203) = 200 * 5 = 1000

Somatória de carga horária no período = 2083,33

2083,33 / 12 = 173,61

Reembolso PlanoSaude

*buscaValor(TipoSegurado, TipoReembolso, TipoValorReembolso).

Por meio deste método é possível buscar as informações dos reembolsos de plano de saúde cadastradas no sistema de RH.

Parâmetros:

TipoSegurado: filtra por tipo de segurado, podendo ser: titular, dependente ou ambos.
TipoReembolso: filtra por tipo de reembolso, podendo ser: reembolso pelo plano, reembolso pelo empregador ou ambos.
TipoValorReembolso: seleção do valor a ser retornado, podendo ser: ano corrente, anos anteriores ou ambos.

Exemplo:

//Retorna o total de despesas da competência do Cálculo
BigDecimal valor = ReembolsoPlanoSaude.buscaValor(TipoSegurado.AMBOS, TipoReembolso.AMBOS, TipoValorReembolso.AMBOS)

*buscaValor(Competencia, TipoSegurado, TipoReembolso, TipoValorReembolso)

Por meio deste método é possível buscar as informações dos reembolsos de plano de saúde cadastradas no sistema de RH na competência de cálculo informada.

Parâmetros:

Competencia: competência para buscar os reembolsos de plano de saúde.
TipoSegurado: filtra por tipo de segurado, podendo ser: titular, dependente ou ambos.
TipoReembolso: filtra por tipo de reembolso, podendo ser: reembolso pelo plano, reembolso pelo empregador ou ambos.
TipoValorReembolso: seleção do valor a ser retornado, podendo ser: ano corrente, anos anteriores ou ambos.

Exemplo:

//Retorna o total de despesas da competência informada. No exemplo abaixo, buscará a informação de 04/2023
BigDecimal valor = ReembolsoPlanoSaude.buscaValor(Datas.data(2023, 4, 1), TipoSegurado .AMBOS, TipoReembolso.AMBOS, TipoValorReembolso.AMBOS)

Vales Transporte

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

valorTotal - Valor total do vale transporte
tipoRetorno - Tipo de retorno

Variáveis reservadas

Aposentado

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

formaPagamento - Retorna a Forma de pagamento

grupoFuncional - Retorna o grupo funcional

recebeDecimoTerceiro - Indicativo se o aposentado recebe décimo terceiro salário conforme informado na ficha da matrícula

dataAposentadoria - Retorna a data de início 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 informada para o aposentado

bancoPagamento - Retorna o banco de pagamento informado para o aposentado

possuiFundoAssistencia - Retorna se o aposentado é optante da assistência municipal

possuiFundoFinanceiro - Retorna se o aposentado é optante do fundo de assistência

possuiPrevidenciaEstadual - Retorna se o aposentado é optante da previdência estadual

possuiPrevidenciaPropria - Retorna se o aposentado é optante da previdência própria

//Retorna a forma de pagamento
if (aposentado.formaPagamento == FormaPagamento.CHEQUE) {
    imprimir "A forma de pagamento é cheque"
}

//Retorna o grupo funcional
String grupoFuncional = aposentado.grupoFuncional

//Indicativo se o aposentado recebe décimo terceiro salário, retorna true ou false
Boolean recebeDecimoTerceiro = aposentado.recebeDecimoTerceiro

//Retorna a data de início 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
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 informada para o aposentado
String agenciaPagamento = aposentado.agenciaPagamento

//Retorna o banco de pagamento informado para o aposentado
String bancoPagamento = aposentado.bancoPagamento

//Indicativo se o aposentado possui fundo de assistência
Boolean possuiFundoAssistencia = aposentado.possuiFundoAssistencia

//Indicativo se o aposentado possui fundo financeiro
Boolean possuiFundoFinanceiro = aposentado.possuiFundoFinanceiro

//Indicativo se o aposentado possui previdência estadual
Boolean possuiPrevidenciaEstadual = aposentado.possuiPrevidenciaEstadual

//Indicativo se o aposentado possui previdência própria
Boolean possuiPrevidenciaPropria = aposentado.possuiPrevidenciaPropria

buscaPorCessacao()
Permite buscar os dados das cessações do aposentado que estão vigentes na competência que está sendo informada.

Parâmetro	Descrição	Obrigatório
competência	Competência que será utilizada para buscar as cessações cadastradas	Sim

//Utilizada na função para fórmula: diasaposent
def cessacoes = aposentado.buscaPorCessacao(calculo.competencia)

def inicioCes
def fimCes
def motivoCes
def descricaoCes
def cnpjOrgaoSucessorCes
def dataEfeitoFinanceiroCer

cessacoes.each { cessacao ->
    inicioCes = Datas.data(Datas.ano(cessacao.dataInicial),Datas.mes(cessacao.dataInicial),Datas.dia(cessacao.dataInicial))
    fimCes = Datas.data(Datas.ano(cessacao.dataFim),Datas.mes(cessacao.dataFim),Datas.dia(cessacao.dataFim))
    motivoCes = cessacao.motivo
    descricaoCes = cessacao.descricao
    cnpjOrgaoSucessorCes = cessacao.cnpjOrgaoSucessorCes
    dataEfeitoFinanceiroCer = Datas.data(Datas.ano(cessacao.dataEfeitoFinanceiro),Datas.mes(cessacao.dataEfeitoFinanceiro),Datas.dia(cessacao.dataEfeitoFinanceiro))
}

buscaPorSuspensao()
Permite buscar os dados das suspensões do aposentado que estão vigentes na competência que está sendo informada.

Parâmetro	Descrição	Obrigatório
competência	Competência que será utilizada para buscar as suspensões cadastradas	Sim

def suspensoes = aposentado.buscaPorCessacao(calculo.competencia)

def inicioSusp
def fimSusp
def motivoSusp
def descricaoSusp

suspensoes.each { suspensao ->
    inicioSusp = Datas.data(Datas.ano(suspensao.dataInicial),Datas.mes(suspensao.dataInicial),Datas.dia(suspensao.dataInicial))
    fimSusp = Datas.data(Datas.ano(suspensao.dataFim),Datas.mes(suspensao.dataFim),Datas.dia(suspensao.dataFim))
    motivoSusp = suspensao.motivo
    descricaoSusp = suspensao.descricao
}

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

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 referente ao último dia da competência que está sendo calculada
quantidadeDiasCompetencia - Retorna a quantidade de dias da competência que está 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 está 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 está setado
rra - Retorna verdadeiro se no cálculo a ser executado há um pagamento anterior com RRA vinculado e falso nos demais casos
soma() - Soma os valores totais do cálculo para um tipo de evento passado no argumento
motivoRescisao - Retorna os dados relacionados ao 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
calculo.recalcularMensal - Retorna se em cálculos de rescisão, a folha mensal foi recalculada na folha rescisória conforme seleção do parâmetro de cálculo
subFolhaPagamentoAnterior - Retorna se cálculo em execução é uma sub-folha de pagamento anterior
subFolhaDecimoTerceiro - Retorna se cálculo em execução é uma sub-folha de pagamento anterior com pagamento de 13º salário

//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 os dados relacionados ao motivo da rescisão
String descricao = calculo.motivoRescisao.descricao //Descrição do motivo de rescisão
String tipo = calculo.motivoRescisao.tipo //Tipo do motivo de rescisão
String classificacao = calculo.motivoRescisao.classificacao //Classificação do motivo de rescisão

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

//Retorna se há pagamento anterior com RRA vinculado ao cálculo executado
Boolean rra = calculo.rra

//Retorna se houve recálculo da folha mensal na folha de rescisão conforme parametrizado pelo usuário
Boolean recalcularMensal = calculo.recalcularMensal

//Retorna se cálculo em execução é uma sub-folha de pagamento anterior
Boolean subFolhaPagamentoAnterior = calculo.subFolhaPagamentoAnterior

//Retorna se cálculo em execução é uma sub-folha de pagamento anterior com pagamento de 13º salário
Boolean subFolhaDecimoTerceiro = calculo.subFolhaDecimoTerceiro

Estagiário

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 Agência 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, retorna true ou false
Boolean recebeDecimoTerceiro = estagiario.recebeDecimoTerceiro

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

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 está 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

folha - Permite buscar ou percorrer as informações da folha atual
calculoVirtual - Indica se é um calculo virtual de férias ou décimo terceiro salário
competencia - Retorna a competência da folha
complementoDecimoTerceiro - Ao calcular uma folha de 13º salário integral, indicará se já houve um cálculo de 13º salário integral anterior. Este cenário é permitido para os casos em que houve um cálculo anterior à Dezembro e, por força de exigência do eSocial, há necessidade de gerar outra folha em Dezembro com os valores atualizados
diasAbono - Retorna os dias de abono de férias quando o tipo de processamento é férias
diasGozo - Retorna os dias de gozo de férias quando o tipo de processamento é férias
dataPagamento - Retorna a data de pagamento da folha
eventos - Retorna uma lista de eventos calculados, essa variável só terá o efeito desejado se o evento está calculando por último
fimGozoFeriasCalculadas - Retorna o início do gozo de férias se for uma folha de férias
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 início do gozo de férias se for uma folha de férias
quantidadeMesesRra - Retorna a quantidade de meses que são referentes a um Rendimento Recebido Acumuladamente - RRA e estão sendo pagos na parcela da folha principal de pagamento anterior conforme definido pelo eSocial. Caso não houver RRA ou não se tratar da folha de pagamento anterior, retornará zero
subTipoProcessamento - Retorna o subtipo de processamento
tipoProcessamento - Retorna o tipo de processamento da folha
totalBruto - Retorna o total bruto da folha, essa variável só terá o efeito desejado se o evento está calculando por último
totalDesconto - Retorna o total de desconto da folha, essa variável só terá o efeito desejado se o evento está calculando por último
totalLiquido - Retorna o total líquido da folha, essa variável só terá o efeito desejado se o evento está calculando por último

//Indica se é um calculo virtual de férias ou décimo terceiro salário
if (folha.calculoVirtual) {
    imprimir "É uma folha de pagamento"
}else{
    imprimir "É uma folha de férias"
}

//Retorna a competência da folha
Date competencia = folha.competencia

//Ao calcular uma folha de 13º salário integral, indicará se já houve um cálculo de 13º salário integral anterior
Boolean complementoDecimoTerceiro = folha.complementoDecimoTerceiro

//Retorna a data de pagamento da folha
String dataPagamento = folha.dataPagamento.toString() //retorna um localdate 'yyyy-MM-dd'

//Retorna os dias de abono de férias quando o tipo de processamento é férias
int diasAbono = folha.diasAbono

//Retorna os dias de gozo de férias quando o tipo de processamento é férias
int diasGozo = folha.diasGozo

//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 "Código do evento : $e.codigo"
    imprimir "Descrição do evento : $e.descricao"
    imprimir "Tipo do evento : $e.tipo"
    imprimir "Classificação do evento : $e.classificacao"
    imprimir "Taxa do evento : $e.taxa"
    imprimir "Referência do evento : $e.referencia"
    imprimir "Valor do evento : $e.valor"
}

//Retorna o inicio do gozo de férias se for uma folha de férias
Date fimGozoFeriasCalculadas = folha.fimGozoFeriasCalculadas

//Indica se é uma folha de pagamento, quando não é uma folha de pagamento esta será uma folha interna de férias
if (folha.folhaPagamento) {
    imprimir "É uma folha de pagamento"
}else{
    imprimir "É uma folha interna de férias"
}

//Retorna o inicio do gozo de férias se for uma folha de férias
Date inicioGozoFeriasCalculadas = folha.inicioGozoFeriasCalculadas

//Retorna a quantidade de meses de RRA utilizados na folha calculada
if (TipoProcessamento.PAGAMENTO_ANTERIOR.equals(calculo.tipoProcessamento)) {
    double quantidadeMesesRra = folha.quantidadeMesesRra
}

//Retorna o subtipo de processamento
if (folha.subTipoProcessamento == SubTipoProcessamento.INTEGRAL) {
    imprimir "subtipo de processamento integral"
}

//Retorna o Tipo de processamento da folha
if (folha.tipoProcessamento == TipoProcessamento.MENSAL) {
    imprimir "É uma folha mensal"
}

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

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

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

folhaDecimoTerceiroIntegralAntecipado - Permite buscar ou percorrer as informações da folha de 13º salário integral adiantada em competência anterior à Dezembro quando está calculando uma folha de 13º salário integral em Dezembro. Este caso visa atender às exigências do eSocial.
competencia - Retorna a competência da folha de 13º integral adiantado
eventos - Retorna uma lista de eventos calculados na folha de 13º integral adiantado
subTipoProcessamento - Retorna o subtipo de processamento da folha de 13º integral adiantado
tipoProcessamento - Retorna o tipo de processamento da folha de 13º integral adiantado
totalBruto - Retorna o total bruto (proventos) da folha de 13º integral adiantado
totalDesconto - Retorna o total de descontos da folha de 13º integral adiantado
totalLiquido - Retorna o total líquido (proventos menos descontos) da folha de 13º integral adiantado

//Retorna a competência da folha de 13º integral adiantado
Date competencia = folhaDecimoTerceiroIntegralAntecipado.competencia

//Retorna uma lista de eventos calculados na folha de 13º integral adiantado
folhaDecimoTerceiroIntegralAntecipado.eventos.each{ e ->
    imprimir "Código do evento : $e.codigo"
    imprimir "Descrição do evento : $e.descricao"
    imprimir "Tipo do evento : $e.tipo"
    imprimir "Classificação do evento : $e.classificacao"
    imprimir "Taxa do evento : $e.taxa"
    imprimir "Referência do evento : $e.referencia"
    imprimir "Valor do evento : $e.valor"
}

//Retorna o subtipo de processamento da folha de 13º integral adiantado
if (folhaDecimoTerceiroIntegralAntecipado.subTipoProcessamento == SubTipoProcessamento.INTEGRAL) {
    imprimir "subtipo de processamento integral"
}

//Retorna o tipo de processamento da folha de 13º integral adiantado
if (folhaDecimoTerceiroIntegralAntecipado.tipoProcessamento == TipoProcessamento.DECIMO_TERCEIRO_SALARIO) {
    imprimir "É uma folha de décimo terceiro"
}

//Retorna o total bruto (proventos) da folha de 13º integral adiantado
BigDecimal totalBruto = folhaDecimoTerceiroIntegralAntecipado.totalBruto

//Retorna o total de descontos da folha de 13º integral adiantado
BigDecimal totalDesconto = folhaDecimoTerceiroIntegralAntecipado.totalDesconto

//Retorna o total líquido (proventos menos descontos) da folha de 13º integral adiantado
BigDecimal totalLiquido = folhaDecimoTerceiroIntegralAntecipado.totalLiquido

Folhas

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

//Retorna o valor calculado em todos os cálculos da competência atual
BigDecimal valorCalculadoEvento = folhas.valorCalculadoEvento(22)

folhas
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

BigDecimal valorReferenciaEvento = folhas.valorReferenciaEvento(22)

folhas
buscaFolhas()

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

O método buscaFolhas() retorna uma lista de folhas

folhas.buscaFolhas().each{ f ->
    //retorna uma lista de folhas
    imprimir "tipoProcessamento : $f.tipoProcessamento"
    imprimir "subTipoProcessamento  : $f.subTipoProcessamento"
    imprimir "diasGozo  : $f.diasGozo"
    imprimir "eventos  : $f.eventos "
    f.eventos.each{ e ->
        //retorna uma lista de eventos
        imprimir "e.valor : $e.valor"
    }

}

folhas
buscaFolhasOutrasCompetencias()

Busca dados de folhas de outras competências ou tipos de processamentos, não retorna dados da folha atual. O método buscaFolhas() retorna uma lista de folhas.

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{ f ->
    //retorna uma lista de folhas
    imprimir "tipoProcessamento : $f.tipoProcessamento"
    imprimir "subTipoProcessamento  : $f.subTipoProcessamento"
    imprimir "diasGozo  : $f.diasGozo"
    imprimir "eventos  : $f.eventos "
    f.eventos.each{ e ->
        //retorna uma lista de eventos
        imprimir "e.valor : $e.valor"
    }
}

FolhasPeriodo

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.

O método buscaFolhas() retorna uma lista de folhas.

folhasPeriodo.buscaFolhas().each{ f ->
    //retorna uma lista de folhas do período
    imprimir "folhaPagamento : $f.folhaPagamento"
    imprimir "tipoProcessamento : $f.tipoProcessamento"
    imprimir "subTipoProcessamento  : $f.subTipoProcessamento"
    imprimir "diasGozo  : $f.diasGozo"
    imprimir "eventos  : $f.eventos "
    f.eventos.each{ e ->
        //retorna uma lista de eventos
        imprimir "e.valor : $e.valor"
    }

}

folhasPeriodo - Permite consultar folhas do período (competência atual) de um tipo de processamento informado.
buscaFolhasProcessamento()

Busca de folhas de outros tipos de processamentos da mesma competência. O método buscaFolhasProcessamento() retorna uma lista de folhas.

Parâmetro	Descrição	Obrigatório
tipoProcessamento	informe um tipo de processamento	Sim

folhasPeriodo.buscaFolhasProcessamento(TipoProcessamento.FERIAS).each{ f ->
    //retorna uma lista de folhas do período do tipo de processamento passado no parâmetro
    imprimir "competencia : $f.competencia"
    imprimir "subTipoProcessamento  : $f.subTipoProcessamento"
    imprimir "diasGozo  : $f.diasGozo"
    imprimir "eventos  : $f.eventos "
    f.eventos.each{ e ->
        //retorna uma lista de eventos
        imprimir "e.valor : $e.valor"
    }
}

folhasPeriodo - Permite consultar folhas internas de férias referente as férias pagas ou gozadas na competência

buscaFolhasInternas()

Busca de folhas internas (folhas de férias). O método buscaFolhasProcessamento() retorna uma lista de folhas.

Parâmetro	Descrição	Obrigatório
tipoProcessamento	informe um tipo de processamento. Obs: Usar sempre TipoProcessamento.FERIAS	Sim

BigDecimal provento = BigDecimal.valueOf(0);
BigDecimal desconto = BigDecimal.valueOf(0);
folhasPeriodo.buscaFolhasInternas(TipoProcessamento.FERIAS).each{ f ->
    //retorna uma lista de folhas internas, se as férias possuem gozo em duas competências ambas retornarão na lista
    imprimir "competencia : $f.competencia"
    imprimir "diasGozo  : $f.diasGozo"
    imprimir "eventos  : $f.eventos "
    f.eventos.each{ e ->
        //retorna uma lista de eventos
        imprimir "e.valor : $e.valor"
        imprimir "e.tipo : $e.tipo"
        if (TipoEvento.VENCIMENTO.equals(e.tipo)) {
            provento += e.valor.abs()
        }
        if (TipoEvento.DESCONTO.equals(e.tipo)) {
            desconto += e.valor.abs()
        }
    }
}

FolhasMultiplosVinculosPeriodo

folhasMultiplosVinculosPeriodo - Permite consultar folhas dos outros vínculos do servidor na competência
buscaFolhas()

Busca de folhas dos outros vínculos do servidor no período (folhas de férias).

BigDecimal base = BigDecimal.valueOf(0);
BigDecimal valorEventoPorClassificacao = BigDecimal.valueOf(0);
folhasPeriodo.buscaFolhasInternas(TipoProcessamento.FERIAS).each{ f ->
    //Esta função permite consultar as folhas do período de férias dos outros vínculos do servidor
    base += f.valorBase(Base.INSS)
    valorEventoPorClassificacao += f.valorClassificacaoEvento(Base.INSS)
    f.eventos.each{ e ->
        //retorna uma lista de eventos
        imprimir "e.valor : $e.valor"
        imprimir "e.tipo : $e.tipo"
        if (TipoEvento.VENCIMENTO.equals(e.tipo)) {
            provento += e.valor.abs()
        }
        if (TipoEvento.DESCONTO.equals(e.tipo)) {
            desconto += e.valor.abs()
        }
    }

}

Funcionário

funcionario - Retorna os dados da matrícula que sejam do tipo funcionário no cálculo
cargoOrigemRendimento() - Retorna o cargo conforme a origem do rendimento informada
planoSalarialOrigemRendimento() - Retorna o plano salarial conforme a origem do rendimento informada
classeSalarialOrigemRendimento() - Retorna a classe salarial conforme a origem do rendimento informada
salarioOrigemRendimento() - Retorna o salário conforme a origem do rendimento informada
nivelSalarialCoeficienteOrigemRendimento() - Retorna se o nível salarial utiliza coeficiente conforme a origem do rendimento informada
nivelSalarialOrigemRendimento() - Retorna o nível salarial conforme a origem do rendimento informada
contaVagaOrigemRendimento - Indicativo se funcionário conta vaga considerando a origem do rendimento
recebeDecimoTerceiroPorOrigem - Indicativo se funcionário recebe décimo terceiro salário considerando a origem do rendimento
ocorrenciaSefip- Retorna a Ocorrência sefip do funcionário
classeSalarial - Retorna a Classe salarial do funcionário
mesContribuicaoSindical- Retorna o mês de contribuição sindical conforme configuração do sindicato
tipoVinculo - Retorna o tipo de vínculo do funcionário
categoriaSefipVinculo - Retorna a categoria sefip do vínculo do funcionário
descricaoOrganograma - Retorna a descrição do organograma do funcionário
codigoOrganograma - Retorna o código do organograma do funcionário
contaVaga - Indicativo se funcionário conta vaga, retorna true ou false
recebeDecimoTerceiro - Indicativo se funcionário recebe décimo terceiro salario, retorna true ou false
diasDireitoFerias - Retorna os dias de direito de férias conforme a configuração de féria
mesesAquisicaoFerias - Retorna os meses para aquisição de período férias conforme a configuração de férias
optanteFgts - Indicativo se funcionário é optante de FGTS
dataOpcaoFgts - Retorna a data da opção de FGTS do funcionário
dataFimVinculo - Retorna a data final de um vínculo temporário
salario - Retorna o salário do funcionário
nivelSalarialCoeficiente - Indicativo se o nível salarial utiliza coeficiente
planoSalarial - Retorna o plano salarial do funcionário
dataBase - Retorna a data base do funcionário
sindicato - Retorna o nome do sindicato do funcionário
responsabilidadePagamento - Retorna a informação de reponsabilidade do pagamento de funcionário cedido
nivelSalarial - Retorna o nível salarial do funcionário
estatutario - Indicativo se funcionário é estatutário, retorna true ou false
dataRescisao - Retorna a data da rescisão do funcionário
vinculoEmpregaticio - Retorna o vínculo empregatício do funcionário
*grupoFuncional - Retorna o grupo funcional do funcionário
cargo - Retorna o cargo do funcionário
dataAdmissao - Retorna a data de admissão do funcionário
possuiPrevidencia() - Indicativo se funcionário possui o tipo de previdência (RPPS) passado por parâmetro
previdenciaFederal - Indicativo se funcionário possui previdência federal
tipoAdmissao - Retorna o tipo de admissão do funcionário
quantidadeHorasMes - Retorna a quantidade de horas mês do funcionário
possuiAvisoPrevio() - Indicativo se funcionário possui aviso prévio
possuiMultiploVinculo - Indicativo se funcionário possui múltiplo vínculo
conselheiroTutelar - Indicativo se funcionário é conselheiro tutelar
profissionalSaudeSegurancaPublica - Indicativo se funcionário é um profissional de saúde ou segurança pública, conforme definição na ficha da matrícula. Quando não informado, será tratado como "Não"
camposAdicionais.busca() - Retorna o valor de um campo adicional vinculado ao funcionário
possuiPrevidenciaFederal - Retorna se o funcionário é optante da previdência federal
funcionario.areaAtuacao.camposAdicionais.busca() - Retorna o valor de um campo adicional da área de atuação vinculado ao funcionário, conforme parâmetro informando
estagiario.areaAtuacao.camposAdicionais.busca() - Retorna o valor de um campo adicional da área de atuação vinculado ao estagiário, conforme parâmetro informando

/**
 *
 * 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         |
 *
 */
String cargo = funcionario.cargoOrigemRendimento(OrigemRendimento.CARGO)

/**
 *
 * 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         |
 *
 */
String plano = funcionario.planoSalarialOrigemRendimento(OrigemRendimento.CARGO)

/**
 *
 * 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         |
 *
 */
String classe = funcionario.classeSalarialOrigemRendimento(OrigemRendimento.CARGO_COMISSIONADO)

/**
 *
 * Retorna o salário conforme a origem do rendimento informada
 *
 * | Parâmetro        | Descrição                                                     | Obrigatório |
 * | ---------------- | ------------------------------------------------------------- | ----------- |
 * | OrigemRendimento | informe a origem do rendimento do cargo ou cargo comissionado | Sim         |
 *
 */
BigDecimal salario = funcionario.salarioOrigemRendimento(OrigemRendimento.CARGO_COMISSIONADO)

/**
 *
 * Retorna se o nível salarial utiliza coeficiente conforme a origem do rendimento informada
 *
 * | Parâmetro        | Descrição                                                     | Obrigatório |
 * | ---------------- | ------------------------------------------------------------- | ----------- |
 * | OrigemRendimento | informe a origem do rendimento do cargo ou cargo comissionado | Sim         |
 *
 */
Boolean coeficiente = funcionario.nivelSalarialCoeficienteOrigemRendimento(OrigemRendimento.CARGO_COMISSIONADO)

/**
 *
 * Retorna o nível 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         |
 *
 */
String nivel = funcionario.nivelSalarialOrigemRendimento(OrigemRendimento.CARGO_COMISSIONADO)

/**
 *
 * Indicativo se funcionário conta vaga considerando a origem do rendimento
 *
 * | Parâmetro        | Descrição                                                     | Obrigatório |
 * | ---------------- | ------------------------------------------------------------- | ----------- |
 * | OrigemRendimento | informe a origem do rendimento do cargo ou cargo comissionado | Sim         |
 *
 */
Boolean contaVaga = funcionario.contaVagaOrigemRendimento(OrigemRendimento.CARGO_COMISSIONADO)

/**
 *
 * Indicativo se funcionário recebe décimo terceiro salário considerando a origem do rendimento
 *
 * | Parâmetro        | Descrição                                                     | Obrigatório |
 * | ---------------- | ------------------------------------------------------------- | ----------- |
 * | OrigemRendimento | informe a origem do rendimento do cargo ou cargo comissionado | Sim         |
 *
 */
Boolean recebeDecimo = funcionario.recebeDecimoTerceiroPorOrigem(OrigemRendimento.CARGO_COMISSIONADO)

//Retorna a ocorrência SEFIP do funcionário
if (funcionario.ocorrenciaSefip == OcorrenciaSefip.EXPOSTO_APOSENTADORIA_15_ANOS) {
    imprimir "Ocorrencia é 'EXPOSTO_APOSENTADORIA_15_ANOS'"
}

//Retorna a classe salarial do funcionário
String classeSalarial = funcionario.classeSalarial

//Retorna o mês de contribuição sindical conforme configuração do sindicato
if (funcionario.mesContribuicaoSindical == MesContribuicaoSindical.MAIO) {
    imprimir "Mês de contribuição é maio"
}

//Retorna o tipo de vínculo do funcionário
if (funcionario.tipoVinculo == TipoVinculo.CELETISTA) {
    imprimir "Tipo de vínculo é celetista"
}

//Retorna a categoria SEFIP do vínculo do funcionário, essa variável retorna um tipo VinculoEmpregaticioSefip, para tanto deve converter para string
String categoria = funcionario.categoriaSefipVinculo.toString()

List categorias = [
    'EMPREGADO',
    'TRABALHADOR_NAO_VINCULADO_RGPS_COM_FGTS',
    'CONTRATO_PRAZO_DETERMINADO',
    'MENOR_APRENDIZ',
    'AGENTE_PUBLICO',
    'AGENTE_POLITICO',
    'SERVIDOR_PUBLICO_COMISSAO',
    'SERVIDOR_PUBLICO_EFETIVO'
    ];
if (categorias.contains(categoria)) {
    imprimir "A categoria do funcionário é $categoria"
}

//Retorna a descrição do organograma do funcionário
String descricaoOrganograma = funcionario.descricaoOrganograma

//Retorna o código do organograma do funcionário
String codigoOrganograma = funcionario.codigoOrganograma

//Indicativo se funcionário conta vaga, retorna true ou false
if (funcionario.contaVaga) {
    imprimir "Funcionário conta vaga"
}

//Indicativo se o funcionário recebe décimo terceiro salário, retorna true ou false
Boolean recebeDecimoTerceiro = funcionario.recebeDecimoTerceiro

//Retorna os dias de direito de férias conforme a configuração de férias
int diasDireitoFerias = funcionario.diasDireitoFerias

//Retorna os meses para aquisição de período férias conforme a configuração de férias
int mesesAquisicaoFerias = funcionario.mesesAquisicaoFerias

//Indicativo se funcionário é optante de FGTS
Boolean optanteFgts = funcionario.optanteFgts

//Retorna a data da opção de FGTS do funcionário, quando não optante retorna null, por isso verifique anteriormente se é optante
if (funcionario.optanteFgts) {
    Date dataOpcaoFgts = funcionario.dataOpcaoFgts
}

//Retorna a data final de um vínculo temporário
Date dataFimVinculo = funcionario.dataFimVinculo

//Retorna o salário do funcionário
BigDecimal salario = funcionario.salario
valorCalculado = Funcoes.calcprop(salario, vaux)

//Indicativo se o nível salarial utiliza coeficiente
Boolean nivelSalarialCoeficiente = funcionario.nivelSalarialCoeficiente

//Retorna o plano salarial do funcionário
String planoSalarial = funcionario.planoSalarial

//Retorna a data base do funcionário
Date dataBase = funcionario.dataBase
if (dataBase < Datas.data(1993, 1 ,1) {
    imprimir "Data base é menor que 01/01/1993"
}

//Retorna o nome do sindicato do funcionário
String sindicato = funcionario.sindicato

//Retorna a informação de reponsabilidade do pagamento de funcionário cedido
if (funcionario.responsabilidadePagamento = ResponsabilidadePagamento.PAGAMENTO_EXCLUSIVAMENTE_PELO_CEDENTE_ORIGEM) {
    imprimir "Responsabilidade do pagamento exclusivamente do cedente (origem)"
}

//Retorna o nível salarial do funcionário
String nivelSalarial = funcionario.nivelSalarial

//Indicativo se funcionário é estatutário, retorna true ou false
Boolean estatutario = funcionario.estatutario

//Retorna a data da rescisão do funcionário
if (funcionario.dataRescisao != null) {
    Date dataRescisao = funcionario.dataRescisao
    if (dataRescisao > calculo.competencia) {
        imprimir "Data de rescisão maior que a competência atual"
    }
}

//Retorna o vínculo empregatício do funcionário
String vinculoEmpregaticio = funcionario.vinculoEmpregaticio

//Retorna o grupo funcional do funcionário
String grupoFuncional = funcionario.grupoFuncional

//Retorna o cargo do funcionário
String cargo = funcionario.cargo
if (cargo == 'OPERADOR DE MÁQUINAS') {
    imprimir "Descrição do cargo é 'OPERADOR DE MÁQUINAS'"
}

//Retorna a data de admissão do funcionário
Date dataAdmissao = funcionario.dataAdmissao

//Indicativo se funcionário possui o tipo de previdência (RPPS) passado por parâmetro
/**
 * | Parâmetro       | Descrição                      | Obrigatório |
 * | --------------- | ------------------------------ | ----------- |
 * | TipoPrevidencia | informe um tipo de previdência | Sim         |
 */
if (funcionario.possuiPrevidencia(TipoPrevidencia.FUNDO_FINANCEIRO)) {
    imprimir "Funcionário possui fundo financeiro"
}

//Indicativo se funcionário possui previdência federal
Boolean previdenciaFederal = funcionario.possuiPrevidenciaFederal

//Retorna o tipo de admissão do funcionário
if (funcionario.tipoAdmissao == TipoAdmissao.SUBSTITUICAO) {
    imprimir "Tipo de admissão por substituição"
}

//Retorna a quantidade de horas mês do funcionário
BigDecimal quantidadeHorasMes = funcionario.quantidadeHorasMes

//Indicativo se funcionário possui aviso prévio
Boolean possuiAvisoPrevio = funcionario.possuiAvisoPrevio()

//Indicativo se funcionário possui múltiplo vínculo
Boolean possuiMultiploVinculo = funcionario.possuiMultiploVinculo

//Indicativo se funcionário é conselheiro tutelar
Boolean conselheiroTutelar = funcionario.conselheiroTutelar

//Indicativo se funcionário é um profissional de segurança ou segurança pública
Boolean profissionalSaudeSegurancaPublica = funcionario.profissionalSaudeSegurancaPublica

/**
 *
 * Retorna um valor de campo adicional relacionado ao funcionário quando se tratar de um campo padrão
 *
 * | Parâmetro       | Descrição                                         | Obrigatório |
 * | --------------- | ------------------------------------------------- | ----------- |
 * | Variável        | Nome da variável em que a informação será buscada | Sim         |
 *
 */
String campo = funcionario.camposAdicionais.busca('data_comissionado')
Date campoDate = Funcoes.paraData(campo)

/**
 *
 * Retorna um valor de campo adicional relacionado ao funcionário quando se tratar de qualquer tipo de dado adicional
 *
 * | Parâmetro       | Descrição                                                     | Obrigatório |
 * | --------------- | ------------------------------------------------------------- | ----------- |
 * | Identificador   | Informe o identificador em que o dado adicional está agrupado | Sim         |
 * | Variável        | Nome da variável em que a informação será buscada             | Sim         |
 *
 */
String campo = funcionario.camposAdicionais.busca('padrao', 'data_comissionado')
Date campoDate = Funcoes.paraData(campo)

Média Vantagem

mediaVantagem - Retorna os valores de média ou vantagem calculados conforme o tipo configurado para o evento
calcular()

Conforme o tipo de média e vantagem e sua configuração os parâmetros deverão ser preeenchidos de forma diferente.

Parâmetro	Descrição	Obrigatório
periodoAquisitivo	informar o período aquisitivo	Sim

//Utilizado no evento MÉDIA HORAS FÉRIAS
BigDecimal valorMedia = mediaVantagem.calcular(periodoAquisitivo)

Férias normais, onde o período de cálculo configurado em médias e vantagens é diferente de "Definido em fórmula".

Parâmetro	Descrição	Obrigatório
avos	informar os avos para referência	Sim

//Utilizado no evento MÉDIA HORAS 13º SALÁRIO
valorReferencia = Funcoes.avos13(12)
BigDecimal valorMedia = mediaVantagem.calcular(valorReferencia);

Décimo terceiro salário, onde o período de cálculo configurado em médias e vantagens é diferente de "Definido em fórmula".

Parâmetro	Descrição	Obrigatório
dataInicial	Data inicial para média ou vantagem	Sim
dataFinal	Data final para média ou vantagem	Sim

//Utilizado no evento MÉDIA HORAS FÉRIAS PROPORCIONAL RESCISÃO
def periodo = PeriodosAquisitivos.buscaProporcional()
BigDecimal valorMedia = mediaVantagem.calcular(periodo.dataInicial, calculo.dataRescisao)

Quando o período de cálculo configurado em médias e vantagens é "Definido em fórmula".

O parâmetro utilizarMediaHoras na função mediaVantagem.calcular() é utilizado para definir se será usado a última hora contratual ou a média de horas contratuais do período aquisitivo, ao utilizar como true ele irá utilizar a média de horas do período aquisitivo.

Esse parâmetro poderá ser considerado nas médias horas de 13° salário, abono de férias, férias, férias vencidas, férias proporcionais e aviso prévio.

Exemplo:

Se chamo a função passando o seguinte parâmetro: mediaHoras(16/04/2023) e a carga horária do funcionário é de 200 horas desde 01/02/2023.

A função deve retornar 200. Nesse caso a função deve fazer a conta 200 * 15 (quantidade de dias com essa carga horária) / 15 (quantidade de dias do mês a partir da data inicial).

O mesmo vale para a data final. Lembramos que a precisão da média deve considerar 4 casas decimais.

Matrícula

matricula - Retorna os dados comuns a todos os tipos de matrículas
tipo - Retorna o tipo de matrícula
codigo - Retorna o código da matrícula

//Retorna o tipo de matrícula, é útil quando precisamos saber o tipo de matrícula que esta sendo calculada para poder definir de onde buscar os demais dados_
BigDecimal valorRemuneracao;
if (matricula.tipo == TipoMatricula.FUNCIONARIO) {
    valorRemuneracao = funcionario.salario
}else{
    valorRemuneracao = estagiario.bolsaEstudos
}

//Retorna o código de matrícula, esta variável concatena código '/' contrato quando existir número de contrato
if (matricula.codigo.equals('100')) {
    imprimir "O código da matrícula é 100"
}

Período Aquisitivo

periodoAquisitivo - Retorna dados do período aquisitivo de férias que está sendo calculado/consultado
configuracaoFerias - Retorna dados da configuração de férias do período
situacao - Retorna a situação do período aquisitivos de férias
dataFinal - Retorna a Data final do período aquisitivo de férias
dataInicial - Retorna a Data inicial do período aquisitivo de férias
saldo - Retorna o saldo de dias para gozo do período aquisitivo de férias
faltas - Retorna a quantidade de faltas do período aquisitivo de férias
faltasBrutas - Retorna a quantidade de faltas brutas do período aquisitivo de férias
faltasEnquadradas - Retorna a quantidade de faltas enquadradas do período aquisitivo de férias
diasAdquiridos - Retorna os dias já adquiridos até o momento do período aquisitivo de férias
cancelados - Retorna os dias cancelados do período aquisitivo de férias
suspensos - Retorna os dias suspensos do período aquisitivo de férias
diasFeriasPagosRescisao - Retorna os dias de férias que foram pagos em rescisão do período aquisitivo de férias
pagouUmTercoIntegral - Indicativo se terço integral das férias já foram pagos anteriormente, referente ao período aquisitivo de férias
pagoRescisao - Retorna o valor pago na rescisão
valorReferenciaPago - Retorna o valor de referência já pago no adiantamento das férias do período aquisitivo
valorCalculadoPago - Retorna o valor de calculado já pago no adiantamento das férias do período aquisitivo
valorCalculadoPagoMediaVantagem - O valor de calculado já pago no adiantamento das férias do período aquisitivo que foi pago em média ou vantagem

//Retorna dados da configuração de férias do período
/**
 * Campos de configuração de férias
 * diasParaAdquirirNoPeriodo - Dias para adiquirir no período
 * mesesParaAquisicao - Meses para aquisição
 * mesesParaConcessao - Meses para concessão
 * diasAbono - Quantidade de dias para abono
 * pagamentoFerias - Pagamento de férias (proporcional ou integral)
 * periodoNovoFeriasProporcional - Período novo de férias proporcionais
 * inicioPeriodo - Tipo de início do período
 * diaMesInicioPeriodo - Mês e ano de início (quando Início do período é Dia e mês específicos)
 */

configuracaoFerias = periodoAquisitivo.configuracaoFerias
int mesesParaAquisicao = configuracaoFerias.mesesParaAquisicao
int mesesParaConcessao = configuracaoFerias.mesesParaConcessao
int diasAbono = configuracaoFerias.diasAbono

//Retorna a situação do período aquisitivos de férias
if (periodoAquisitivo.situacao == SituacaoPeriodoAquisitivo.ADQUIRIDO) {
    imprimir "Situação do período é adquirido"
}

//Retorna a Data final do período aquisitivo de férias
Date dataFinal = periodoAquisitivo.dataFinal

//Retorna a Data inicial do período aquisitivo de férias
Date dataInicial = periodoAquisitivo.dataInicial

//Retorna o saldo de dias para gozo do período aquisitivo de férias
BigDecimal saldo = periodoAquisitivo.saldo

//Retorna a quantidade de faltas do período aquisitivo de férias
BigDecimal faltas = periodoAquisitivo.faltas

//Retorna a quantidade de faltas brutas do período aquisitivo de férias
BigDecimal faltasBrutas = periodoAquisitivo.faltasBrutas

//Retorna a quantidade de faltas enquadradas do período aquisitivo de férias
BigDecimal faltasEnquadradas = periodoAquisitivo.faltasEnquadradas

//Retorna os dias já adquiridos até o momento do período aquisitivo de férias
BigDecimal diasAdquiridos = periodoAquisitivo.diasAdquiridos

//Retorna os dias cancelados do período aquisitivo de férias
BigDecimal cancelados = periodoAquisitivo.cancelados

//Retorna os dias suspensos do período aquisitivo de férias
BigDecimal suspensos = periodoAquisitivo.suspensos

//Retorna os dias de férias que foram pagos em rescisão do período aquisitivo de férias
BigDecimal diasFeriasPagosRescisao = periodoAquisitivo.diasFeriasPagosRescisao

//Indicativo se terço integral das férias já foram pagos anteriormente, referente ao período aquisitivo de férias
Boolean pagouUmTercoIntegral = periodoAquisitivo.pagouUmTercoIntegral

//Valor pago na rescisão
BigDecimal pagoRescisao = periodoAquisitivo.pagoRescisao

//O valor de referência já pago no adiantamento das férias do período aquisitivo
BigDecimal valorReferenciaPago = periodoAquisitivo.valorReferenciaPago

//O valor de calculado já pago no adiantamento das férias do período aquisitivo
BigDecimal valorCalculadoPago = periodoAquisitivo.valorCalculadoPago

//O valor de calculado já pago no adiantamento das férias do período aquisitivo que foi pago em média ou vantagem
BigDecimal valorCalculadoPagoMediaVantagem = periodoAquisitivo.valorCalculadoPagoMediaVantagem

Período Concessão

periodoConcessao Retorna dados da concessão das férias que está sendo calculada
diasGozo - Retorna os dias de gozo de férias que está sendo calculada
diasFalta - Retorna os dias de faltas de férias que está sendo calculada
dataPagamento - Retorna a data do pagamento de férias que está sendo calculada
dataInicioGozo - Retorna a data do início de gozo de férias que está sendo calculada
dataFimGozo - Retorna a data do fim de gozo de férias que está sendo calculada
diasAbono - Retorna os dias de abono de férias que está sendo calculada

//Retorna os dias de gozo de férias que esta sendo calculada
BigDecimal diasGozo = periodoConcessao.diasGozo

//Retorna os dias de faltas de férias que esta sendo calculada
int diasFalta = periodoConcessao.diasFalta

//Retorna a data do pagamento de férias que esta sendo calculada
Date dataPagamento = periodoConcessao.dataPagamento

//Retorna a data do início de gozo de férias que esta sendo calculada
Date dataInicioGozo = periodoConcessao.dataInicioGozo

//Retorna a data do fim de gozo de férias que esta sendo calculada
Date dataFimGozo = periodoConcessao.dataFimGozo

//Retorna os dias de abono de férias que esta sendo calculada
int diasAbono = periodoConcessao.diasAbono

Pensionista

pensionista - Retorna os dados da matrícula que sejam do tipo pensionista no cálculo
formaPagamento - Retorna a forma de pagamento do pensionista
grupoFuncional - Retorna o grupo funcional do pensionista
recebeDecimoTerceiro - Indicativo se o pensionista recebe décimo terceiro salário conforme informado na ficha da matrícula
valorBeneficio - Retorna o valor do benefício do pensionista
dataInicioBeneficio - Retorna a data do início do benefício do pensionista
dataCessacaoBeneficio - Retorna a data de cessação do benefício do pensionista
descricaoOrganograma - Retorna a descrição do organograma do pensionista
agenciaPagamento - Retorna a agência de pagamento do pensionista
bancoPagamento - Retorna o banco de pagamento do pensionista
possuiFundoAssistencia - Retorna se o pensionista é optante da assistência municipal
possuiFundoFinanceiro - Retorna se o pensionista é optante do fundo de assistência
possuiPrevidenciaEstadual - Retorna se o pensionista é optante da previdência estadual
possuiPrevidenciaPropria - Retorna se o pensionista é optante da previdência própria

//Retorna a forma de pagamento do pensionista
if (pensionista.formaPagamento.equals(FormaPagamento.CREDITO_EM_CONTA)) {
    imprimir "A forma de pagamento é crédito em conta"
}

//Retorna o grupo funcional do pensionista
String grupoFuncional = pensionista.grupoFuncional

//Indicativo se o pensionista recebe décimo terceiro salário, retorna true ou false
Boolean recebeDecimoTerceiro = pensionista.recebeDecimoTerceiro

//Retorna o valor do benefício do pensionista
BigDecimal valorBeneficio = pensionista.valorBeneficio
valorCalculado = valorBeneficio

//Retorna a data do início do benefício do pensionista
Date dataInicioBeneficio = pensionista.dataInicioBeneficio

//Retorna a data de cessação do benefício do pensionista
if (pensionista.dataCessacaoBeneficio != null) {
    Date dataCessacaoBeneficio = pensionista.dataCessacaoBeneficio
}

//Retorna a descrição do organograma do pensionista
String descricaoOrganograma = pensionista.descricaoOrganograma

//Retorna a agência de pagamento do pensionista
String agenciaPagamento = pensionista.agenciaPagamento

//Retorna o banco de pagamento do pensionista
String bancoPagamento = pensionista.bancoPagamento

//Indicativo se o pensionista possui fundo de assistência
Boolean possuiFundoAssistencia = pensionista.possuiFundoAssistencia

//Indicativo se o pensionista possui fundo financeiro
Boolean possuiFundoFinanceiro = pensionista.possuiFundoFinanceiro

//Indicativo se o pensionista possui previdência estadual
Boolean possuiPrevidenciaEstadual = pensionista.possuiPrevidenciaEstadual

//Indicativo se o pensionista possui previdência própria
Boolean possuiPrevidenciaPropria = pensionista.possuiPrevidenciaPropria

Busca por Cessação

buscaPorCessacao() - Permite buscar os dados das cessações do pensionista que estão vigentes na competência que está sendo informada.

Parâmetro	Descrição	Obrigatório
competência	Competência que será utilizada para buscar as cessações cadastradas	Sim

//Utilizada na função para fórmula: diaspensionista
def cessacoes = pensionista.buscaPorCessacao(calculo.competencia)

def inicioCes
def fimCes
def motivoCes
def descricaoCes
def cnpjOrgaoSucessorCes
def dataEfeitoFinanceiroCer

cessacoes.each { cessacao ->
    inicioCes = Datas.data(Datas.ano(cessacao.dataInicial),Datas.mes(cessacao.dataInicial),Datas.dia(cessacao.dataInicial))
    fimCes = Datas.data(Datas.ano(cessacao.dataFim),Datas.mes(cessacao.dataFim),Datas.dia(cessacao.dataFim))
    motivoCes = cessacao.motivo
    descricaoCes = cessacao.descricao
    cnpjOrgaoSucessorCes = cessacao.cnpjOrgaoSucessorCes
    dataEfeitoFinanceiroCer = Datas.data(Datas.ano(cessacao.dataEfeitoFinanceiro),Datas.mes(cessacao.dataEfeitoFinanceiro),Datas.dia(cessacao.dataEfeitoFinanceiro))
}

Busca por Suspensão

buscaPorSuspensao() - Permite buscar os dados das suspensões do pensionista que estão vigentes na competência que está sendo informada.

Parâmetro	Descrição	Obrigatório
competência	Competência que será utilizada para buscar as suspensões cadastradas	Sim

def suspensoes = pensionista.buscaPorCessacao(calculo.competencia)

def inicioSusp
def fimSusp
def motivoSusp
def descricaoSusp

suspensoes.each { suspensao ->
    inicioSusp = Datas.data(Datas.ano(suspensao.dataInicial),Datas.mes(suspensao.dataInicial),Datas.dia(suspensao.dataInicial))
    fimSusp = Datas.data(Datas.ano(suspensao.dataFim),Datas.mes(suspensao.dataFim),Datas.dia(suspensao.dataFim))
    motivoSusp = suspensao.motivo
    descricaoSusp = suspensao.descricao
}

Período Aquisitivo Décimo Terceiro

periodoAquisitivoDecimoTerceiro - Retorna dados do período aquisitivo de décimo terceiro que está sendo calculado/consultado
avosAdquiridos - Retorna os avos adquiridos de décimo terceiro salário
avosAdquiridosFgts - Retorna os avos adquiridos para cálculo de FGTS de décimo terceiro salário
avosPerdidos - Retorna os avos perdidos de décimo terceiro salário
avosDireito - Retorna os avos de direito de décimo terceiro salário
anoExercicio - Retorna o ano de exercício de décimo terceiro salário
movimentacoes - Retorna uma lista de movimentações do período aquisitivo de décimo terceiro salário
situacao - Retorna a situação do período aquisitivo de décimo terceiro salário
dataInicial - Retorna a data inicial do período aquisitivo de décimo terceiro salário
dataFinal - Retorna a data final do período aquisitivo de décimo terceiro salário
totalMovimentacoes - Retorna o valor total de movimentações do período aquisitivo de décimo terceiro salário
totalMovimentacoesByMotivo() - Retorna o valor total de movimentações do período aquisitivo de décimo terceiro salário por motivo

//Retorna os avos adquiridos de décimo terceiro salário
int avosAdquiridos = periodoAquisitivoDecimoTerceiro.avosAdquiridos

//Retorna os avos adquiridos para cálculo de FGTS de décimo terceiro salário
int avosAdquiridosFgts = periodoAquisitivoDecimoTerceiro.avosAdquiridosFgts

//Retorna os avos perdidos de décimo terceiro salário
int avosPerdidos = periodoAquisitivoDecimoTerceiro.avosPerdidos

//Retorna os avos de direito de décimo terceiro salário
int avosDireito = periodoAquisitivoDecimoTerceiro.avosDireito

//Retorna o ano de exercício de décimo terceiro salário
int anoExercicio = periodoAquisitivoDecimoTerceiro.anoExercicio

//Retorna uma lista de movimentações do período aquisitivo de décimo terceiro salário
periodoAquisitivoDecimoTerceiro.movimentacoes.each{ m->
   imprimir "competencia : $m.competencia"
   imprimir "consideraAvosPerdidos : $m.consideraAvosPerdidos"
   imprimir "valor : $m.valor"
   imprimir "motivo : $m.motivo"
}

//Retorna a situação do período aquisitivo de décimo terceiro salário
if (periodoAquisitivoDecimoTerceiro.situacao == SituacaoPeriodoAquisitivoDecimoTerceiro.EM_ANDAMENTO) {
    imprimir "A situação do período é em andamento"
}

//Retorna a data inicial do período aquisitivo de décimo terceiro salário
Date dataInicial = periodoAquisitivoDecimoTerceiro.dataInicial

//Retorna a data final do período aquisitivo de décimo terceiro salário
Date dataFinal = periodoAquisitivoDecimoTerceiro.dataFinal

//Retorna o valor total de movimentações do período aquisitivo de décimo terceiro salário
BigDecimal totalMovimentacoes = periodoAquisitivoDecimoTerceiro.totalMovimentacoes

//Retorna o valor total de movimentações do período aquisitivo de décimo terceiro salário por motivo
/**
 * | Parâmetro | Descrição              | Obrigatório |
 * | --------- | ---------------------- | ----------- |
 * | motivo    | Motivo da movimentação | Sim         |
 */

BigDecimal totalMovimentacaoPorMotivo = periodoAquisitivoDecimoTerceiro.totalMovimentacoesByMotivo(MotivoMovimentacaoPeriodoAquisitivoDecimoTerceiro.ADIANTAMENTO_DECIMO_TERCEIRO)

Servidor

servidor - Retorna os dados do servidor/pessoa
grauEscolaridade - Retorna o grau de escolaridade do servidor
dataNascimento - Retorna a data de nascimento do servidor
estadoCivil - Retorna o estado civil do servidor
nacionalidade - Retorna a nacionalidade do servidor
dataChegada - Retorna a data da chegada do servidor estrangeiro
dependentes - Retorna a quantidade geral de dependentes do servidor
buscaDependentes() - Retorna a lista com todos os dados de dependentes do servidor
sexo - Retorna o sexo do servidor
dependentesIrrf - Retorna a quantidade de dependentes de IRRF do servidor
possuiMolestiaGrave - Indicativo se servidor possui moléstia grave

//Retorna o grau de escolaridade do servidor
/**
 * Lista de graus de escolaridade :
 * NAO_ALFABETIZADO, ALFABETIZADO, ENSINO_FUNDAMENTAL_ANOS_INICIAIS, ENSINO_FUNDAMENTAL_ANOS_FINAIS, ENSINO_MEDIO,
 * ENSINO_PROFISSIONALIZANTE, ENSINO_SUPERIOR_SEQUENCIAL, GRADUACAO_BACHARELADO, GRADUACAO_LICENCIATURA,
 * GRADUACAO_TECNOLOGIA, POS_GRADUACAO_ESPECIALIZACAO, POS_GRADUACAO_MBA, POS_GRADUACAO_MESTRADO,
 * POS_GRADUACAO_DOUTORADO, POS_GRADUACAO_HONORIS_CAUSA, POS_DOUTORADO_HABILITACAO, POS_DOUTORADO_LIVRE_DOCENCIA,
 * POS_DOUTORADO_NOTORIO_SABER
 */

 if (servidor.grauEscolaridade.toString().equals('ENSINO_FUNDAMENTAL_ANOS_INICIAIS')) {
     imprimir "O grau de escolaridade é ENSINO_FUNDAMENTAL_ANOS_INICIAIS"
 }

//Retorna a data de nascimento do servidor
Date dataNascimento = servidor.dataNascimento
int idade = Datas.diferencaDias(dataNascimento, calculo.competencia) / 365

//Retorna o estado civil do servidor
/**
 * Lista de graus de escolaridade :
 * SOLTEIRO, CASADO, DIVORCIADO, VIUVO, SEPARADO_CONSENSUALMENTE, SEPARADO_JUDICIALMENTE, UNIAO_ESTAVEL
 */
if (servidor.estadoCivil.toString().equals('CASADO')) {
    imprimir "Esta civil do servidor é casado"
}

//Retorna a nacionalidade do servidor
String nacionalidade = servidor.nacionalidade

//Retorna a data da chegada do servidor estrangeiro
Date dataChegada = servidor.dataChegada

//Retorna a quantidade geral de dependentes do servidor
Long dependentes = servidor.dependentes

//Retorna a lista com todos os dados de dependentes do servidor_
/**
 * Campos disponíveis na lista de dependentes
 * 1. tipoAplicacaoDesconto - Tipo de aplicação de desconto
 * 2. valorDesconto - Valor de desconto
 * 3. percentualDesconto - Percentual de desconto
 * 4. dataInicio - Data de início
 * 5. dataTermino - Data término
 * 6. salarioFamilia - Dependenten de Salário familia
 * 7. irrf - Dependente de Irrf
 * 8. dataNascimento - Data de nascimento
 * 9. grau - Grau de parentesco
 * 10. estuda - Se dependente estuda
 * 11. pensao - Se é dependente de pensão
 * 12. dataInicioCurso - Data início curso
 * 13. dataFinalCurso - Data final curso
 * 14. aplicaRateio() - Ratear pensão por dependente
 */
servidor.buscaDependentes.sum(0, { it.pensao ? 1 : 0 })

//Percorrendo...
//44 - PENSÃO ALIMENTÍCIA
servidor.buscaDependentes.each { dependente ->
    imprimir "dataInicio : $dependente.dataInicio"
    imprimir "dataTermino : $dependente.dataTermino"
    imprimir "dataNascimento : $dependente.dataNascimento"
    imprimir "salarioFamilia : $dependente.salarioFamilia"
    imprimir "irrf : $dependente.irrf"
    if (dependente.pensao) {
        if (dependente.aplicacaoDesconto.toString().equals('VALOR_PERCENTUAL')) {
            valorPensaoPorDependente = (salario * dependente.percentualDesconto / 100) / quantidadePensionistas
        } else {
            valorPensaoPorDependente = dependente.valorDesconto
        }
        dependente.aplicaRateio(valorPensaoPorDependente)
        valorTotalPensao += valorPensaoPorDependente;
    }
}

//Retorna o sexo do servidor
if (servidor.sexo == Sexo.MASCULINO) {
    imprimir "Sexo do servidor é masculino"
}

//Retorna a quantidade de dependentes de IRRF do servidor
Long dependentesIrrf = servidor.dependentesIrrf

//Indicativo se servidor possui moléstia grave
Boolean possuiMolestiaGrave = servidor.possuiMolestiaGrave

Valor Calculado

valorCalculado - É a variável responsável por registrar o valor para o cálculo do evento. O valor final calculado deve ser atribuído a esta propriedade.

vaux = Funcoes.calcprop(funcionario.salario, funcionario.quantidadeHorasMes)
valorCalculado = vaux

Valor Referência

valorReferencia - É a variável responsável por registrar o valor de referência do evento. O valor final de referência deve ser atribuído a esta propriedade.

vaux = Funcoes.calcprop(funcionario.salario, funcionario.quantidadeHorasMes)
valorReferencia = funcionario.quantidadeHorasMes

Funções para fórmulas (mantidas pelo desenvolvimento)

Em funções para fórmulas é possível criar funções para auxiliar no uso de fórmulas de eventos, diminuindo a complexidade deles e permitindo o re-uso de um mesmo código. As funções que contém padrão são de responsabilidade do desenvolvimento na qual podem ser editadas apenas pelos mesmos. Seguem abaixo as mesmas.

Acumula

Função
acumula - Acumula a movimentação de um determinado evento no período informado com o código de evento informado.

Parâmetro	Descrição	Obrigatório
codigoEvento	Código do evento	Sim
tipo	Informe o tipo de valor a ser buscado pela função	Sim
competenciaInicial	Competência inicial para acumular a movimentação	Sim
competenciaFinal	Competência final para acumular a movimentação	Sim
tipoProcessamento	Informe o tipo de processamento a ser considerado na busca	Sim
subTipoProcessamento	Informe o subtipo de processamento a ser considerado na busca. Quando não informado serão considerados os subtipos de processamento INTEGRAL e COMPLEMENTAR	Não

valorAcumulado = Funcoes.acumula(67, TipoValor.CALCULADO, competencia, competencia, TipoProcessamento.MENSAL, SubTipoProcessamento.ADIANTAMENTO)

Acumula Classificação

Função
acumulaClassificacao - Acumula a movimentação dos eventos no período informado que tenham a classificação de evento informada.

Parâmetro	Descrição	Obrigatório
classificacao	Classificação do evento	Sim
tipo	Informe o tipo de valor a ser buscado pela função	Sim
competenciaInicial	Competência inicial para acumular a movimentação	Sim
competenciaFinal	Competência final para acumular a movimentação	Sim
tipoProcessamento	Informe o tipo de processamento a ser considerado na busca	Sim
subTipoProcessamento	Informe o subtipo de processamento a ser considerado na busca. Quando não informado serão considerados os subtipos de processamento INTEGRAL e COMPLEMENTAR	Não

valorAcumulado = Funcoes.acumula(ClassificacaoEvento.ABATSALM13, TipoValor.CALCULADO, competencia, competencia, TipoProcessamento.MENSAL, SubTipoProcessamento.INTEGRAL)

Afasaborto

Função
afasaborto() - Retorna os dias com afastamento na competência devido aborto não criminoso.

int diasAfastamento = Funcoes.afasaborto()
vaux = Funcoes.cnvdpbase(diasAfastamento)

valorCalculado = Funcoes.calcprop(funcionario.salario, vaux)

Afasacidtrab

Função
afasacidtrab() - Retorna os dias com afastamento na competência devido acidente de trabalho (previdência).

int diasAfastamento = Funcoes.afasacidtrab()
vaux = Funcoes.cnvdpbase(diasAfastamento)

valorCalculado = Funcoes.calcprop(funcionario.salario, vaux)

Afasacidtrabemp

Função
afasacidtrabemp() - Retorna os dias com afastamento na competência devido acidente de trabalho (empregador).

int diasAfastamento = Funcoes.afasacidtrabemp()
vaux = Funcoes.cnvdpbase(diasAfastamento)

valorCalculado = Funcoes.calcprop(funcionario.salario, vaux)

Afasadocao

Função
afasadocao() - Retorna os dias com afastamento na competência devido adoção

int diasAfastamento = Funcoes.afasadocao()
vaux = Funcoes.cnvdpbase(diasAfastamento)

valorCalculado = Funcoes.calcprop(funcionario.salario, vaux)

Afasauxdoenc

Função
afasauxdoenc() - Retorna os dias com afastamento na competência devido doença (previdência).

int diasAfastamento = Funcoes.afasauxdoenc()
vaux = Funcoes.cnvdpbase(diasAfastamento)

valorCalculado = Funcoes.calcprop(funcionario.salario, vaux)

Afasauxdoencemp

Função
afasauxdoencemp() - Retorna os dias com afastamento na competência devido doença (empregador).

int diasAfastamento = Funcoes.afasauxdoencemp()
vaux = Funcoes.cnvdpbase(diasAfastamento)

valorCalculado = Funcoes.calcprop(funcionario.salario, vaux)

Afascandcargoeletivocel

Função
afascandcargoeletivocel() - Retorna os dias com afastamento na competência devido candidatura em cargo eletivo estando a matrícula em um vínculo celetista.

int diasAfastamento = Funcoes.afascandcargoeletivocel()
vaux = Funcoes.cnvdpbase(diasAfastamento)

valorCalculado = Funcoes.calcprop(funcionario.salario, vaux)

Afasdirinteg

Função
afasdirinteg() - Retorna os dias com afastamento na competência devido licença com vencimentos/com direitos integrais.

int diasAfastamento = Funcoes.afasdirinteg()
vaux = Funcoes.cnvdpbase(diasAfastamento)

valorCalculado = Funcoes.calcprop(funcionario.salario, vaux)

Afasexeroutroorgaoservidorouempregadopubcedido

Função
afasexeroutroorgaoservidorouempregadopubcedido() - Retorna os dias com afastamento na competência devido exercício em outro órgão de servidor ou empregado público cedido.

int diasAfastamento = Funcoes.afasexeroutroorgaoservidorouempregadopubcedido()
vaux = Funcoes.cnvdpbase(diasAfastamento)

valorCalculado = Funcoes.calcprop(funcionario.salario, vaux)

Afaslicmat

Função
afaslicmat() - Retorna os dias com afastamento na competência devido licença maternidade;

int diasAfastamento = Funcoes.afaslicmat()
vaux = Funcoes.cnvdpbase(diasAfastamento)

valorCalculado = Funcoes.calcprop(funcionario.salario, vaux)

Afasliccvenclibempact

Função
afasliccvenclibempact() - Retorna os dias com afastamento na competência devido licença com vencimentos/com direitos integrais relacionados a liberdade da empresa/ACT.

int diasAfastamento = Funcoes.afasliccvenclibempact()
vaux = Funcoes.cnvdpbase(diasAfastamento)

valorCalculado = Funcoes.calcprop(funcionario.salario, vaux)

Afaslicsvenc

Função
afaslicsvenc() - Retorna os dias com afastamento na competência devido licença sem vencimentos.

int diasAfastamento = Funcoes.afaslicsvenc()
vaux = Funcoes.cnvdpbase(diasAfastamento)

valorCalculado = Funcoes.calcprop(funcionario.salario, vaux)

Afasmandeletivocargocomissao

Função
afasmandeletivocargocomissao() - Retorna os dias com afastamento na competência devido mandato eletivo para cargo em comissão.

int diasAfastamento = Funcoes.afasmandeletivocargocomissao()
vaux = Funcoes.cnvdpbase(diasAfastamento)

valorCalculado = Funcoes.calcprop(funcionario.salario, vaux)

Afaspartconscnpslei82131991

Função
afaspartconscnpslei82131991() - Retorna os dias com afastamento na competência devido participação em conselho CNPS, em conformidade com a lei 8.213/1991.

int diasAfastamento = Funcoes.afaspartconscnpslei82131991()
vaux = Funcoes.cnvdpbase(diasAfastamento)

valorCalculado = Funcoes.calcprop(funcionario.salario, vaux)

Afasprorroglicmat()

Função
afasprorroglicmat() - Retorna os dias com afastamento na competência devido prorrogação da licença maternidade.

int diasAfastamento = Funcoes.afasprorroglicmat()
vaux = Funcoes.cnvdpbase(diasAfastamento)

valorCalculado = Funcoes.calcprop(funcionario.salario, vaux)

Afasprorroglicmatlei11770()

Função
afasprorroglicmatlei11770() - Retorna os dias com afastamento na competência devido prorrogação da licença maternidade, em conformidade com a lei 11.770.

int diasAfastamento = Funcoes.afasprorroglicmatlei11770()
vaux = Funcoes.cnvdpbase(diasAfastamento)

valorCalculado = Funcoes.calcprop(funcionario.salario, vaux)

AfasReintegracaoComPerdaDireito()

Função
afasReintegracaoComPerdaDireito() - Retorna os dias com afastamento na competência devido reintegração com perdas de direito - ou seja, sem direitos integrais.

int diasAfastamento = Funcoes.afasReintegracaoComPerdaDireito()
vaux = Funcoes.cnvdpbase(diasAfastamento)

valorCalculado = Funcoes.calcprop(funcionario.salario, vaux)

AfasReintegracaoSemPerdaDireito()

Função
afasReintegracaoSemPerdaDireito() - Retorna os dias com afastamento na competência devido reintegração sem perdas de direito - ou seja, com direitos integrais.

int diasAfastamento = Funcoes.afasReintegracaoSemPerdaDireito()
vaux = Funcoes.cnvdpbase(diasAfastamento)

valorCalculado = Funcoes.calcprop(funcionario.salario, vaux)

Afasrepresentantesindical()

Função
afasrepresentantesindical() - Retorna os dias com afastamento na competência devido representação sindical.

int diasAfastamento = Funcoes.afasrepresentantesindical()
vaux = Funcoes.cnvdpbase(diasAfastamento)

valorCalculado = Funcoes.calcprop(funcionario.salario, vaux)

Afasservmil()

Função
afasservmil() - Retorna os dias com afastamento na competência devido prestação de serviço militar.

int diasAfastamento = Funcoes.afasservmil()
vaux = Funcoes.cnvdpbase(diasAfastamento)

valorCalculado = Funcoes.calcprop(funcionario.salario, vaux)

Afassuspcontart17mp11162022()

Função
afassuspcontart17mp11162022() - Retorna os dias com afastamento na competência devido afastamento por suspensão do contrato, em conformidade com o artigo 17 da MP 1.116/2022.

int diasAfastamento = Funcoes.afassuspcontart17mp11162022()
vaux = Funcoes.cnvdpbase(diasAfastamento)

valorCalculado = Funcoes.calcprop(funcionario.salario, vaux)

Afassuspcontart19mp11162022()

Função
afassuspcontart19mp11162022() - Retorna os dias com afastamento na competência devido afastamento por suspensão do contrato, em conformidade com o artigo 19 da MP 1.116/2022.

int diasAfastamento = Funcoes.afassuspcontart19mp11162022()
vaux = Funcoes.cnvdpbase(diasAfastamento)

valorCalculado = Funcoes.calcprop(funcionario.salario, vaux)

Afassuspcontlei140202020coronavirus()

Função
afassuspcontlei140202020coronavirus() - Retorna os dias com afastamento na competência devido suspensão do contrato de trabalho devido coronavírus, em conformidade com a lei 14.020/2020.

int diasAfastamento = Funcoes.afassuspcontlei140202020coronavirus()
vaux = Funcoes.cnvdpbase(diasAfastamento)

valorCalculado = Funcoes.calcprop(funcionario.salario, vaux)

Afassusppagtoservpubnaorecadastramento()

Função
afassusppagtoservpubnaorecadastramento() - Retorna os dias com afastamento na competência devido suspensão de pagamento de servidor público por não recadastramento.

int diasAfastamento = Funcoes.afassusppagtoservpubnaorecadastramento()
vaux = Funcoes.cnvdpbase(diasAfastamento)

valorCalculado = Funcoes.calcprop(funcionario.salario, vaux)

Afastrabavulsoimpedconcorrenciaescala()

Função
afastrabavulsoimpedconcorrenciaescala() - Retorna os dias com afastamento do trabalhador avulso em virtude do impedimento de concorrência à escala.

int diasAfastamento = Funcoes.afastrabavulsoimpedconcorrenciaescala()
vaux = Funcoes.cnvdpbase(diasAfastamento)

valorCalculado = Funcoes.calcprop(funcionario.salario, vaux)

Afastrabavulsoinatividadetrabmaior90dias()

Função
afastrabavulsoinatividadetrabmaior90dias() - Retorna os dias com afastamento do trabalhador avulso em virtude da inatividade de trabalho maior que 90 dias.

int diasAfastamento = Funcoes.afastrabavulsoinatividadetrabmaior90dias()
vaux = Funcoes.cnvdpbase(diasAfastamento)

valorCalculado = Funcoes.calcprop(funcionario.salario, vaux)

Avos13()

Função
avos13() - Quantidade de avos para cálculo de décimo terceiro salário.

Parâmetro	Descrição	Obrigatório
mes	Mês de referência	Sim
calculoFGTS	Se deseja retornar os avos para fins de cálculo de FGTS, se não for informado será considerado false	Não

int avos13 = Funcoes.avos13(12, true)

if (TipoProcessamento.RESCISAO.equals(calculo.tipoProcessamento)) {
    avos13 = Funcoes.avos13(calculo.competencia.mes)
}

Função
avosAuxMat13() - Quantidade de avos afastados por auxílio maternidade. Contabilizará a quantidade de dias em afastamento com as classificações "Licença maternidade", "Prorrogação da licença maternidade" e "Aborto não criminoso" por competência durante o ano base para descontar dos dias trabalhados e/ou em outros tipos de afastamentos. Caso esta quantidade da competência totalizar menos que 15 dias trabalhados e/ou com outros tipos de afastamentos, será considerado como avo de auxílio maternidade

int avosAuxMat13 = Funcoes.avosAuxMat13()

BuscaAbonos()

Função
buscaAbonos() - Retorna uma quantidade de abonos de faltas na competência informada, conforme os parâmetros para a busca nos lançamentos de faltas. O retorno das informações se dará de acordo com a competência de desconto e/ou competência de abono.

Parâmetro	Descrição	Obrigatório
abonada	Informe o tipo de abono para a busca. Informando "Abonado", retornará a quantidade abonada. Informando "Não abonadas", retornará a diferença entre a quantidade de faltas descontadas e a quantidade abonada - quando maior que zero. Informando "Abonadas e não abonadas", retornará a quantidade total de faltas descontadas	Sim
competencia	Competência onde as informações serão buscadas, podendo ser ela a competência de abono ou de desconto da falta - conforme parâmetro "abonada"	Sim
considerarJustificadasInjustificadas	Permite informar o tipo de falta a ser considerado. Quando não informado, buscará ambos os tipos de de afastamentos de faltas - justificadas e injustificadas	Não

double abonoFaltas = Funcoes.buscaAbonos(TipoAbono.ABONADO, calculo.competencia, TipoFalta.NAO_JUSTIFICADA)

valorReferencia = abonoFaltas
if (valorReferencia > 0) {
    valorCalculado = Funcoes.calcprop(Funcoes.remuneracao(matricula.tipo).valor, valorReferencia)
}

BuscaBaseDeOutrosProcessamentos()

Função
buscaBaseDeOutrosProcessamentos() - Esta função busca os valores calculados para o tipo de base informado no parâmetro em folhas anteriores do processamento mensal e/ou rescisório. Para os processamentos mensal (complementar) e rescisão (integral), buscará o valor calculado nas folhas mensal (integral) e mensal (complementar). Para o processamento de rescisão (complementar), buscará as mesmas folhas mensais e as folhas de rescisão (integral) e rescisão (complementar). Nas demais folhas, retornará como valor zero. IMPORTANTE: esta função deve ser utilizada apenas nos casos de bases originadas de eventos que são calculados especificamente em um único processamento/subtipo de processamento por competência (exemplos: "BASE I.N.S.S. OUTRAS EMPRESAS" e "BASE I.R.R.F. OUTRAS EMPRESAS"), pois seu uso indevido pode acarretar em valores incorretos nas folhas.

//exemplo de uso no evento 50 - I.N.S.S.
def baseprev = Bases.valor(Bases.INSS) + Bases.valor(Bases.INSSFER) + Bases.valor(Bases.INSSOUTRA) + Funcoes.buscaBaseDeOutrosProcessamentos(Bases.INSSOUTRA)

buscaFaltas()

Função
buscaFaltas() - Retorna uma quantidade de faltas na competência informada, conforme os parâmetros para a busca nos lançamentos de faltas. O retorno das informações se dará de acordo com a competência de desconto.

Parâmetro	Descrição	Obrigatório
justificada	Informe o tipo de falta para busca. Informando "Não justificada", retornará a quantidade de faltas com o tipo de afastamento injustificado. Informando "Justificada", retornará a quantidade de faltas com o tipo de afastamento justificado. Informando "Justificada e não justificada", retornará a quantidade de faltas com os tipos de afastamentos justificado e injustificado	Sim
competencia	Competência onde os descontos das faltas serão buscadas	Sim

double descFaltas = Funcoes.buscaFaltas(TipoFalta.NAO_JUSTIFICADA, calculo.competencia)

valorReferencia = descFaltas
if (valorReferencia > 0) {
    valorCalculado = Funcoes.calcprop(Funcoes.remuneracao(matricula.tipo).valor, valorReferencia)
}

BuscaMes()

Função
buscaMes() - Retorna o nome do mês conforme o mês informado por parâmetro

Parâmetro	Descrição	Obrigatório
mes	mês do ano, de 1 a 12	Sim

String nomeMes = Funcoes.buscaMes(12)
//retorna 'DEZEMBRO'

BuscaQuantidadeDependentesPensao()

Função
buscaQuantidadeDependentesPensao() - Retorna a quantidade de dependentes de pensão vigentes do servidor. Caso não houver, retornará 0 (zero).

//exemplo
int quantidadeDependentes = Funcoes.buscaQuantidadeDependentesPensao()

//exemplo de uso no evento 44 - PENSÃO ALIMENTÍCIA
valorReferencia = Funcoes.buscaQuantidadeDependentesPensao()

BuscaValorDeOutrosProcessamentos()

Função
buscaValorDeOutrosProcessamentos() - Esta função busca os valores calculados para o código de evento informado no parâmetro em folhas anteriores do processamento mensal e/ou rescisório. Para os processamentos mensal (complementar) e rescisão (integral), buscará o valor calculado nas folhas mensal (integral) e mensal (complementar). Para o processamento de rescisão (complementar), buscará as mesmas folhas mensais e as folhas de rescisão (integral) e rescisão (complementar). Nas demais folhas, retornará como valor zero. IMPORTANTE: esta função deve ser utilizada apenas nos casos de eventos que são calculados especificamente em um único processamento/subtipo de processamento por competência (exemplos: "RETENÇÃO I.N.S.S. OUTRAS EMPRESAS" e "RETENÇÃO I.R.R.F. OUTRAS EMPRESAS"), pois seu uso indevido pode acarretar em valores incorretos nas folhas.

//exemplo de uso no evento 50 - I.N.S.S.
def valorRetencaoInss = Eventos.valor(169) + Funcoes.buscaValorDeOutrosProcessamentos(169)

BuscaValorDependentesPensao()

Função
buscaValorDependentesPensao() - Retorna o valor total de pensão a ser pago pelo servidor conforme o valor informado. Na função também é realizado o rateio de valores por dependente para exibição na consulta de cálculos conforme configuração da pensão - fixo ou um percentual do valor informado. Serão considerados no cálculo apenas os dependentes com pensões vigentes.

Parâmetro	Descrição	Obrigatório
valorParaCalculoDaPensao	Valor para o cálculo da pensão por dependente	Sim

//exemplo
double valorTotalPensao = Funcoes.buscaValorDependentesPensao(Bases.valor(Bases.SALBASE))

//exemplo de uso no evento 44 - PENSÃO ALIMENTÍCIA
valorCalculado = Funcoes.buscaValorDependentesPensao(Funcoes.remuneracao(matricula.tipo).valor)

BuscaValorEvento13SalarioIntegralAdiantado()

Função
buscaValorEvento13SalarioIntegralAdiantado() - Retorna o valor de um evento da folha de 13º salário integral adiantada em competência anterior à Dezembro quando está calculando uma folha de 13º salário integral em Dezembro. Permite informar um código de evento de evento específico ou buscar o próprio evento que sendo calculado. Caso não houver uma folha de 13º integral anterior, ou que o evento não tenha sido calculado, ou que esteja em um processamento diferente de 13º salário integral ou não estiver calculando o 13º na competência de Dezembro, retornará 0 (zero). Esta função visa atender às exigências do eSocial.

Parâmetro	Descrição	Obrigatório
codigoEvento	Código do evento que deseja buscar o valor na folha de 13º salário integral adiantada. Quando não informado, buscará do próprio evento	Não

//exemplo onde buscará o valor do próprio evento lançado na folha de 13º salário integral anterior a Dezembro para desconto na folha de 13º salário integral de Dezembro
valorCalculado -= Funcoes.buscaValorEvento13SalarioIntegralAdiantado()

//exemplo onde buscará o valor do evento "51 - I.N.S.S. 13º SALÁRIO" lançado na folha de 13º salário integral anterior a Dezembro para desconto na folha de 13º salário integral de Dezembro
valorCalculado -= Funcoes.buscaValorEvento13SalarioIntegralAdiantado(51)

Calcexclusivo()

Função
calcexclusivo() - Calcula o evento exclusivamente no tipo de processamento com maior número de dias, se a quantidade de dias foram a mesma na comparação retirnar o tipo de processamento 1.

Parâmetro	Descrição	Obrigatório
valorReferencia	Valor de referência, esse é o valor que será retornado	Sim
tipoProcessamento1	Tipo de processamento 1	Sim
diasProcessamento1	Dias do tipo de processamento 1 (para comparação)	Sim
tipoProcessamento2	Tipo de processamento 2	Sim
diasProcessamento2	Dias do tipo de processamento 2 (para comparação)	Sim

int diasTrabalhados = 18
int diasFerias = 12

Funcoes.calcexclusivo(funcionario.salario, TipoProcessamento.MENSAL, diasTrabalhados, TipoProcessamento.FERIAS, diasFerias)
//O cálculo da folha mensal será mantido e das férias cancelado

Calcprop()

Função
calcprop() - Calcula um valor proporcionalmente ao número de dias ou horas passados por parâmetro. Esta proporção é feita em relação a carga horária do funcionário na unidade que está nos parâmetros do sistema.

Parâmetro	Descrição	Obrigatório
vlrCalc	Valor que deseja-se calcular a proporcionalidade	Sim
proprocional	Quantidade de horas ou dias a ser aplicada a proporção. Este valor deve estar na mesma unidade configurada em Parâmetros	Sim

BigDecimal salario = funcionario.salario;

valorCalculado = Funcoes.calcprop(salario, Funcoes.cvndpbase(Funcoes.diastrab()));

CarregaEmprestimoEmFerias()

Função
carregaEmprestimoEmFerias() - Realiza validações internas para registrar os valores de empréstimo nas folhas de pagamento de férias, conforme existir gozo ou apenas abono na competência de pagamento, possibilitando a réplica dos valores posteriormente.

Parâmetro	Descrição	Obrigatório
considerarApenasFeriasComGozo	Define se será considerado o carregamento do empréstimo apenas em férias com gozo, quando 'true', ou também em férias apenas com abonos, quando 'false'	Sim

//exemplo do evento padrão "119 - EMPRÉSTIMOS" na primeira linha de fórmula
Funcoes.carregaEmprestimoEmFerias(true)
//trata os valores dos empréstimos lançados em folhas de férias - informando true, considerará apenas quando houver gozo

Função
categoriaSefipVinculo() - Retorna o código da ocorrência Sefip da matrícula. Para autônomos, retornará 13, e para matrículas que não possuam ocorrência, retornará 0.

int codigoOcorrenciaSefip = Funcoes.categoriaSefipVinculo()

Cedidocomonus()

Função
cedidocomonus() - Retorna os dias com afastamento na competência devido cedência com ônus.

int cedidocomonus = Funcoes.cedidocomonus()

Cedidosemonus()

Função
cedidosemonus() - Retorna os dias com afastamento na competência devido cedência sem ônus.

int cedidosemonus = Funcoes.cedidosemonus()

Cnvdpbase()

Função
cnvdpbase() - Converte um número de dias para a unidade de cálculo configurada em Parâmetros gerais de cálculo.

Parâmetro	Descrição	Obrigatório
dias	Para matrícula do tipo Funcionário, converte uma quantidade de dias para a unidade configurada em Parâmetros. Para os demais tipos de matrículas o retorno é fixo o próprio valor passado neste parâmetro. Quando já estiver configurado em dias, será retornado o próprio valor passado neste parâmetro	Sim

vaux = Funcoes.cnvdpbase(Funcoes.afasservmil())
valorReferencia = vaux

CodigoMatricula()

Função
codigoMatricula() - Busca o código da matrícula com contrato que está sendo calculada no momento, removendo a barra que separa o código do contrato.

int codigo = Funcoes.codigoMatricula()

ConcessaoFeriasCompetencia()

Função
concessaoFeriasCompetencia() - Busca a quantidade de dias do gozo de férias que está sendo executada/concedida entre as datas inicial e final informadas.

Parâmetro	Descrição	Obrigatório
dataInicioGozo	Data inicial para buscar o gozo das férias que está sendo calculada	Sim
dataFimGozo	Data final para buscar o gozo das férias que está sendo calculada	Sim

int diasferias = Funcoes.concessaoFeriasCompetencia(periodoConcessao.dataInicioGozo, periodoConcessao.dataFimGozo)

DadosMatricula()

Função
dadosMatricula() - Retorna alguns dados de matrícula, a função verifica o tipo de matrícula que está sendo calculada para buscar conforme o tipo.

/**
 * As propriedades para consulta são, a data de início (dataInicio), a data de saída (dataSaida), e o indicativo se existe saída (existeSaida)
 */

Object dados = Funcoes.dadosMatricula()

Date dataInicio = dados.dataInicio
Date dataSaida = dados.dataSaida
Boolean existeSaida = dados.existeSaida

Deducauxmat13()

Função
deducauxmat13() - Calcula o valor de dedução do salário maternidade para o 13º salário, referente os meses afastados por auxílio maternidade no que está sendo calculado.

Parâmetro	Descrição	Obrigatório
base	Valor da base de cálculo da previdência federal no 13º salário	Sim
avos	Quantidade de avos de 13º salário na competência que esta sendo calculada	Sim

BigDecimal base = Bases.valor(Bases.FUNDFIN13) - Bases.valor(Bases.DESC13REINT)
valorCalculado = Funcoes.deducauxmat13(base, Funcoes.avos13(Datas.mes(calculo.competencia)))

DescricaoCargo()

Função
descricaoCargo() - Retorna o nome do cargo que está vinculado à matrícula na competência. Quando não houver um cargo informado, retornará uma informação vazia.

def cargo = Funcoes.descricaoCargo()

DescricaoVinculo()

Função
descricaoVinculo() - Retorna o nome do vínculo empregatício que está vinculado à matrícula na competência. Quando não houver um cargo informado, retornará uma informação vazia.

def vinculoEmpregaticio = Funcoes.descricaoVinculo()

Diasabono()

Função
diasabono() - Busca a quantidade total de dias de abono da férias que está sendo executada/concedida.

int diasabono = Funcoes.diasabono()

Diasafast()

Função
diasafast() - Busca o número de dias afastados em um determinado período, para determinadas classificações de tipos de afastamentos especificadas por parâmetro.

Parâmetro	Descrição	Obrigatório
dataInicial	Data inicial para buscar os afastamentos	Sim
dataFinal	Data final para buscar os afastamentos	Sim
afastamentos	Lista de Classificações de Tipos de Afastamentos	Sim
descricaoTipoAfastamento	Descricao do Tipo de Afastamento	Não

List classificacoes = [
    ClassificacaoTipoAfastamento.LICENCA_MATERNIDADE,
    ClassificacaoTipoAfastamento.ABORTO_NAO_CRIMINOSO,
    ClassificacaoTipoAfastamento.PRORROGACAO_DA_LICENCA_MATERNIDADE]

String tipoAfastamento = "Auxilio Maternidade"

int dias = Funcoes.diasafast(Funcoes.inicioCompetencia(), calculo.competencia, classificacoes, tipoAfastamento)

Diasafastcalc30()

Função
diasafastcalc30() - Esta função busca o número de dias afastados numa determinada competência, considerando que todos os meses sejam de trinta dias (mês para efeito de folha de pagamento), para determinados tipos de afastamentos, especificados por parâmetro.

Parâmetro	Descrição	Obrigatório
competencia	Competência para buscar os afastamentos (Date)	Sim
afastamentos	Lista de Classificações de Tipos de Afastamentos	Sim
descricaoTipoAfastamento	Descricao do Tipo de Afastamento	Não

List classificacoes = [
    ClassificacaoTipoAfastamento.LICENCA_MATERNIDADE,
    ClassificacaoTipoAfastamento.ABORTO_NAO_CRIMINOSO,
    ClassificacaoTipoAfastamento.PRORROGACAO_DA_LICENCA_MATERNIDADE]

String tipoAfastamento = "Auxilio Maternidade"

int dias = Funcoes.diasafast(Funcoes.inicioCompetencia(), calculo.competencia, classificacoes, tipoAfastamento)

Diasuteis()

Função
diasuteis() - Retorna o número de dias úteis de um determinado período, podendo ou não considerar os sábados como dias úteis. Os domingos serão descartados e os feriados cadastrados no sistema (Cadastro de Feriados) também serão descartados.

Parâmetro	Descrição	Obrigatório
dataInicial	Data inicial para buscar os dias úteis	Sim
dataFinal	Data final para buscar os dias úteis	Sim
sabadoutil	Se é para considerar os sábados como dias úteis	Sim

Date dataInicial = Datas.data(2021,1,1)
Date dataFinal = Datas.data(2021,1,31)

int diasuteis = Funcoes.diasuteis(dataInicial, dataFinal, false)

BigDecimal vales = diasuteis * 3.50

Diasuteisafast()

Função
diasuteisafast() - Retorna o número de dias úteis afastados de um determinado período, para determinados tipos de afastamentos especificados por parâmetro, podendo ou não considerar os sábados como dias úteis. Os domingos serão descartados e os feriados cadastrados no sistema (Cadastro de Feriados) também serão descartados.

Parâmetro	Descrição	Obrigatório
dataInicial	Data inicial para buscar os dias úteis	Sim
dataFinal	Data final para buscar os dias úteis	Sim
sabadoutil	Se é para considerar os sábados como dias úteis	Sim
classificacaoDescricaoAafastamentos	Lista de Classificações de Tipos de Afastamentos ou lista de tipos de afastamentos (descrição)	Sim

Date dataInicial = Datas.data(2021,1,1)
Date dataFinal = Datas.data(2021,1,31)

List classificacaoAfastamentos = [
    ClassificacaoTipoAfastamento.LICENCA_SEM_VENCIMENTOS,
    ClassificacaoTipoAfastamento.LICENCA_COM_VENCIMENTOS
    ]

//Consulta por classificação de afastamentos
int diasuteisafastcalc30 = Funcoes.diasuteisafastcalc30(competencia, false, classificacaoAfastamentos)

List tiposAfastamentos = ['Licença sem vencimentos', 'Licença prêmio']
//Consulta por tipo de afastamento
int diasuteisafastcalc30 = Funcoes.diasuteisafastcalc30(competencia, false, tiposAfastamentos)

Diasuteisafastcalc30()

Função
diasuteisafastcalc30() - Esta função retorna o número de dias úteis afastados de uma determinada competência, considerando que todos os meses sejam de trinta dias (mês para efeito de folha de pagamento), para determinados tipos de afastamentos especificados por parâmetro. Os sábados poderão ser considerados como dias úteis, mas os domingos e os feriados cadastrados no sistema (Cadastro de Feriados) serão descartados.

Parâmetro	Descrição	Obrigatório
competencia	Data inicial da competência para buscar os dias úteis	Sim
sabadoutil	Se é para considerar os sábados como dias úteis	Sim
classificacaoAafastamentos	Lista de Classificações de Tipos de Afastamentos ou lista de tipos de afastamentos (descrição)	Sim

Date competencia = calculo.competencia

List classificacaoAfastamentos = [
    ClassificacaoTipoAfastamento.LICENCA_SEM_VENCIMENTOS,
    ClassificacaoTipoAfastamento.LICENCA_COM_VENCIMENTOS
    ]

//Consulta por classificação de afastamentos
int diasuteisafastcalc30 = Funcoes.diasuteisafastcalc30(competencia, false, classificacaoAfastamentos)

List tiposAfastamentos = ['Licença sem vencimentos', 'Licença prêmio']
//Consulta por tipo de afastamento
int diasuteisafastcalc30 = Funcoes.diasuteisafastcalc30(competencia, false, tiposAfastamentos)

Diasuteiscalc30()

Função
diasuteiscalc30() - Esta função retorna o número de dias úteis de uma determinada competência, considerando que todos os meses sejam de trinta dias (mês para efeito de folha de pagamento). Os sábados poderão ser considerados como dias úteis, mas os domingos e os feriados cadastrados no sistema (Cadastro de Feriados) serão descartados.

Parâmetro	Descrição	Obrigatório
competencia	Data inicial da competência para buscar os dias úteis	Sim
sabadoutil	Se é para considerar os sábados como dias úteis	Sim

Date competencia = calculo.competencia

int diasuteiscalc30 = Funcoes.diasuteiscalc30(competencia, false, classificacaoAfastamentos)

Diasaposent()

Função
diasaposent() - Retorna os dias de aposento na competência.

int diasaposent = Funcoes.diasaposent()

Diasferias()

Função
diasferias() - Retorna os dias de férias na competência.

int diasferias = Funcoes.diasferias()

Diasgozo()

Função
diasgozo() - Busca a quantidade total de dias de gozo da férias que está sendo executada/concedida.

int diasgozo = Funcoes.diasgozo()

Diaspensionista()

Função
diaspensionista() - Retorna os dias de pensão na competência

int diaspensionista = Funcoes.diaspensionista()

Diastrab()

Função
diastrab() - Retorna os dias trabalhados na competência.

int diastrab = Funcoes.diastrab()

Dtafast()

Função
dtafast() - Busca a última data de afastamento, na competência calculada de um determinado tipo de afastamento.

Parâmetro	Descrição	Obrigatório
classificacao	Classificação de afastamento	Sim
licencaMaternidadeOrgininal	Este argumento é opcional e só terá validade para afastamentos de classificação PRORROGACAO_DA_LICENCA_MATERNIDADE. Quando esse argumento não for informado, ou for passado false, será retornada a data do início da prorrogação. Caso seja informado true, será retornada a data de início da licença maternidade que originou a prorrogação	Não

int dtafast = Funcoes.dtafast(ClassificacaoTipoAfastamento.PRORROGACAO_DA_LICENCA_MATERNIDADE, true)

Dtrescisao()

Função
dtrescisao() - Retorna a data da final de uma matrícula de qualquer tipo, caso não exista retorna 0

def dtrescisao = Funcoes.dtrescisao()

Faltas()

Função
faltas() - Busca o número de faltas em determinado período especificado. O número de faltas é buscado independentemente de ter sido processado o cálculo na época da falta, ou seja, mesmo que não exista cálculo nas competências das faltas lançadas no Cadastro de Afastamentos (decorrência faltas).

Parâmetro	Descrição	Obrigatório
justificada	Se deseja retornar faltas justificadas. Informar true ou false	Sim
dataCompetenciaInicial	Competência inicial, caso não seja informada será considerada a competência atual (Date)	Sim
dataCompetenciaFinal	Competência final, caso não seja informada será considerada a competência atual (Date)	Sim
motivo	Informe a descrição do motivo de falta, para retornar de qualquer motivo informe 0 ou false	Não
abonada	Se deseja retornar faltas abonadas. Informar true ou false	Não

if (vlraux <= 0) {
    Date inicioCompetencia = Datas.data(Datas.ano(calculo.competencia), Datas.mes(calculo.competencia), 1)
    vlraux = Funcoes.faltas(false, inicioCompetencia, calculo.competencia, 0, false)
}

FimCompetencia()

Função
fimCompetencia() - Retorna uma data referente ao último dia da competência que está sendo calculada

Date fimCompetencia = Funcoes.fimCompetencia()

GetAssistMunicipalFerias()

Função
getAssistMunicipalFerias() - Essa função busca o valor da assistência municipal do processamento férias e faz a proporcionalização com os dias de férias na competência.

Object assistMunicipalFerias = Funcoes.getAssistMunicipalFerias()
BigDecimal referencia        = assistMunicipalFerias.referencia
BigDecimal valor             = assistMunicipalFerias.valor

GetfgtsFerias()

Função
getfgtsFerias() - Essa função busca o valor de FGTS do processamento férias e faz a proporcionalização com os dias de férias na competência.

Object fgtsFerias = Funcoes.getfgtsFerias()
BigDecimal referencia = fgtsFerias.referencia
BigDecimal valor      = fgtsFerias.valor

GetFundoFinanceiroFerias()

Função
getFundoFinanceiroFerias() - Essa função busca o valor do fundo financeiro do processamento férias e faz a proporcionalização com os dias de férias na competência.

Object fundoFinanceiroFerias = Funcoes.getFundoFinanceiroFerias()
BigDecimal referencia        = fundoFinanceiroFerias.referencia
BigDecimal valor             = fundoFinanceiroFerias.valor

GetInssFerias()

Função
getInssFerias() - Essa função busca o valor de INSS do processamento férias e faz a proporcionalização com os dias de férias na competência.

Object inssFerias = Funcoes.getInssFerias()
BigDecimal referencia = inssFerias.referencia
BigDecimal valor      = inssFerias.valor

GetIrrfFerias()

Função
getIrrfFerias() - Essa função busca o valor de IRRF do processamento férias e faz a proporcionalização com os dias de férias na competência.

Object irrfFerias = Funcoes.getIrrfFerias()
BigDecimal referencia = irrfFerias.referencia
BigDecimal valor      = irrfFerias.valor

GetPrevEstadualFerias()

Função
getPrevEstadualFerias() - Essa função busca o valor da previdência estadual do processamento férias e faz a proporcionalização com os dias de férias na competência.

Object prevEstadualFerias = Funcoes.getFundoFinanceiroFerias()
BigDecimal referencia     = prevEstadualFerias.referencia
BigDecimal valor          = prevEstadualFerias.valor

GetPrevPropriaFerias()

Função
getPrevPropriaFerias() - Essa função busca o valor da previdência própria do processamento férias e faz a proporcionalização com os dias de férias na competência.

Object prevPropriaFerias = Funcoes.getPrevPropriaFerias()
BigDecimal referencia    = prevPropriaFerias.referencia
BigDecimal valor         = prevPropriaFerias.valor

GetTotalFerias()

Função
getTotalFerias() - Retorna o total da folha de férias, desconsiderando eventos de INSS/RPPS e IRRF. Esta função verifica eventos da folha interna de férias e também os eventos da folha de pagamento de férias que não existem na folha interna de férias.

Object totalFerias  = Funcoes.getTotalFerias()
BigDecimal provento = totalFerias.provento
BigDecimal desconto = totalFerias.desconto
BigDecimal liquido  = totalFerias.liquido

GetValorClassifEventoFerias()

Função
getValorClassifEventoFerias() - Retorna o valor total ou proporcional à quantidade de dias de férias na competência da classificação do evento informado.

Parâmetro	Descrição	Obrigatório
classificacaoEvento	Classificação do evento	Sim
buscarValorIntegral	Se deseja considerar o valor integral do evento, informe true. Caso não seja informado ou informe false, retorna o valor proporcional aos dias de gozo de férias na competência	Não

Object InssFerias     = Funcoes.getValorClassifEventoFerias(ClassificacaoEvento.INSS, false)
BigDecimal valor      = InssFerias.valor
BigDecimal referencia = InssFerias.referencia

GetValorCodigoEventoFerias()

Função
getValorCodigoEventoFerias() - Retorna o valor total ou proporcional à quantidade de dias de férias na competência do código de evento informado.

Parâmetro	Descrição	Obrigatório
codigoEvento	Código do evento	Sim
buscarValorIntegral	Se deseja considerar o valor integral do evento, informe true. Caso não seja informado ou informe false, retorna o valor proporcional aos dias de gozo de férias na competência	Não

Object InssFerias     = Funcoes.getValorCodigoEventoFerias(88, false)
BigDecimal valor      = InssFerias.valor
BigDecimal referencia = InssFerias.referencia

GetValorFerias()

Função
getValorFerias() - Retorna o valor de um evento da folha de férias, podendo definir se deseja buscar da folha interna ou da folha de pagamento.

Parâmetro	Descrição	Obrigatório
codigoEvento	Código do evento	Sim
buscarFolhaPagamento	Informe 'true' deseja buscar da folha de pagamento e folha interna informar. Se não for informado ou ser 'false', irá buscar apenas da folha interna	Não

Object valorFerias    = Funcoes.getValorFerias()
BigDecimal valor      = valorFerias.valor
BigDecimal referencia = valorFerias.referencia

GetValorFeriasEventoVariavel()

Função
getValorFeriasEventoVariavel() - Retorna o valor de um evento da folha de férias buscado na folha interna.

Parâmetro	Descrição	Obrigatório
codigoEvento	Código do evento	Sim
somarReferencias	Informe 'true' caso deseje somar as referências dos eventos variáveis iguais quando houver mais de uma férias calculada. Se não for informado ou ser 'false', irá considerar a última referência calculada	Não

//Chamada da função realizada pela função "Funcoes.replicaEventoVariavel(codigoEvento)"

Object valorFeriasEventoVariavel = Funcoes.getValorFeriasEventoVariavel()
BigDecimal valor                 = valorFerias.valor
BigDecimal referencia            = valorFerias.referencia

Idade()

Função
idade() - Retorna da idade comparando a diferença entre duas datas.

Parâmetro	Descrição	Obrigatório
menorData	Menor data	Sim
maiorData	Maior data	Sim

int idade = Funcoes.idade(Datas.data(1970,1,1), Datas.hoje());

InicioCompetencia()

Função
inicioCompetencia() - Retorna uma data referente ao primeiro dia da competência que está sendo calculada.

Date inicioCompetencia = Funcoes.inicioCompetencia()

Mesesafast()

Função
mesesafast() - Busca o número de meses afastados em um determinado período, para determinadas classificações de tipos de afastamentos, especificados por parâmetro.

Parâmetro	Descrição	Obrigatório
dataInicial	Data inicial para buscar os afastamentos	Sim
dataFinal	Data final para buscar os afastamentos	Sim
classificações	Lista de Classificações de Tipos de Afastamentos	Sim

List afastamentos = [ClassificacaoTipoAfastamento.AUXILIO_DOENCA_PREVIDENCIA, ClassificacaoTipoAfastamento.LICENCA_SEM_VENCIMENTOS]
Date dtbase = funcionario.dataBase
Date dfin = Datas.removeMeses(calculo.competencia, 1)
int meses = Funcoes.mesesafast(dtbase, dfin, afastamentos)

Mesesmat13()

Função
mesesmat13() - Busca o número de meses afastados no ano por auxílio maternidade, para desconto de 13º salário. A contagem destes meses será de acordo com a regra dos avos para o 13º salário (mais que 14 dias trabalhados no mês conta como avo de 13º).

if (funcionario.possuiPrevidenciaFederal) {
    int vaux = Funcoes.mesesmat13()
}

OcorrenciaSefip()

Função
ocorrenciaSefip() - Retorna a ocorrência Sefip da matrícula. Para autônomos, retornará 'CONTRIBUINTE_INDIVIDUAL', e para matrículas que não possuam ocorrência, retornará NENHUMA.

String ocorrenciaSefip = Funcoes.ocorrenciaSefip()

OptanteFgts()

Função
optanteFgts() - Retorna se a matrícula é optante de FGTS, caso seja um tipo de matrícula que não possua opção retornará false, essa função pode ser usada para evitar a checagem do tipo de matrícula.

Parâmetro	Descrição	Obrigatório
tipoMatricula	Tipo da matrícula	Sim

if (Funcoes.optanteFgts(matricula.tipo)) {
    imprimir "É optante de FGTS"
}

Pagapensao()

Função
pagapensao() - Indica se o servidor possui dependentes de pensão. Serão consideradas apenas as pensões vigentes.

Boolean pagapensao = Funcoes.pagapensao()

Permitecalc13integral()

Função
permitecalc13integral() - Indicativo se pode ser realizado o cálculo de décimo terceiro salário integral.

Boolean permitecalc13integral = Funcoes.permitecalc13integral()

Função
permiteCalculoAuxilioMaternidade() - Indicativo se um cálculo de auxílio maternidade pode ser realizado

Boolean permiteCalculoAuxilioMaternidade = Funcoes.permiteCalculoAuxilioMaternidade()

PossuiPrevidencia()

Função
possuiPrevidencia() - Retorna se a matrícula possui o tipo de previdência própria informada. Caso seja um tipo de matrícula que não possua opção ou que seja optante da previdência federal, retornará false. Esta função pode ser usada para evitar a checagem do tipo de matrícula.

Parâmetro	Descrição	Obrigatório
tipoPrevidencia	Tipo de previdência	Sim

Boolean possuiPrevidencia = Funcoes.possuiPrevidencia(TipoPrevidencia.PREVIDENCIA_PROPRIA)

Função
possuiPrevidenciaFederal() - Retorna se a matrícula possui previdência federal. Caso seja um tipo de matrícula que não possua opção retornará false. Esta função pode ser usada para evitar a checagem do tipo de matrícula.

Parâmetro	Descrição	Obrigatório
tipoMatricula	Tipo da matrícula	Sim

Boolean possuiPrevidenciaFederal = Funcoes.possuiPrevidenciaFederal(matricula.tipo)

PrimeiroDia()

Função
primeiroDia() - Retorna a data referente ao primeiro dia de uma competência passada por parâmetro.

Parâmetro	Descrição	Obrigatório
data	informe uma data	Sim

Date data = Funcoes.primeiroDia(funcionario.dataAdmissao)

QuantPrevidenciasAtivas()

Função
quantPrevidenciasAtivas() - Retorna a quantidade de previdências ativas na matrícula.

int quantPrevidencias = Funcoes.quantPrevidenciasAtivas()

recebeDecimoTerceiro()

Função
recebeDecimoTerceiro() - Retorna se a matrícula recebe décimo terceiro salário, caso seja um tipo de matrícula que não possua opção retornará false, essa função pode ser usada para evitar a checagem do tipo de matrícula.

Parâmetro	Descrição	Obrigatório
tipoMatricula	Tipo da matrícula	Sim

Boolean recebeDecimoTerceiro = Funcoes.recebeDecimoTerceiro(matricula.tipo)

Recebidocomonus()

Função
recebidocomonus() - Retorna os dias recebidos sem ônus na competência, conforme o tipo de admissão e responsabilidade de pagamento definidos para a matrícula.

int recebidocomonus = Funcoes.recebidocomonus()

Recebidosemonus()

Função
recebidosemonus() - Retorna os dias recebido com ônus na competência, conforme o tipo de admissão e responsabilidade de pagamento definidos para a matrícula.

int recebidosemonus = Funcoes.recebidosemonus()

Remuneracao()

Função
remuneracao() - Retorna dados de remuneração da matrícula independentemente do tipo.

Parâmetro	Descrição	Obrigatório
tipo	Tipo da matrícula	Sim

Object remuneracao = Funcoes.remuneracao(matricula.tipo)
BigDecimal valor               = remuneracao.valor
BigDecimal quantidadeHorasMes  = remuneracao.quantidadeHorasMes
if (remuneracao.unidade.equals(UnidadePagamento.MENSALISTA)) {
    imprimir "Unidade de pagamento é mensal"
}

Função
replicaEventoVariavel() - Esta função é utilizada para realizar a réplica de eventos lançados em variáveis, sejam eles carregados do processamento mensal ou do processamento de férias, para o processamento mensal. IMPORTANTE: o evento variável será lançado na competência de início de gozo de férias. Para competências sem gozo, a função não fará o carregamento em férias.

Parâmetro	Descrição	Obrigatório
codigoEvento	Código do evento	Sim

Object valorFerias = Funcoes.replicaEventoVariavel(evento.codigo)
BigDecimal valorCalculado = valorFerias.valor
BigDecimal valorReferencia = valorFerias.referencia

ReplicaFeriasNaFolhaMensal()

Função
replicaFeriasNaFolhaMensal() - Esta função é utilizada para realizar a réplica de eventos de férias para o processamento mensal.

Parâmetro	Descrição	Obrigatório
codigoEvento	Código do evento	Sim
listaComposicaoBasesValorCalculado	Uma lista de bases para incidência	Não
listaComposicaoBasesValorReferencia	Uma lista de bases para incidência	Não
listaComposicaoBasesSobreSalario	Uma lista de bases para incidência	Não
listaComposicaoBasesSobrePagaProporcional	Uma lista de bases para incidência	Não

Object valorFerias = Funcoes.replicaFeriasNaFolhaMensal(evento.codigo)
if (valorFerias.valor > 0) {
    Bases.compor(valorFerias.valor, Bases.INSS, Bases.FGTS)
}
BigDecimal valorCalculado = valorFerias.valor
BigDecimal valorReferencia = valorFerias.referencia

SomenteAposentadosPensionistas()

Função
somenteAposentadosPensionistas() - Esta função suspende o cálculo do evento caso a matrícula não seja do tipo aposentado ou pensionista. Esta função não possui retorno.

Funcoes.somenteAposentadosPensionistas()
//suspende o cálculo do evento se não for um aposentado ou pensionista

SomenteFuncionarios()

Função
somenteFuncionarios() - Esta função suspende o cálculo do evento caso a matrícula não seja do tipo funcionário. Esta função não possui retorno.

Funcoes.somenteFuncionarios()
//suspende o cálculo do evento se não for um funcionário

Constantes

ClassificacaoEvento

Valor	Descrição
ABATFUNDOASSISTENCIAFER	Abatimento Fundo de Assistência pago em férias
ABATFUNDOPREVIDENCIAFER	Abatimento Fundo de Previdência pago em férias
ABATFUNDOFINANCEIROFER	Abatimento Fundo Financeiro pago em férias
ABATINSSFER	Abatimento INSS pago em férias
ABATPREVIDENCIAESTADUALFER	Abatimento Previdência Estadual pago em férias
ABATSALM	Abatimento salário maternidade
ABATSALM13	Abatimento salário maternidade 13º salário
ABONOTERCO	1/3 de abono
ADI13SAL	13º salário adiantado
ADIFERIAS	Adiantamento de férias
ADISALNDESC	Adiantamento salarial não descontado
AUXNAT	Auxílio natalidade
AUXDOENCA15DIAS	Auxílio doença/acidente até 15 dias
AVPREDESC	Aviso prévio descontado
AVPREIND	Aviso prévio indenizado
AVPREIND13SAL	13º salário aviso prévio indenizado
AVPREINDUMDOZE	1/12 aviso prévio indenizado
BASABATINSSDV	Base abatimento INSS - duplo vínculo
BASEINSSNEG	Base negativa INSS - Mensal
BASINSSDV	Base INSS - duplo vínculo
BASINSSDV13SAL	Base INSS 13º salário - duplo vínculo
BASINSSOUTEMP	Base INSS outras empresas
BASINSSOUTEMP13SAL	Base INSS outras empresas 13º salário
BASIRRFDV	Base IRRF - duplo vínculo
BASIRRFDV13SAL	Base IRRF 13º salário - duplo vínculo
BASIRRFFERIASANT	Base IRRF de férias anteriores
BASIRRFFERIASRESCDV	Base IRRF férias resc. - duplo vínculo
BASIRRFOUTEMP	Base IRRF outras empresas
BASIRRFOUTEMP13SAL	Base IRRF outras empresas 13º salário
DESC13SALADI	Desconto 13º salário adiantado
DESC13SALDEVREINTG	Desconto de 13º salário devido reintegração
DESC13SALINTEGADI	Desc. do 13º Integral adiantado
DESC13SALINTEGADIESOCIAL	Desc. do 13º Integral adiantado eSocial
DESCADISAL	Desconto adiantamento salarial
DESCDEP	Desconto por dependente
DESCHAUXMAT	Desc. horas aux. maternidade
DESCHAUXMAT13SAL	Desc. horas aux. maternidade 13º salário
DEVFGTS	Devolução FGTS 13º salário
DEVINSS	Devolução de INSS
DEVIRRF	Devolução de IRRF
EMPRESTIMO	Empréstimos
FALTADSR	Faltas DSR
FALTAS	Faltas
FERDOBROTERCO	1/3 de férias em dobro
FERIASADI	Férias adiantadas
FERIASTERCO	1/3 de férias
FERINDENTERCO	1/3 de férias indenizadas
FERPROPTERCO	1/3 de férias proporcionais
FERVENCTERCO	1/3 de férias vencidas
FGTS	FGTS
FGTS13SAL	FGTS 13º salário
FGTSAVPRE	FGTS aviso prévio
FGTSMESANT	FGTS mês anterior
FGTSSOBFERIAS	FGTS sobre férias
FUNDASS	Fundo assistência
FUNDASS13SAL	Fundo assistência 13º salário
FUNDFIN	Fundo financeiro
FUNDFIN13SAL	Fundo financeiro 13º salário
FUNDPREV	Fundo previdência
FUNDPREV13SAL	Fundo previdência 13º salário
HAUXMATNPAG	Horas aux. maternidade não pagas
HORASFERIAS	Horas férias
HORASFERIASAVPREVIND	Horas férias aviso prévio indenizado
HORASFERIASCOL	Horas férias coletivas
INSS	INSS
INSS13SAL	INSS 13º salário
INSSSOBHAUXMATNPAG	INSS sobre horas aux. matern. não pagas
INTEG13SAL	13º salário integral
IRRF	IRRF
IRRF13SAL	IRRF 13º salário
IRRFFERIASRESC	IRRF férias rescisão
ISS	ISS - Imposto Sobre Serviço
LIQ13SALINTEGADI	Líquido do 13º Integral adiantado
MULTAFGTS	Multa do FGTS
NENHUMA	Nenhuma
PARCISENFUNDFIN	Parcela isenta fundo financeiro
PARCISENFUNDFIN13SAL	Parcela isenta fundo financeiro 13º salário
PARCISENFUNDPREV	Parcela isenta fundo previdência
PARCISENFUNDPREV13SAL	Parcela isenta fundo previdência 13º salário
PARCISENIRRF	Parcela isenta IRRF
PARCISENIRRF13SAL	Parcela isenta IRRF 13º salário
PARCISENIRRFMOLGRV	Parcela isenta IRRF moléstia grave
PARCISENIRRFMOLGRV13SAL	Parcela isenta IRRF moléstia grave 13º salário
PARCISENIRRFMOLGRVFERIAS	Parcela isenta IRRF moléstia grave férias
PARCISENIRRFMOLGRVFERIASADI	Parc. isenta IRRF moléstia grave férias adiant
PARCISENIRRFMOLGRVFERIASRESC	Parc. isenta IRRF moléstia grave férias resc.
PARCISENIRRFSOBFERIASRESC	Parcela isenta IRRF sobre férias resc.
PENSJUDDESC	Pensão judicial - Desconto
PLANOSAUDE	Plano de saúde
PONTIDAO	Prontidão
PREVEST	Prev. estadual
PREVESTDECSAL	Prev. estadual 13º salário
PROCEDMED	Procedimentos médicos
PRORROGAUXMAT11770	Prorrog. do aux. maternidade - Lei 11770/2008
REDBASINSSTRANSPAUT	Redutor base INSS transportador autônomo
REDBASIRRFTRANSPAUT	Redutor base IRRF transportador autônomo
RPPSABAT	Abatimento para RPPS
RPPSABAT13	Abatimento para RPPS 13º salário
SALFAMAPOS	Salário família aposentado
SALFAMCEL	Salário família celetista
SALFAMESP	Salário família especial
SALFAMEST	Salário família estatutário
SALFAMPAGMAIOR	Salário família pago a maior
SENAT	SENAT
SEST	SEST
SOBREAVISO	Sobreaviso
TOTDESC13SALINTEGADI	Total de desc. do 13º Integral adiantado
VALETRANSP	Vale transporte - custo empregador

TipoProcessamento

Valor	Descrição
MENSAL	Mensal
FERIAS	Férias
DECIMO_TERCEIRO_SALARIO	Décimo terceiro salário
RESCISAO	Rescisão

SubTipoProcessamento

Valor	Descrição
INTEGRAL	Integral
ADIANTAMENTO	Adiantamento
COMPLEMENTAR	Complementar

TipoAvisoPrevio

Valor	Descrição
TRABALHADO_REDUCAO_2_HORAS_DIARIAS	Trabalhado com redução de 2 horas diárias
TRABALHADO_REDUCAO_7_DIAS_CORRIDOS	Trabalhado com redução de 7 dias corridos
INDENIZADO	Indenizado
TRABALHADO	Trabalhado
DESCONTADO	Descontado
DISPENSADO	Dispensado

TipoEvento

Valor	Descrição
VENCIMENTO	Vencimento (provento)
DESCONTO	Desconto
INFORMATIVO_MAIS	Informativo mais (evento de vencimento que não compõe líquido)
INFORMATIVO_MENOS	Informativo menos (evento de desconto que não compõe líquido)

UnidadeEvento

Valor	Descrição
AUTOMATICO	Automático
AVOS	Avos
DIAS	Dias
HORAS	Horas
PERCENTUAL	Percentual
QUANTIDADE	Quantidade
VALOR	Valor

FormaPagamento

Valor	Descrição
DINHEIRO	Dinheiro
CHEQUE	Cheque
CREDITO_EM_CONTA	Crédito em conta

GrauDeficiencia

Valor	Descrição
PARCIAL	Parcial
TOTAL	total
NAOINVALIDO	Não inválido

MesContribuicaoSindical

Valor	Descrição
JANEIRO	Janeiro
FEVEREIRO	Fevereiro
MARCO	Março
ABRIL	Abril
MAIO	Maio
JUNHO	Junho
JULHO	Julho
AGOSTO	Agosto
SETEMBRO	Setembro
OUTUBRO	Outubro
NOVEMBRO	Novembro
DEZEMBRO	Dezembro

OrigemRendimento

Valor	Descrição
CARGO	Cargo
CARGO_COMISSIONADO	Cargo comissionado

Sexo

Valor	Descrição
MASCULINO	Masculino
FEMININO	Feminino

TipoAdmissao

Valor	Descrição
ADMISSAO	Admissão
TRANSFERENCIA	Transferência
SUBSTITUICAO	Substituição

TipoVinculo

Valor	Descrição
CELETISTA	Celetista
ESTATUTARIO	Estatutário
OUTROS	Outros

TipoMatricula

Valor	Descrição
FUNCIONARIO	Funcionário
ESTAGIARIO	Estagiário
AUTONOMO	Autônomo
APOSENTADO	Aposentado
PENSIONISTA	Pensionista

ResponsabilidadePagamento

Valor	Descrição
PAGAMENTO_EXCLUSIVAMENTE_PELO_CEDENTE_ORIGEM	Pagamento exclusivamente feito pelo cedente (origem)
PAGAMENTO_EXCLUSIVAMENTE_PELO_CESSIONARIO_DESTINO	Pagamento exclusivamente feito pelo cessionário (destino)
PAGAMENTO_PELO_CEDENTE_ORIGEM_E_PELO_CESSIONARIO_DESTINO	Pagamento feito pelo cedente e pelo cessionário
PAGAMENTO_PELO_CEDENTE_ORIGEM_COM_RESSARCIMENTO_PELO_CESSIONARIO_DESTINO	Pagamento feito pelo cedente e ressarcimento pelo cessionário

TipoOnus

Valor	Descrição
CEDENTE	Cedente
CESSIONARIO	Cessionário

TipoRegime

Valor	Descrição
CAIXA	Caixa
COMPETENCIA	Competência

TipoValor

Valor	Descrição
CALCULADO	Calculado
REFERENCIA	Referência

TipoRegimePrevidenciario

Valor	Descrição
REGIME_PROPRIO	Regime prório
CLT	CLT
OUTROS	Outros

UnidadeCalculo

Valor	Descrição
DIAS	Dias
HORAS	Horas

TipoDespesaPlanoSaude

Valor	Descrição
MENSALIDADE	Mensalidade
ADESAO	Adesão
PROCEDIMENTOS	Procedimentos

AplicacaoDesconto

Valor	Descrição
PERCENTUAL	Percentual
VALOR	Valor

ClassificacaoTipoAfastamento

Valor	Descrição
ABORTO_NAO_CRIMINOSO	Aborto não criminoso
ACIDENTE_DE_TRABALHO_EMPREGADOR	Acidente de trabalho empregador
ACIDENTE_DE_TRABALHO_PREVIDENCIA	Acidente de trabalho previdência
ACIDENTE_DE_TRAJETO_EMPREGADOR	Acidente de trajeto empregador
ACIDENTE_DE_TRAJETO_PREVIDENCIA	Acidente de trajeto previdência
DOENCA_DO_TRABALHO_EMPREGADOR	Doença do trabalho empregador
DOENCA_DO_TRABALHO_PREVIDENCIA	Doença do trabalho previdência
AUXILIO_DOENCA_EMPREGADOR	Auxílio doença empregador
AUXILIO_DOENCA_PREVIDENCIA	Auxílio doença previdência
ACOMPANHAR_MEMBRO_DA_FAMILIA_ENFERMO	Acompanhar membro da família enfermo
ADOCAO_GUARDA_JUDICIAL_DE_CRIANCA	Adoção/guarda judicial de criança
APOSENTADORIA_POR_INVALIDEZ	Aposentadoria por invalidez
CANDIDATO_A_CARGO_ELETIVO	Candidato a cargo eletivo
CARCERE	Cárcere
CEDENCIA	Cedência
FALTA	Falta
FERIAS	Férias
LICENCA_COM_VENCIMENTOS	Licença COM vencimentos
LICENCA_SEM_VENCIMENTOS	Licença SEM vencimentos
LICENCA_MATERNIDADE	Licença maternidade
MANDATO_ELEITORAL_COM_REMUNERACAO	Mandato eleitoral COM remuneração
MANDATO_ELEITORAL_SEM_REMUNERACAO	Mandato eleitoral SEM remuneração
MANDATO_SINDICAL	Mandato sindical
MULHER_VITIMA_DE_VIOLENCIA_LEI_MARIA_DA_PENHA	Mulher vítima de violência (Lei Maria da Penha)
PRORROGACAO_DA_LICENCA_MATERNIDADE	Prorrogação da licença maternidade
SERVICO_MILITAR	Serviço militar
SERVIDOR_PUBLICO_EM_DISPONIBILIDADE	Servidor público em disponibilidade
SUSPENSAO_DISCIPLINAR_ART474_CLT	Suspensão disciplinar Art.474 CLT
SUSPENSAO_DO_CONTRATO_ART476_CLT	Suspensão do contrato Art.476 CLT
APOSENTADO	Aposentado
DEMITIDO	Demitido
AUSENCIA_LEGAL	Ausência Legal
PRORROGACAO_DA_LICENCA_MATERNIDADE_11_770	Prorrogação da licença maternidade lei 11.770

SituacaoPeriodoAquisitivo

Valor	Descrição
EM_ANDAMENTO	Em andamento
QUITADO	Quitado
CANCELADO	Cancelado
ADQUIRIDO	Adquirido
ANULADO	Anulado

SituacaoPeriodoAquisitivoDecimoTerceiro

Valor	Descrição
ATRASADO	Atrasado
EM_ANDAMENTO	Em andamento
PERDA_DIREITO	Perda do direito
QUITADO	Quitado
QUITADO_PARCIALMENTE	Quitado parcialmente (quando há adiantamento ou reintegração da matrícula)
ANULADO	Anulado

OcorrenciaSefip

Valor	Descrição
NUNCA_EXPOSTO_AGENTES_NOCIVOS	Nunca teve exposto a agentes nocivos
EXPOSTO_ALGUMA_VEZ	Trabalhador já teve exposto alguma vez
EXPOSTO_APOSENTADORIA_15_ANOS	Exposto a agentes nocivos - aposentadoria 15 anos
EXPOSTO_APOSENTADORIA_20_ANOS	Exposto a agentes nocivos - aposentadoria 20 anos
EXPOSTO_APOSENTADORIA_25_ANOS	Exposto a agentes nocivos - aposentadoria 25 anos

TipoSalarioFamilia

Valor	Descrição
ESTATUTARIO	Estatutário
APOSENTADO	Aposentado
ESPECIAL	Especial
CELETISTA	Celetista

TipoRetornoValeTransporte

Valor	Descrição
QUANTIDADE	Quantidade
VALOR	Valor

ClassificacaoAdicional

Valor	Descrição
ANUENIO	Anuênio
BIENIO	Biênio
TRIENIO	Triênio
QUADRIENIO	Quadriênio
QUINQUENIO	Quinquênio

TipoAdicional

Valor	Descrição
QUANTIDADE_ADICIONAIS	Quantidade de adicionais
PERCENTUAL_TEMPO_SERVICO	Percentual de adicionais

AbonoFalta

Valor	Descrição
ABONO	Abono
FALTA	Falta

TipoAbono

Valor	Descrição
ABONADO	Abonado
NAO_ABONADO	Não abonado
ABONADO_E_NAO_ABONADO	Abonado e não abonado

TipoFalta

Valor	Descrição
JUSTIFICADA	Justificada
NAO_JUSTIFICADA	Não justificada
JUSTIFICADA_E_NAO_JUSTIFICADA	Justificada e não justificada

MotivoMovimentacaoPeriodoAquisitivoDecimoTerceiro

Valor	Descrição
ADIANTAMENTO_DECIMO_TERCEIRO	Adiantamento no 13º
ADIANTAMENTO_FERIAS	Adiantamento nas Férias
COMPLEMENTAR	Complementar
GRATIFICACAO_NATALINA	Gratificação natalna (13º integral)
RESCISAO	Rescisão
RESCISAO_COMPLEMENTAR	Rescisão complementar

Bases

Valor	Descrição
PAGAPROP	Paga Proporcional
SALBASE	Salário Base
HORAEXTRA	Horas Extras
PERIC	Periculosidade
SIND	Sindicato
FGTS	F.G.T.S.
FGTS13	F.G.T.S. 13º Salário
IRRF	I.R.R.F.
IRRF13	I.R.R.F. 13º Salário
IRRFFERRESC	I.R.R.F. Férias Rescisão
INSS	I.N.S.S.
INSS13	I.N.S.S. 13º Salário
PREVEST	Prev. Estadual
PREVEST13	Prev. Estadual 13º Salário
FUNDASS	Fundo Assistência
FUNDASS13	Fundo Assistência 13º Salário
FUNDOPREV	Fundo Previdência
FUNDPREV13	Fundo Previdência 13º Salário
OUTRASBASES	Outras Bases
FGTSAVISO	F.G.T.S. Aviso Prévio
ABATIRRF	Abatimento I.R.R.F.
ABATIRRF13	Abatimento I.R.R.F. 13º Sal.
DESCIRRF	Desconto I.R.R.F.
DESCIRRF13	Desconto I.R.R.F. 13º Salário
DESCIRRFERES	Desconto I.R.R.F. Férias Resc.
EXCEINSS	Excedente I.N.S.S.
EXCEINSS13	Excedente I.N.S.S. 13º Salário
ABATINSS	Abatimento I.N.S.S.
DESCTERFER	Desconto 1/3 De Férias
SALAFAM	Salário Família Normal
INSSOUTRA	I.N.S.S. Outras Empresas
INSSOUTRA13	I.N.S.S. Outras Emp. 13º Sal
IRRFOUTRA	I.R.R.F. Outras Empresas
IRRFOUTRA13	I.R.R.F. Outras Emp. 13º Sal
IRRFFER	I.R.R.F. Férias
CONTSIND	Contrib. Sindical Anual
MEDIAUXMAT	Média Auxílio Maternidade
DESC13REINT	Desc. 13º Salário Reintegração
COMPHORAMES	Compõem Horas
TERFERVENRES	1/3 Férias Vencidas Resc.
FUNDFIN	Fundo Financeiro
FUNDFIN13	Fundo Financeiro 13º Salário
MEDAUXMATPR	Média Auxílio Maternidade Proporcional
IN13SADI	I.N.S.S. 13º Salário Distorção
FUPR13SAPR	Fundo Previdência 13º Salário Provisão
FUPR13SAAJPR	Fundo Previdência 13º Salário Ajuste Provisão
FUPR13SAESPR	Fundo Previdência 13º Salário Estorno Provisão
FUPR13SADI	Fundo Previdência 13º Salário Distorção
PRES13SAPR	Prev. Estadual 13º Salário Provisão
PRES13SAAJPR	Prev. Estadual 13º Salário Ajuste Provisão
PRES13SAESPR	Prev. Estadual 13º Salário Estorno Provisão
PRES13SADI	Prev. Estadual 13º Salário Distorção
FUAS13SAPR	Fundo Assistência 13º Salário Provisão
FUAS13SAAJPR	Fundo Assistência 13º Salário Ajuste Provisão
FUAS13SAESPR	Fundo Assistência 13º Salário Estorno Provisão
FUAS13SADI	Fundo Assistência 13º Salário Distorção
FG13SAPR	F.G.T.S. 13º Salário Provisão
FG13SAAJPR	F.G.T.S. 13º Salário Ajuste Provisão
FG13SAESPR	F.G.T.S. 13º Salário Estorno Provisão
INFEPR	I.N.S.S. Férias Provisão
INFEAJPR	I.N.S.S. Férias Ajuste Provisão
INFEESPR	I.N.S.S. Férias Estorno Provisão
INFEDI	I.N.S.S. Férias Distorção
FUPRFEPR	Fundo Previdência Férias Provisão
FUPRFEAJPR	Fundo Previdência Férias Ajuste Provisão
FUPRFEESPR	Fundo Previdência Férias Estorno Provisão
FUPRFEDI	Fundo Previdência Férias Distorção
PRESFEPR	Prev. Estadual Férias Provisão
PRESFEAJPR	Prev. Estadual Férias Ajuste Provisão
PRESFEESPR	Prev. Estadual Férias Estorno Provisão
PRESFEDI	Prev. Estadual Férias Distorção
FUASFEPR	Fundo Assistência Férias Provisão
FUASFEAJPR	Fundo Assistência Férias Ajuste Provisão
FUASFEESPR	Fundo Assistência Férias Estorno Provisão
FUASFEDI	Fundo Assistência Férias Distorção
FGFEPR	F.G.T.S. Férias Provisão
FGFEAJPR	F.G.T.S. Férias Ajuste Provisão
FGFEESPR	F.G.T.S. Férias Estorno Provisão
13DEFEPR	1/3 De Férias Provisão
13DEFEAJPR	1/3 De Férias Ajuste Provisão
PRBAAUMEHOFE	Provisão - Base Auxiliar Média Horas Férias
PRBAAUMEHO13	Provisão - Base Auxiliar Média Horas 13º Salário
PRBAAUDI13SA	Provisão - Base Auxiliar Distorções 13º Salário
PRBAAUDIFE	Provisão - Base Auxiliar Distorções Férias
DEVIRRF	Devolução I.R.R.F.
DEVINSS	Devolução I.N.S.S.
PARCISENIRRF	Parcela Isenta I.R.R.F.
PAISIR13SA	Parcela Isenta I.R.R.F. 13º Salário
INSSFER	I.N.S.S. DE FÉRIAS

TipoSegurado

Valor	Descrição
AMBOS	Ambos tipos dos segurados
TITULAR	Apenas tipo de segurado Titular
DEPENDENTE	Apenas tipo de segurado Dependentes

TipoReembolso

Valor	Descrição
REEMBOLSO_PLANO_SAUDE	Reembolso efetuado pelo empregador/plano de saúde
REEMBOLSO_EMPREGADOR	Reembolso efetuado pelo próprio empregador
AMBOS	Ambos os tipos de reembolso

Competencia

Valor	Descrição
COMPETENCIA	Competência referente aos reembolsos de plano de saúde

TipoValorReembolso

Valor	Descrição
AMBOS	Ambos tipos de reembolso
ANO_CORRENTE	Ano corrente
ANOS_ANTERIORES	Ano anterior

Manual da GFIP/SEFIP para usuários do SEFIP 8.4

Download do Manual!

Mantenha seu pacote de eventos para migração atualizado​

Fórmulas e Funções​

Funções reservadas​

AdicionaisTempoServico​

Afastamentos​

AvisoPrevio​

Bases​

BasesOutrasEmpresas​

Diarias​

Eventos​

EncargosSociais​

Encargos Sociais:​

Empréstimos​

FuncoesGratificadas​

Lançamentos​

PlanoSaudeDespesas​

PeriodosAquisitivos​

Periodos Aquisitivos Decimo Terceiro​

Periodos Aquisitivos Férias​

Reembolso PlanoSaude​

*buscaValor(TipoSegurado, TipoReembolso, TipoValorReembolso).​

*buscaValor(Competencia, TipoSegurado, TipoReembolso, TipoValorReembolso)​

Vales Transporte​

Variáveis reservadas​

Aposentado​

Calculo​

Estagiário​

Evento​

Folha​

Folhas​

FolhasPeriodo​

FolhasMultiplosVinculosPeriodo​

Funcionário​

Média Vantagem​

Matrícula​

Período Aquisitivo​

Período Concessão​

Pensionista​

Busca por Cessação​

Busca por Suspensão​

Período Aquisitivo Décimo Terceiro​

Servidor​

Valor Calculado​

Valor Referência​

Funções para fórmulas (mantidas pelo desenvolvimento)​

Acumula​

Acumula Classificação​

Afasaborto​

Afasacidtrab​

Afasacidtrabemp​

Afasadocao​

Afasauxdoenc​

Afasauxdoencemp​

Afascandcargoeletivocel​

Afasdirinteg​

Afasexeroutroorgaoservidorouempregadopubcedido​

Afaslicmat​

Afasliccvenclibempact​

Afaslicsvenc​

Afasmandeletivocargocomissao​

Afaspartconscnpslei82131991​

Afasprorroglicmat()​

Afasprorroglicmatlei11770()​

AfasReintegracaoComPerdaDireito()​

AfasReintegracaoSemPerdaDireito()​

Afasrepresentantesindical()​

Afasservmil()​

Afassuspcontart17mp11162022()​

Afassuspcontart19mp11162022()​

Afassuspcontlei140202020coronavirus()​

Afassusppagtoservpubnaorecadastramento()​

Afastrabavulsoimpedconcorrenciaescala()​

Afastrabavulsoinatividadetrabmaior90dias()​

Avos13()​

BuscaAbonos()​

BuscaBaseDeOutrosProcessamentos()​

buscaFaltas()​

BuscaMes()​

BuscaQuantidadeDependentesPensao()​

BuscaValorDeOutrosProcessamentos()​

Mantenha seu pacote de eventos para migração atualizado

Fórmulas e Funções

Funções reservadas

AdicionaisTempoServico

Afastamentos

AvisoPrevio

Bases

BasesOutrasEmpresas

Diarias

Eventos

EncargosSociais

Encargos Sociais:

Empréstimos

FuncoesGratificadas

Lançamentos

PlanoSaudeDespesas

PeriodosAquisitivos

Periodos Aquisitivos Decimo Terceiro

Periodos Aquisitivos Férias

Reembolso PlanoSaude

*buscaValor(TipoSegurado, TipoReembolso, TipoValorReembolso).

*buscaValor(Competencia, TipoSegurado, TipoReembolso, TipoValorReembolso)

Vales Transporte

Variáveis reservadas

Aposentado

Calculo

Estagiário

Evento

Folha

Folhas

FolhasPeriodo

FolhasMultiplosVinculosPeriodo

Funcionário

Média Vantagem

Matrícula

Período Aquisitivo

Período Concessão

Pensionista

Busca por Cessação

Busca por Suspensão

Período Aquisitivo Décimo Terceiro

Servidor

Valor Calculado

Valor Referência

Funções para fórmulas (mantidas pelo desenvolvimento)

Acumula

Acumula Classificação

Afasaborto

Afasacidtrab

Afasacidtrabemp

Afasadocao

Afasauxdoenc

Afasauxdoencemp

Afascandcargoeletivocel

Afasdirinteg

Afasexeroutroorgaoservidorouempregadopubcedido

Afaslicmat

Afasliccvenclibempact

Afaslicsvenc

Afasmandeletivocargocomissao

Afaspartconscnpslei82131991

Afasprorroglicmat()

Afasprorroglicmatlei11770()

AfasReintegracaoComPerdaDireito()

AfasReintegracaoSemPerdaDireito()

Afasrepresentantesindical()

Afasservmil()

Afassuspcontart17mp11162022()

Afassuspcontart19mp11162022()

Afassuspcontlei140202020coronavirus()

Afassusppagtoservpubnaorecadastramento()

Afastrabavulsoimpedconcorrenciaescala()

Afastrabavulsoinatividadetrabmaior90dias()

Avos13()

BuscaAbonos()

BuscaBaseDeOutrosProcessamentos()

buscaFaltas()

BuscaMes()

BuscaQuantidadeDependentesPensao()

BuscaValorDeOutrosProcessamentos()