FPAPI040 - Retorna temp-table com os registros dos movimentos calculados.

Documento de API

Objetivo

Retorna temp-table com os registros dos movimentos calculados.

A API fpapi040 deve ser executada de forma persistente.

Sintaxe para executar a API em modo persistente:

run prghur/fpp/fpapi040.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-movto-calcul-func	Contém os registros dos movimentos calculados 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
paymentType	Inteiro	99	Tipo Folha	Sim	2.10
paymentSequence	Inteiro	9	Número Parcela	Sim	2.10
eventCode	Caracter	x(03)	Código do evento	Sim	2.10
eventDescription	Caracter	x(30)	Descrição do evento	Sim	2.10
amountReference	Decimal	zzzzz9.999	Quantidade	Sim	2.10
eventValue	Decimal	-zzz,zzz,zz9.99	Valor	Sim	2.10
BaseValue	Decimal	zzz,zzz,zz9.99	Base informada	Sim	2.10
Identification	Inteiro	99	Identificação	Sim	2.10
movementType	Inteiro	99	Unidade	Sim	2.10

Tabela Temporária	Descrição	Entrada/Saída
tt-ultima-habilit-calc	Contém informações da última habilitação de cálculo disponível para consulta.	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
ano_refer	Inteiro	9999	Ano Folha	Sim	2.10
mes_refer	Inteiro	99	Mês Folha	Sim	2.10
qti_parc_habilit_calc_fp	Inteiro	9	Número Parcela	Sim	2.10
idi_tip_fp	Inteiro	99	Tipo Folha	Sim	2.10

Tabela Temporária	Descrição	Entrada/Saída
tt-movimentosCalculados	Contém os registros dos movimentos calculados 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
paymentType	Inteiro	99	Tipo Folha	Sim	2.10
paymentSequence	Inteiro	9	Número Parcela	Sim	2.10
eventCode	Caracter	x(03)	Código do evento	Sim	2.10
eventDescription	Caracter	x(30)	Descrição do evento	Sim	2.10
amountReference	Decimal	zzzzz9.999	Quantidade	Sim	2.10
eventValue	Decimal	-zzz,zzz,zz9.99	Valor	Sim	2.10
BaseValue	Decimal	zzz,zzz,zz9.99	Base informada	Sim	2.10
Identification	Inteiro	99	Identificação	Sim	2.10
movementType	Inteiro	99	Unidade	Sim	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-loadPaymentByEmployee in h-handle (input p_cdn_empresa, input p_cdn_estab, input p_cdn_funcionario, input p_idi_tip_fp, input p_qti_parc, input p_num_mes_refer_fp, input p_num_ano_refer_fp, output table tt-movto-calcul-func, output table tt-erro).
Descrição	O método retornará os movimentos calculados de um colaborador.
	Parâmetros	Descrição
	p_cdn_empresa p_cdn_estab p_cdn_funcionario p_idi_tip_fp p_qti_parc p_num_mes_refer_fp p_num_ano_refer_fp tt-movto-calcul-func tt-erro	Empresa Estabelecimento Matrícula Tipo Folha Parcela Mês referência Ano referência Temp-table com os movimentos calculados Erros do processo.
Retorno	Temp-table tt-movto-calcul-func e tt-erro populadas. As mensagens possíveis para este método são: "Não existe cálculo para estes parâmetros!"

Requisito			Inexistente.
Sintaxe			run procedure pi-ultimaHabilitacaoCalculo in h-handle (input p_cdn_empresa, input p_cdn_estab, input p_cdn_funcionario, output table tt-ultima-habilit-calc, output table tt-erro).
Descrição			O método retornará a última habilitação de cálculo disponível para consulta.
			Parâmetros	Descrição
	p_cdn_empresa p_cdn_estab p_cdn_funcionario tt-ultima-habilit-calc tt-erro			Empresa Estabelecimento Matrícula Temp-table com os dados da última habilitação de cálculo disponível Erros do processo.
Retorno		Temp-table tt-erro e tt-ultima-habilit-calc populadas. As mensagens possíveis para este método são: "Não existe cálculo para estes parâmetros!"

Requisito			Inexistente.
Sintaxe			run procedure pi-movimentoscalculados in h-handle (input p_cdn_empresa, input p_cdn_estab, input p_cdn_funcionario, input p_idi_tip_fp, input p_qti_parc, input p_ano, input p_mes, output table tt-movimentoscalculados, output table tt-erro).
Descrição			O método retornará os últimos movimentos calculados de um colaborador, disponíveis para consulta.
			Parâmetros	Descrição
	p_cdn_empresa p_cdn_estab p_cdn_funcionario p_idi_tip_fp p_qti_parc p_ano p_mes tt-movimentoscalculados tt-erro			Empresa Estabelecimento Matrícula Tipo Folha Parcela Ano referência Mês referência Temp-table com os movimentos calculados Erros do processo.
Retorno		Temp-tables tt-movimentoscalculados e tt-erro populadas. As mensagens possíveis para este método são: "Não existe cálculo para estes parâmetros!"

Método Negócio