FPAPI023 - Realiza a exportação de informações dos colaboradores.

Documento de API

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

Objetivo

Realiza a exportação de informações dos colaboradores.

Funcionamento

A API fpapi023 deve ser executada de forma persistente.

Sintaxe para executar a API em modo persistente:

run prghur/fpp/fpapi023.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-EmploymentContract	Contém informações do contrato de trabalho dos colaboradores.	Saída

Atributo	Tipo	Formato	Descrição	Obrigatório	Evolução
codeCompany	Inteiro	Zz9	Código da empresa	Sim	2.10
codeSite	Inteiro	Zz9	Código do estabelecimento	Sim	2.10
registry	Inteiro	Zzzzzzz9	Código de matrícula do funcionário	Sim	2.10
employeeName	Caracter	X(40)	Nome do funcionário	Não	2.10
admissionDate	Inteiro	99/99/9999	Data de admissão do funcionário	Sim	2.10
endContractDate	Data	X(12)	Data de término do contrato de experiência	Não	2.10
employmentContractType	Inteiro	9	Tipo de contrato do funcionário	Sim	2.10
endExtensionDate	Data	99/99/9999	Data de término da extensão do contrato de experiência	Não	2.10
employeeType	Inteiro	Z9	Tipo de funcionário	Sim	2.10
previousInformPrinted	Lógico	Yes/no	Último aviso prévio impresso	Não	2.10
printPreviousInform	Lógico	Yes/no	Imprime aviso prévio?	Não	2.10
recissionDate	Data	99/99/9999	Data de rescisão do contrato	Não	2.10
cdn_vinc_empregat	Inteiro	Z9	Código do vínculo empregatício	Não	2.10

Tabela Temporária	Descrição	Entrada/Saída
tt_documentos	Contém informações do contrato de trabalho dos colaboradores.	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
cod_func_inss	Caracter	X(12)	Código de matrícula do INSS	Não	2.10
cod_cart_trab	Caracter	x(10)	Código da carteira de trabalho	Não	2.10
cod_ser_cart_trab	Caracter	x(08)	Série da carteira de trabalho	Não	2.10
cod_unid_federac_cart_trab	Caracter	x(04)	UF da carteira de trabalho	Não	2.10
dat_cart_trab	Data	99/99/9999	Data da carteira de trabalho	Não	2.10
idi_model_cart_trab	Inteiro	Z9	Tipo de carteira de trabalho	Não	2.10
cod_pis	Caracter	x(11)	Código do PIS	Não	2.10
dat_pis_pasep	Data	99/99/9999	Data do PIS/PASEP	Não	2.10
cod_digito_cta_corren	Caracter	x(2)	Código do dígito da conta corrente	Não	2.10
cdn_cta_corren	Inteiro	zzzzzzzz9	Conta corrente	Não	2.10
cdn_agenc_bcia_liq	Inteiro	zzz9	Agência bancária	Não	2.10
cdn_bco_liq	Inteiro	zz9	Código Banco	Não	2.10
cod_id_feder	Caracter	x(20)	CPF	Não	2.10
cod_id_estad_fisic	Caracter	x(20)	RG	Não	2.10
idi_orig_pessoa_fisic	Inteiro	99	Tipo de pessoa física	Sim	2.10
dat_emis_id_estad_fisic	Data	99/99/9999	Data de emissão da identidade	Não	2.10
cod_orgao_emis_id_estad	Caracter	x(10)	Órgão Emissor	Não	2.10
cod_unid_federac_emis_estad	Caracter	x(3)	UF Emissão	Não	2.10
idi_tip_visto_estrang	Inteiro	9	Tipo Visto Estrang	Não	2.10
cod_identde_estrang	Caracter	x(15)	Ident Estrang	Não	2.10
dat_valid_ident_estrang	Data	99/99/9999	Valid Ident Estran	Não	2.10
num_ano_chegad_pais	Inteiro	9999	Ano Chegada	Não	2.10

Tabela Temporária	Descrição	Entrada/Saída
tt_dados_pessoais	Contém dados pessoais dos colaboradores.	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
dat_nascimento	Data	99/99/9999	Data Nascimento	Não	2.10
nom_naturalidade	Caracter	x(30)	Naturalidade	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_civil	Inteiro	99	Estado Civil	Não	2.10
cod_pais	Caracter	x(3)	País	Não	2.10
cdn_grau_instruc	Inteiro	z9	Grau Instrução	Não	2.10
nom_pai_pessoa_fisic	Caracter	x(40)	Nome Pai	Não	2.10
nom_mae_pessoa_fisic	Caracter	x(40)	Nome Mãe	Não	2.10
num_pessoa_fisic	Inteiro	>>>,>>>,>>9	Pessoa Física	Sim	2.10
idi_sexo	Inteiro	99	Sexo	Sim	2.10
nom_abrev_pessoa_fisic	Caracter	x(30)	Nome Abreviado	Não	2.10
log_estudan	Lógico	Yes/no	Estudante?	Não	2.10
num_ender	Caracter	X(8)	Número do endereço	Não	2.10
nom_ender_rh	Caracter	x(40)	Endereço	Não	2.10
nom_cidad_rh	Caracter	x(25)	Cidade	Não	2.10
num_fax	Inteiro	9999,9999	Telefone comercial	Não	2.10
num_telef_contat	Inteiro	9999,9999	Telefone Contato	Não	2.10
cod_pais_ender	Caracter	x(3)	País Endereço	Não	2.10
nom_e_mail	Caracter	x(40)	E-mail	Não	2.10
num_telefone	Inteiro	9999,9999	Telefone	Não	2.10
num_telex	Inteiro	zzzzzz9	Ramal	Não	2.10
nom_pto_refer	Caracter	x(40)	Ponto Referência	Não	2.10
nom_bairro_rh	Caracter	x(30)	Bairro	Não	2.10
cod_unid_federac_rh	Caracter	x(04)	UF	Não	2.10
cod_cep_rh	Caracter	99999-999	CEP	Não	2.10

Tabela Temporária	Descrição	Entrada/Saída
tt_forma_pagamento	Contém informações salariais dos colaboradores.	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_regiao_sal	Inteiro	>9	Região Sal	Não	2.10
idi_forma_pagto	Inteiro	99	Forma Pagamento	Não	2.10
des_regiao	Caracter	x(40)	Descrição Região Salarial	Não	2.10
cdn_tab_sal	Inteiro	zz9	Tabela Salarial	Não	2.10
des_tab_sal	Caracter	x(40)	Descrição Tabela Salarial	Não	2.10
log_salario_tabdo	Lógico	Yes/no	Salário Tabelado?	Não	2.10
val_salario_atual	Decimal	z,zzz,zz9.9999	Salário Atual	Sim	2.10

Tabela Temporária	Descrição	Entrada/Saída
tt_dados_ponto	Contém informações de ponto dos colaboradores.	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
log_consid_integr_ptoelet	Lógico	Yes/no	Integra Ponto	Não	2.10
idi_emite_cartao_pto	Inteiro	99	Emite Cartão Ponto	Não	2.10
num_cartao_pto	Inteiro	zzzzzzz9	Cartão Ponto	Não	2.10

Tabela Temporária	Descrição	Entrada/Saída
tt_vinculo	Contém informações de vínculo dos colaboradores.	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
qti_dias_contrat_trab	Inteiro	zzz9	Dias Contrato	Não	2.10
idi_orig_contratac_func	Inteiro	99	Tipo Contratação	Não	2.10
qti_dias_prorrog_contrat_trab	Inteiro	zzz9	Dias Prorrogação Contrato	Não	2.10
cod_unid_federac_empres_ant	Caracter	x(04)	UF Empr Anterior	Não	2.10
dat_ult_exam_medic	Data	99/99/9999	Ult Exame Medico	Não	2.10
log_func_qualifdo	Lógico	Yes/no	Qualificado	Não	2.10
num_reg_func	Inteiro	zzzzzzz9	Número Registro	Não	2.10
dat_aposentadoria	Data	99/99/9999	Data de aposentadoria	Não	2.10
idi_tip_estatis_func	Inteiro	9	Tipo Estatistica	Não	2.10
qti_meses_trab_ant	Inteiro	999	Meses Trab Ant	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

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 piEmploymentContract

Requisito	Inexistente.
Sintaxe	run procedure piEmploymentContract in h-handle (Output table tt-EmploymentContract, Output table tt-erro).
Descrição	O método retornará dados dos contratos dos colaboradores.
	Parâmetros	Descrição
	tt-EmploymentContract tt-erro	Dados dos contratos dos colaboradores. Erros do processo.
Retorno	Temp-tables tt-EmploymentContract e tt-erro populadas. As mensagens possíveis para este método são: "Não existem contratos cadastrados!"

procedure pi_documentos

Requisito			Inexistente.
Sintaxe			run procedure pi_documentos in h-handle (input v_cdn_empresa, Input v_cdn_estab, Input v_cdn_funcionario, Output table tt_documentos, Output table tt-erro).
Descrição			O método retornará dados dos documentos dos colaboradores.
			Parâmetros	Descrição
	v_cdn_empresa v_cdn_estab v_cdn_funcionario tt_documentos tt-erro			Código da empresa do colaborador. Código do estabelecimento do colaborador. Código de matrícula do colaborador. Documentos dos colaboradores. Erros do processo.
Retorno		Temp-tables tt_documentos e tt-erro populadas. As mensagens possíveis para este método são: " Não existem funcionários cadastrados!"

procedure pi_dados_pessoais

Requisito			Inexistente.
Sintaxe			run procedure pi_dados_pessoais in h-handle (Output table tt_dados_pessoais, Output table tt-erro).
Descrição			O método retornará dados pessoais dos colaboradores.
			Parâmetros	Descrição
	v_cdn_empresa v_cdn_estab v_cdn_funcionario tt_dados_pessoais tt-erro			Código da empresa do colaborador. Código do estabelecimento do colaborador. Código de matrícula do colaborador. Dados pessoais dos colaboradores. Erros do processo.
Retorno		Temp-tables tt_dados_pessoais e tt-erro populadas. As mensagens possíveis para este método são: "Não existem funcionários cadastrados!"

procedure pi_forma_pagamento

Requisito			Inexistente.
Sintaxe			run procedure pi_forma_pagamento in h-handle (Output table tt_forma_pagamento, Output table tt-erro).
Descrição			O método retornará dados da forma de pagamento dos colaboradores.
			Parâmetros	Descrição
	v_cdn_empresa v_cdn_estab v_cdn_funcionario tt_forma_pagamento tt-erro			Código da empresa do colaborador. Código do estabelecimento do colaborador. Código de matrícula do colaborador. Dados da forma de pagamento dos colaboradores. Erros do processo.
Retorno		Temp-tables tt_forma_pagamento e tt-erro populadas. As mensagens possíveis para este método são: "Não existem funcionários cadastrados!"

procedure pi_dados_ponto

Requisito			Inexistente.
Sintaxe			run procedure pi_dados_ponto in h-handle (Output table tt_dados_ponto, Output table tt-erro).
Descrição			O método retornará dados de controle de frequência dos colaboradores.
			Parâmetros	Descrição
	v_cdn_empresa v_cdn_estab v_cdn_funcionario tt_dados_ponto tt-erro			Código da empresa do colaborador. Código do estabelecimento do colaborador. Código de matrícula do colaborador. Dados de controle de frequência dos colaboradores. Erros do processo.
Retorno		Temp-tables tt_dados_ponto e tt-erro populadas. As mensagens possíveis para este método são: "Não existem funcionários cadastrados!"

procedure pi_vinculo

Requisito			Inexistente.
Sintaxe			run procedure pi_vinculo in h-handle (Output table tt_vinculo, Output table tt-erro).
Descrição			O método retornará dados de vínculo dos colaboradores.
			Parâmetros	Descrição
	v_cdn_empresa v_cdn_estab v_cdn_funcionario tt_vinculo tt-erro			Código da empresa do colaborador. Código do estabelecimento do colaborador. Código de matrícula do colaborador. Dados de vínculo dos colaboradores. Erros do processo.
Retorno		Temp-tables tt_vinculo e tt-erro populadas. As mensagens possíveis para este método são: "Não existem funcionários cadastrados!"

procedure pi_altera_dados_pessoais

Requisito			Inexistente.
Sintaxe			run procedure pi_altera_dados_pessoais in h-handle (input p_cdn_empresa, input p_cdn_estab, input p_cdn_funcionario, input p_nom_abrev_pessoa_fisic, input p_dat_nascimento, input p_cod_pais_nasc, input p_cod_unid_federac_nasc, input p_nom_naturalidade, input p_cdn_grau_instruc, input p_idi_estado_civil, input p_idi_sexo, input p_nom_pai_pessoa_fisic, input p_nom_mae_pessoa_fisic, Output table tt-erro).
Descrição			O método altera alguns dados pessoais dos colaboradores.
			Parâmetros	Descrição
	p_cdn_empresa p_cdn_estab p_cdn_funcionario p_nom_abrev_pessoa_fisic p_dat_nascimento p_cod_pais_nasc p_cod_unid_federac_nasc p_nom_naturalidade p_cdn_grau_instruc p_idi_estado_civil p_idi_sexo p_nom_pai_pessoa_fisic p_nom_mae_pessoa_fisic tt-erro				Código da empresa do colaborador. Código do estabelecimento do colaborador. Código de matrícula do colaborador. Nome abreviado da pessoa física. Data de nascimento. Código do País de nascimento. Código da UF de nascimento. Nome da cidade. Código do grau de instrução. Estado civil. Sexo Nome do pai. Nome da mãe. Erros do processo.
Retorno		Temp-table tt-erro populada quando houver erro. As mensagens possíveis para este método são: "Verifique se existe uma ocorrência para o(a) funcionário informado(a) em seu cadastro." "Verifique se existe uma ocorrência para o(a) país informado(a) em seu cadastro." "Verifique se existe uma ocorrência para o(a) unidade de federação informado(a) em seu cadastro." "Verifique se existe uma ocorrência para o(a) grau de instrução informado(a) em seu cadastro." "Não existe pessoa física cadastrada!".

procedure pi_altera_endereco

Requisito			Inexistente.
Sintaxe			run procedure pi_altera_endereco in h-handle (input p_cdn_empresa, input p_cdn_estab, input p_cdn_funcionario, input p_nom_ender_rh, input p_num_ender, input p_nom_pto_refer, input p_nom_bairro_rh, input p_nom_cidad_rh, input p_cod_pais_ender, input p_cod_unid_federac_rh, input p_cod_cep_rh, input p_num_telefone, input p_num_telef_contat, input p_num_fax, input p_num_telex, input p_nom_e_mail, Output table tt-erro).
Descrição			O método altera alguns dados de endereço dos colaboradores.
			Parâmetros	Descrição
	p_cdn_empresa p_cdn_estab p_cdn_funcionario p_nom_ender_rh p_num_ender p_nom_pto_refer p_nom_bairro_rh p_nom_cidad_rh p_cod_pais_ender p_cod_unid_federac_rh p_cod_cep_rh p_num_telefone p_num_telef_contat p_num_fax p_num_telex p_nom_e_mail tt-erro				Código da empresa do colaborador. Código do estabelecimento do colaborador. Código de matrícula do colaborador. Endereço. Número do endereço. Ponto de referência. Bairro. Cidade. Código do país do endereço. Código da unidade de federação. CEP Número do telefone. Número de telefone para contato. Número de telefone comercial. Ramal. E-mail. Erros do processo.
Retorno		Temp-table tt-erro populada quando houver erro. As mensagens possíveis para este método são: "Verifique se existe uma ocorrência para o(a) funcionário informado(a) em seu cadastro." "Verifique se existe uma ocorrência para o(a) país informado(a) em seu cadastro." "Verifique se existe uma ocorrência para o(a) unidade de federação informado(a) em seu cadastro." "Não existe pessoa física cadastrada!".

procedure pi_altera_documentos

Requisito			Inexistente.
Sintaxe			run procedure pi_altera_documentos in h-handle (input p_cdn_empresa, input p_cdn_estab, input p_cdn_funcionario, input p_cod_id_estad_fisic, input p_cod_orgao_emis_id_estad, input p_cod_unid_federac_emis_estad, input p_dat_emis_id_estad_fisic, input p_idi_orig_pessoa_fisic, input p_idi_tip_visto_estrang, input p_cod_identde_estrang, input p_dat_valid_ident_estrang, input p_num_ano_chegad_pais, input p_cod_id_feder, Output table tt-erro).
Descrição			O método altera alguns dados de endereço dos colaboradores.
			Parâmetros	Descrição
	p_cdn_empresa p_cdn_estab p_cdn_funcionario p_cod_id_estad_fisic p_cod_orgao_emis_id_estad p_cod_unid_federac_emis_estad p_dat_emis_id_estad_fisic p_idi_orig_pessoa_fisic p_idi_tip_visto_estrang p_cod_identde_estrang p_dat_valid_ident_estrang p_num_ano_chegad_pais p_cod_id_feder tt-erro				Código da empresa do colaborador. Código do estabelecimento do colaborador. Código de matrícula do colaborador. Carteira de Identidade. Órgão Emissor. UF Emissão. Data Emissão. Origem da pessoa física. Tipo de visto de estrangeiro. Código identidade estrangeira. Data de validade de identidade estrangeira Ano de chegada ao país. C.P.F. Erros do processo.
Retorno		Temp-table tt-erro populada quando houver erro. As mensagens possíveis para este método são: "Verifique se existe uma ocorrência para o(a) funcionário informado(a) em seu cadastro." "Verifique se existe uma ocorrência para o(a) unidade de federação informado(a) em seu cadastro." "Não existe pessoa física cadastrada!".

Método Negócio

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

Árvore de páginas