FPAPI053 - Retornar o histórico de adicionais e provisões dos colaboradores.

Documento de API

Objetivo

Retornar o histórico de adicionais e provisões dos colaboradores.

A API fpapi053 deve ser executada de forma persistente.

Sintaxe para executar a API em modo persistente:

run prghur/fpp/fpapi053.p persistent set h-handle.

A variável denominada h-handle irá receber o “handle” do programa, permitindo o acesso aos “métodos” internos da API.

Nos atributos das tabelas temporárias de entrada e saída:

Tabela Temporária	Descrição	Entrada/Saída
tt-adc_ferias	Contém os adicionais de férias	Saída

Tabela Temporária	Descrição	Entrada/Saída
tt-adc_13	Contém os adicionais de décimo terceiro	Saída

Tabela Temporária	Descrição	Entrada/Saída
tt-prov_ferias	Contém as provisões de férias	Saída

Atributo	Tipo	Formato	Descrição	Obrigatório	Evolução
cdn_empresa	Inteiro	zz9	Empresa	Sim	2.10
cdn_estab	Inteiro	zz9	Estabelecimento	Sim	2.10
cdn_funcionario	Inteiro	zzzzzzz9	Matrícula	Sim	2.10
qtd_dias_provis_ferias_provndo	Decimal	zz9.99	Dias Provisão Férias	Não	2.10
horas	Decimal	z,zz9.999	Horas	Não	2.10
valor	Decimal	zzz,zzz,zz9.99	Valor	Não	2.10
vlrcr	Decimal	zzz,zzz,zz9.99	Valor Corrigido	Não	2.10
val_provis_ferias_period_aber	Decimal	zzz,zzz,zz9.99	Provisão Acumulada Férias	Não	2.10
val_provis_acum_13o_ferias	Decimal	zzz,zzz,zz9.99	Provisão Acumulada 13	Não	2.10
val_provis_ferias_dobro	Decimal	zzz,zzz,zz9.99	Provisão Férias em Dobro	Não	2.10
val_provis_acum_inss_ferias	Decimal	zzz,zzz,zz9.99	Provisão Acumulada INSS	Não	2.10
val_provis_acum_fgts_ferias	Decimal	zzz,zzz,zz9.99	Provisão Acumulada FGTS	Não	2.10
val_provis_acum_pis_ferias	Decimal	zzz,zzz,zz9.99	Provisão Acumulada PIS	Não	2.10
valor_tot	Decimal	zzz,zzz,zz9.99	Valor Total	Não	2.10

Tabela Temporária	Descrição	Entrada/Saída
tt-prov_13	Contém as provisões de décimo terceiro	Saída

Atributo	Tipo	Formato	Descrição	Obrigatório	Evolução
cdn_empresa	Inteiro	zz9	Empresa	Sim	2.10
cdn_estab	Inteiro	zz9	Estabelecimento	Sim	2.10
cdn_funcionario	Inteiro	zzzzzzz9	Matrícula	Sim	2.10
qti_avos_13o_salario	Inteiro	Z9	Avos 13º Salário	Sim	2.10
horas	Decimal	z,zz9.999	Horas	Não	2.10
valor	Decimal	zzz,zzz,zz9.99	Valor	Não	2.10
vlrcr	Decimal	zzz,zzz,zz9.99	Valor Corrigido	Não	2.10
val_provis_13o_afast	Decimal	zzz,zzz,zz9.99	Provisão Acumulada Afastamento	Não	2.10
val_provis_acum_13o	Decimal	zzz,zzz,zz9.99	Provisão Acumulada 13	Não	2.10
val_provis_acum_inss_13o	Decimal	zzz,zzz,zz9.99	Provisão Acumulada INSS	Não	2.10
val_provis_acum_fgts_13o	Decimal	zzz,zzz,zz9.99	Provisão Acumulada FGTS	Não	2.10
val_provis_acum_pis_13o	Decimal	zzz,zzz,zz9.99	Provisão Acumulada PIS	Não	2.10
valor_tot	Decimal	zzz,zzz,zz9.99	Valor Total	Não	2.10
qti_avos_fgts_13º	Inteiro	Z9	Avos FGTS 13 Afastamento	Não	2.10
media_dias_prov	Caracter	x(100)	Média dias provisão	Não	2.10

Tabela Temporária	Descrição	Entrada/Saída
tt-erro	Contém código e descrição do erro	Saída

Quando a API/BO for executada em modo persistente, os seguintes métodos estarão disponíveis para execução:

Método Básico

Requisito	Inexistente.
Sintaxe	run procedure pi-adc_ferias in h-handle (input p_cdn_empresa, input p_cdn_estab, input p_cdn_funcionario, input p_ano_refer, output table tt-adc_ferias, output table tt-erro).
Descrição	O método retornará os adicionais de férias.
	Parâmetros	Descrição
	p_cdn_empresa p_cdn_estab p_cdn_funcionario p_ano_refer tt-adc_ferias tt-erro	Empresa Estabelecimento Matrícula Ano Temp-table com os adicionais de férias Erros do processo.
Retorno	Temp-tables tt-adc_ferias e tt-erro populadas. As mensagens possíveis para este método são: "Não existe adicional de férias para esse funcionário!"

Requisito	Inexistente.
Sintaxe	run procedure pi-adc_13 in h-handle (input p_cdn_empresa, input p_cdn_estab, input p_cdn_funcionario, input p_ano_refer, output table tt-adc_13, output table tt-erro).
Descrição	O método retornará os adicionais de décimo terceiro.
	Parâmetros	Descrição
	p_cdn_empresa p_cdn_estab p_cdn_funcionario p_ano_refer tt-adc_ferias tt-erro	Empresa Estabelecimento Matrícula Ano Temp-table com os adicionais de décimo terceiro Erros do processo.
Retorno	Temp-tables tt-adc_13 e tt-erro populadas. As mensagens possíveis para este método são: "Não existe adicional de 13o salário para esse funcionário!"

Requisito	Inexistente.
Sintaxe	run procedure pi-prov_ferias in h-handle (input p_cdn_empresa, input p_cdn_estab, input p_cdn_funcionario, output table tt-prov_ferias, output table tt-erro).
Descrição	O método retornará os adicionais de décimo terceiro.
	Parâmetros	Descrição
	p_cdn_empresa p_cdn_estab p_cdn_funcionario tt-prov_ferias tt-erro	Empresa Estabelecimento Matrícula Temp-table com as provisões de férias Erros do processo.
Retorno	Temp-tables tt-prov_ferias e tt-erro populadas. As mensagens possíveis para este método são: "Não existe provisionamento de férias para esse funcionário!"

Requisito	Inexistente.
Sintaxe	run procedure pi-prov_13 in h-handle (input p_cdn_empresa, input p_cdn_estab, input p_cdn_funcionario, output table tt-prov_13, output table tt-erro).
Descrição	O método retornará os adicionais de décimo terceiro.
	Parâmetros	Descrição
	p_cdn_empresa p_cdn_estab p_cdn_funcionario tt-prov_13 tt-erro	Empresa Estabelecimento Matrícula Temp-table com as provisões de décimo terceiro Erros do processo.
Retorno	Temp-tables tt-prov_13 e tt-erro populadas. As mensagens possíveis para este método são: "Não existe provisionamento de 13o salário para esse funcionário!"

Método Negócio