FPAPI048 - Retornar os dependentes e beneficiários de determinado colaborador.

Documento de API

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

Objetivo

Retornar os dependentes e beneficiários de determinado colaborador.

Funcionamento

A API fpapi048 deve ser executada de forma persistente.

Sintaxe para executar a API em modo persistente:

run prghur/fpp/fpapi048.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-bnfciar_palim	Contém os beneficiários de um colaborador	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
cdn_bnfciar_palim	Inteiro	z9	Beneficiário	Sim	2.10
nom_pessoa_fisic	Caracter	x(40)	Nome	Sim	2.10
dat_comunic_judic	Data	99/99/9999	Data Comunicação Judicial	Sim	2.10
cod_pais	Caracter	x(3)	País	Sim	2.10
cod_id_feder	Caracter	x(20)	ID Federal	Não	2.10
processo	Caracter	x(20)	Processo	Não	2.10
oficio	Caracter	x(20)	Ofício	Não	2.10
idi_sit_palim	Inteiro	99	Situação pensão	Sim	2.10
idi_forma_pagto_bnfciar_palim	Inteiro	99	Forma Pagamento	Sim	2.10
cdn_banco	Inteiro	zz9	Banco	Não	2.10
cdn_agenc_bcia	Inteiro	zzz9	Agência	Não	2.10
cdn_forma_pagto_bco	Inteiro	99	Forma Pagamento Banco	Não	2.10
cdn_cta_corren	Inteiro	999999999	Conta corrente	Não	2.10
cod_digito_cta_corren	Caracter	x(2)	Dígito conta corrente	Não	2.10
idi_tip_calc_palim_normal	Inteiro	9	Tipo Cálculo Pensão	Sim	2.10
idi_tip_base_calc_palim_normal	Inteiro	9	Tipo Base Cálculo Normal	Sim	2.10
idi_tip_calc_palim_ferias	Inteiro	9	Tipo Cálculo Pensão Férias	Sim	2.10
idi_tip_base_calc_palim_ferias	Inteiro	9	Tipo Base Cálculo Férias	Sim	2.10
idi_tip_calc_palim_13o	Inteiro	9	Tipo Cálculo Pensão 13	Sim	2.10
idi_tip_base_calc_palim_13º	Inteiro	9	Tipo Base Cálculo 13	Sim	2.10
idi_tip_calc_palim_ppr	Inteiro	9	Tipo Cálculo Pensão PPR	Sim	2.10
idi_tip_base_calc_palim_ppr	Inteiro	9	Tipo Base Cálculo PPR	Sim	2.10
cod_unid_federac_rh	Caracter	x(04)	UF	Não	2.10

Tabela Temporária	Descrição	Entrada/Saída
tt-depend_func	Contém os dependentes de um colaborador	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
cdn_depend_func	Inteiro	zz9	Dependente	Sim	2.10
nom_depend_func	Caracter	x(40)	Nome	Sim	2.10
dat_nascimento	Data	99/99/9999	Data Nascimento	Sim	2.10
idi_grau_depen_func	Inteiro	99	Grau Dependência	Sim	2.10
incide_ir	Lógico	Yes/no	Incide Imposto de Renda	Sim	2.10
incide_sf	Lógico	Yes/no	Incide Salário Família	Sim	2.10
cod_id_feder	Caracter	x(20)	Id Federal	Não	2.10
nome_mae_depend	Caracter	X(40)	Nome da mãe do dependente	Não	2.10
nom_cidad_nasc_depend	Caracter	x(25)	Cidade nascimento	Não	2.10
cod_pais_nasc	Caracter	x(3)	País Nascimento	Não	2.10
cod_unid_federac_nasc	Caracter	x(4)	UF Nascimento	Não	2.10
idi_estado_saude_depend	Inteiro	99	Estado de Saúde	Sim	2.10
cdn_tip_invdez_depend_func	Inteiro	99	Tipo Invalidez	Não	2.10
log_comprov_freq_dia	Lógico	Yes/no	Comprovante Frequência em Dia	Sim	2.10
dat_apres_comprov_freq	Data	99/99/9999	Data Apresentação Comprovante Frequência	Não	2.10
log_gera_estabil_func	Lógico	Yes/no	Gera Estabilidade	Sim	2.10
cdn_motiv_estabil_func	Inteiro	>9	Motivo Estabilidade	Não	2.10
nom_cartor_reg_depend	Caracter	x(40)	Cartório	Não	2.10
cod_cgc_cartor	Caracter	99.999.999/9999-99	C.G.C. Cartório	Não	2.10
cod_folha_anot_depend	Caracter	x(05)	Folha	Não	2.10
cod_livro_anot_depend	Caracter	x(05)	Livro	Não	2.10
num_reg_certid_depend	Inteiro	zzzzzz9	Registro	Não	2.10
dat_certid_nasc_depend	Data	99/99/9999	Data Certidão Nascimento	Não	2.10
dat_entr_certid_nasc	Data	99/99/9999	Entrega Carteira	Não	2.10
idi_sexo	Inteiro	99	Sexo	Sim	2.10
log_estudan	Lógico	Yes/no	Estudante	Sim	2.10
log_emite_alerta_depend	Lógico	Yes/no	Emite Alerta	Sim	2.10
idi_sit_salfam	Inteiro	99	Situação Salário Família	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

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

Requisito	Inexistente.
Sintaxe	run procedure pi-beneficiario in h-handle (input p_cdn_empresa, input p_cdn_estab, input p_cdn_funcionario, output table tt-bnfciar_palim, output table tt-erro).
Descrição	O método retornará os dependentes dos colaboradores.
	Parâmetros	Descrição
	p_cdn_empresa p_cdn_estab p_cdn_funcionario tt-bnfciar_palim tt-erro	Empresa Estabelecimento Matrícula Temp-table com os beneficiários Erros do processo.
Retorno	Temp-tables tt-depend_func e tt-erro populadas. As mensagens possíveis para este método são: "Não existe beneficiários cadastrados para o funcionário!"

procedure pi-dependente

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

Método Negócio

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

Árvore de páginas