FPAPI037 - Realiza a solicitação de benefícios e impressão do protocolo de entrega.

Documento de API

Produto:	Datasul
Ocorrência:	Documentação de API
Nome Físico	prghur/fpp/fpapi037.p

Objetivo

Realiza a solicitação de benefícios e impressão do protocolo de entrega.

Funcionamento

A API fpapi037 deve ser executada de forma persistente.

Sintaxe para executar a API em modo persistente:

run prghur/fpp/fpapi037.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.

Tabelas Temporárias

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

Tabela Temporária	Descrição	Entrada/Saída
tt-employeeActualBenefits	Contém informações dos benefícios atuais dos colaboradores.	Saída

Atributo	Tipo	Formato	Descrição	Obrigatório	Evolução
companyCode	Inteiro	Zz9	Código da empresa	Sim	2.10
siteCode	Inteiro	Zz9	Código do estabelecimento	Sim	2.10
registry	Inteiro	Zzzzzzz9	Código de matrícula do funcionário	Sim	2.10
benefitCode	Inteiro	>>9	Código do benefício	Sim	2.10
benefitDescription	Caracter	x(30)	Descrição do benefício	Sim	2.10
benefitType	Inteiro	9	Tipo de distribuição do benefício	Sim	2.10
idi_tip_benefic	Inteiro	9	Tipo de benefício	Sim	2.10
val_calcul_efp	Decimal	-zzz,zzz,zz9.99	Valor dos benefícios	Não	2.10
qtd_unid_acordo_efp	Decimal	>>>>9.999	Quantidade dos benefícios	Não	2.10
cdn_lin_vale_transp	Inteiro		Código da linha de transporte	Não	2.10

Tabela Temporária	Descrição	Entrada/Saída
tt-dependentActualBenefits	Contém informações dos benefícios atuais dos dependentes dos colaboradores.	Saída

Atributo	Tipo	Formato	Descrição	Obrigatório	Evolução
companyCode	Inteiro	Zz9	Código da empresa	Sim	2.10
siteCode	Inteiro	Zz9	Código do estabelecimento	Sim	2.10
registry	Inteiro	Zzzzzzz9	Código de matrícula do funcionário	Sim	2.10
dependentCode	Inteiro	zz9	Código do dependente	Sim	2.10
benefitCode	Inteiro	>>9	Código do benefício	Sim	2.10
benefitDescription	Caracter	x(30)	Descrição do benefício	Sim	2.10
benefitType	Inteiro	9	Tipo de distribuição do benefício	Sim	2.10
idi_tip_benefic	Inteiro	9	Tipo de benefício	Sim	2.10
val_calcul_efp	Decimal	-zzz,zzz,zz9.99	Valor dos benefícios	Não	2.10
qtd_unid_acordo_efp	Decimal	>>>>9.999	Quantidade dos benefícios	Não	2.10
cdn_lin_vale_transp	Inteiro		Código da linha de transporte	Não	2.10

Tabela Temporária	Descrição	Entrada/Saída
tt-employeeAvaliableBenefits	Contém informações dos benefícios disponíveis para solicitação dos colaboradores.	Saída

Atributo	Tipo	Formato	Descrição	Obrigatório	Evolução
companyCode	Inteiro	Zz9	Código da empresa	Sim	2.10
siteCode	Inteiro	Zz9	Código do estabelecimento	Sim	2.10
registry	Inteiro	Zzzzzzz9	Código de matrícula do funcionário	Sim	2.10
benefitCode	Inteiro	>>9	Código do benefício	Sim	2.10
benefitDescription	Caracter	x(30)	Descrição do benefício	Sim	2.10
benefitType	Inteiro	9	Tipo de distribuição do benefício	Sim	2.10
idi_tip_benefic	Inteiro	9	Tipo de benefício	Sim	2.10
val_calcul_efp	Decimal	-zzz,zzz,zz9.99	Valor dos benefícios	Não	2.10
qtd_unid_acordo_efp	Decimal	>>>>9.999	Quantidade dos benefícios	Não	2.10
cdn_lin_vale_transp	Inteiro		Código da linha de transporte	Não	2.10

Tabela Temporária	Descrição	Entrada/Saída
tt-dependentAvaliableBenefits	Contém informações dos benefícios disponíveis para solicitação dos dependentes dos colaboradores.	Saída

Atributo	Tipo	Formato	Descrição	Obrigatório	Evolução
companyCode	Inteiro	Zz9	Código da empresa	Sim	2.10
siteCode	Inteiro	Zz9	Código do estabelecimento	Sim	2.10
registry	Inteiro	Zzzzzzz9	Código de matrícula do funcionário	Sim	2.10
dependentCode	Inteiro	zz9	Código do dependente	Sim	2.10
benefitCode	Inteiro	>>9	Código do benefício	Sim	2.10
benefitDescription	Caracter	x(30)	Descrição do benefício	Sim	2.10
benefitType	Inteiro	9	Tipo de distribuição do benefício	Sim	2.10
idi_tip_benefic	Inteiro	9	Tipo de benefício	Sim	2.10
val_calcul_efp	Decimal	-zzz,zzz,zz9.99	Valor dos benefícios	Não	2.10
qtd_unid_acordo_efp	Decimal	>>>>9.999	Quantidade dos benefícios	Não	2.10
cdn_lin_vale_transp	Inteiro		Código da linha de transporte	Não	2.10

Tabela Temporária	Descrição	Entrada/Saída
tt-histor_benefic	Histórico dos benefícios	Saída

Atributo	Tipo	Formato	Descrição	Obrigatório	Evolução
cdn_empresa	Inteiro	Zz9	Código da empresa	Sim	2.10
cdn_estab	Inteiro	Zz9	Código do estabelecimento	Sim	2.10
cdn_funcionario	Inteiro	Zzzzzzz9	Código de matrícula do funcionário	Sim	2.10
cdn_beneficio	Inteiro	>>9	Código do benefício	Sim	2.10
cdn_depend_func	Inteiro	zz9	Código do dependente	Sim	2.10
qtd_unid_acordo_efp	Decimal	>>>>9.999	Quantidade dos benefícios	Não	2.10
val_calcul_efp	Decimal	-zzz,zzz,zz9.99	Valor do benefício	Não	2.10
num_ano_refer_fp	Inteiro	9999	Ano de referência	Não	2.10
num_mes_lote_movto_benefic	Inteiro	99	Mês de referência	Não	2.10

Tabela Temporária	Descrição	Entrada/Saída
tt-lin_vale_transp	Contém informações das linhas de transporte.	Saída

Atributo	Tipo	Formato	Descrição	Obrigatório	Evolução
cdn_empresa	Inteiro	Zz9	Código da empresa	Sim	2.10
cdn_lin_vale_transp	Inteiro	>>>>9	Código da Linha	Sim	2.10
cod_lin_transp	Caracter	x(5)	Código da Linha caracter	Sim	2.10
des_lin_transp	Caracter	x(30)	Descrição da linha	Sim	2.10
nom_munpio_orig_lin_transp	Caracter	x(20)	Origem	Sim	2.10
val_tarifa_transp	Decimal	>>,>>>,>>9.99	Valor Tarifa	Sim	2.10

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

Atributo	Tipo	Formato	Descrição	Obrigatório	Evolução
Code	Inteiro	Zz9	Código do erro	Sim	2.10
Description	Caracter	X(60)	Descrição do erro	Sim	2.10

Tabela Temporária	Descrição	Entrada/Saída
tt_benefit	Benefícios	Saída

Atributo	Tipo	Formato	Descrição	Obrigatório	Evolução
company	Inteiro	zz9	Empresa	Sim	2.10
site	Inteiro	zz9	Estabelecimento	Sim	2.10
Employee	Inteiro	zzzzzzz9	Matrícula	Sim	2.10
Code	Inteiro	>>9	Código do benefício	Sim	2.10
Description	Caracter	x(30)	Descrição do benefício	Sim	2.10
Prestador	Caracter	x(15)	Nome do prestador de serviço	Sim	2.10
Numberofdependents	Inteiro	zz9	Quantidade de dependentes	Sim	2.10
Quantity	Decimal	>>>>9.999	Quantidade do benefício	Sim	2.10
num_value	Decimal	-zzz,zzz,zz9.99	Valor do benefício	Sim	2.10

Tabela Temporária	Descrição	Entrada/Saída
tt_benefit2	Benefícios Auxiliares	Saída

Atributo	Tipo	Formato	Descrição	Obrigatório	Evolução
Code	Inteiro	>>9	Código do benefício	Sim	2.10
Description	Caracter	x(30)	Descrição do benefício	Sim	2.10
Type	Inteiro	9	Tipo Benefício	Sim	2.10

Tabela Temporária	Descrição	Entrada/Saída
tt-linha-funcionario	Linhas de transporte dos funcionários	Saída

Atributo	Tipo	Formato	Descrição	Obrigatório	Evolução
cdn_empresa	Inteiro	Zz9	Código da empresa	Sim	2.10
cdn_estab	Inteiro	zz9	Estabelecimento	Sim	2.10
cdn_funcionario	Inteiro	zzzzzzz9	Matrícula	Sim	2.10
cdn_beneficio	Inteiro	>>9	Código do benefício	Sim	2.10
cdn_lin_vale_transp	Inteiro	>>>>9	Código da Linha	Sim	2.10

Métodos

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

Método Básico

procedure pi-tt-lin_vale_transp

Requisito	Inexistente.
Sintaxe	run procedure pi-tt-lin_vale_transp in h-handle (output table tt-lin_vale_transp).
Descrição	O método retornará a simulação do cálculo de férias de um colaborador.
	Parâmetros	Descrição
	tt-lin_vale_transp	Linhas de transporte da empresa.
Retorno	Temp-table tt-lin_vale_transp populada.

procedure pi-listEmployeeActualBenefits

Requisito			Inexistente.
Sintaxe			run procedure pi-listEmployeeActualBenefits in h-handle (input p_cdn_empresa, input p_cdn_estab, input p_cdn_funcionario, output table tt-employeeActualBenefits, output table tt-linha-funcionario, output table tt-erro).
Descrição			O método retornará uma lista dos benefícios atuais dos colaboradores.
			Parâmetros	Descrição
	p_cdn_empresa p_cdn_estab p_cdn_funcionario tt-employeeActualBenefits tt-linha-funcionario tt-erro			Empresa Estabelecimento Matrícula Temp-table com os benefícios atuais dos colaboradores Temp-table com as linhas de transportes dos colaboradores Erros do processo.
Retorno		Temp-table tt-erro, tt-employeeActualBenefits, tt-linha-funcionario populadas.

procedure pi-listDependentsActualBenefits

Requisito			Inexistente.
Sintaxe			run procedure pi-listDependentsActualBenefits in h-handle (input p_cdn_empresa, input p_cdn_estab, input p_cdn_funcionario, output table tt-dependentActualBenefits, output table tt-erro).
Descrição			O método retornará uma lista dos benefícios atuais dos dependentes dos colaboradores.
			Parâmetros	Descrição
	p_cdn_empresa p_cdn_estab p_cdn_funcionario tt-dependentActualBenefits tt-erro			Código da empresa do colaborador Código do estabelecimento do colaborador Código de matrícula do colaborador Temp-table com os benefícios atuais dos dependentes dos colaboradores Erros do processo
Retorno		Temp-tables tt-dependentActualBenefits e tt-erro populadas.

procedure pi-listEmployeeAvaliableBenefits

Requisito			Inexistente.
Sintaxe			run procedure pi-listEmployeeAvaliableBenefits in h-handle (input p_cdn_empresa, input p_cdn_estab, input p_cdn_funcionario, output table tt-employeeAvaliableBenefits, output table for tt-erro).
Descrição			O método retornará os benefícios disponíveis para os colaboradores.
			Parâmetros	Descrição
	p_cdn_empresa p_cdn_estab p_cdn_funcionario tt-employeeAvaliableBenefits tt-erro			Código da empresa do colaborador. Código do estabelecimento do colaborador. Código de matrícula do colaborador. Temp-table com os benefícios disponíveis para os colaboradores Erros do processo.
Retorno		Temp-tables tt-employeeAvaliableBenefits e tt-erro populadas.

procedure pi-listDependentsAvaliableBenefits

Requisito			Inexistente.
Sintaxe			run procedure pi-listDependentsAvaliableBenefits in h-handle (input p_cdn_empresa, input p_cdn_estab, input p_cdn_funcionario, output table tt-dependentAvaliableBenefits, output table for tt-erro).
Descrição			O método retornará os benefícios disponíveis para os colaboradores.
			Parâmetros	Descrição
	p_cdn_empresa p_cdn_estab p_cdn_funcionario tt-dependentAvaliableBenefits tt-erro			Código da empresa do colaborador. Código do estabelecimento do colaborador. Código de matrícula do colaborador. Temp-table com os benefícios disponíveis para dependentes dos colaboradores Erros do processo.
Retorno		Temp-tables tt-dependentAvaliableBenefits e tt-erro populadas.

procedure pi_print_benefic

Requisito			Inexistente.
Sintaxe			run procedure pi_print_benefic in h-handle (input p_cdn_empresa, input p_cdn_estab, input p_cdn_funcionario, input p_cdn_beneficio, input p_num_ano_refer, input p_num_mes_refer, output table tt_benefit, output table tt-erro).
Descrição			O método retornará os dados para impressão do protocolo de entrega dos benefícios.
			Parâmetros	Descrição
	p_cdn_empresa p_cdn_estab p_cdn_funcionario p_cdn_beneficio p_num_ano_refer p_num_mes_refer tt_benefit tt-erro			Código da empresa do colaborador. Código do estabelecimento do colaborador. Código de matrícula do colaborador. Código do benefício Ano de referência Mês de referência Temp-table com os dados do protocolo Erros do processo.
Retorno		Temp-tables tt_benefit e tt-erro populadas.

Método Negócio

Não há método de negócio disponível nesta api.

Árvore de páginas