Árvore de páginas

Carregando...

 

Documento de API

Produto:

Datasul

Ocorrência:

Documentação de API

Nome Físico

 prghur/fpp/fpapi044.p

 

Objetivo

Retornar os dados necessários para a impressão do aviso prévio dos colaboradores.

 

Funcionamento

A API fpapi044 deve ser executada de forma persistente.

Sintaxe para executar a API em modo persistente:

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

Contém as informações do aviso prévio

Saída

Atributo

Tipo

Formato

Descrição

Obrigatório

Evolução

cod_funcionario

Caracter

x(11)

Matrícula

Sim

2.10

cod_unid_lotac

Caracter

x(11)

Código da unidade de lotação

Sim

2.10

des_unid_lotac

Caracter

x(40)

Descrição da unidade de lotação

Sim

2.10

dat_ini_aviso

Data

99/99/9999

Data de início do aviso

Sim

2.10

dat_fim_aviso

Data

99/99/9999

Data de fim do aviso

Sim

2.10

reduz_jornada

Inteiro

9

Redução Jornada

Sim

2.10

tipo_aviso

Inteiro

9

Tipo Aviso

Sim

2.10

nome_cidade

Caracter

x(25)

Nome da cidade

Sim

2.10

Tabela Temporária

Descrição

Entrada/Saída

tt_load_inform

Contém os colaboradores que possuem aviso prévio a imprimir

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_desligto_func

Data

99/99/9999

Data de desligamento

Sim

2.10

aviso_emitido

Lógico

Yes/no

Indica se o aviso já foi emitido

Sim

2.10

Tabela Temporária

Descrição

Entrada/Saída

tt-rescissionDemonstrativeHeader

Contém o cabeçalho do demonstrativo de cálculo de rescisão

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

qtdMonthHours

Decimal

zz9.999

Horas categoria

Sim

2.10

qtdDayHours

Decimal

zz9.99999

Horas Padrão Dia

Sim

2.10

dependantIRF

Inteiro

9

Quantidade de dependentes

Não

2.10

reasonCode

Inteiro

Z9

Situação

Sim

2.10

previousInformInitialDate

Data

99/99/9999

Data de início do aviso prévio

Sim

2.10

previousInformEndDate

Data

99/99/9999

Data de fim do aviso prévio

Sim

2.10

previousInformDays

Inteiro

99

Quantidade de dias do aviso

Sim

2.10

paymentDate

Data

99/99/9999

Data de pagamento

Sim

2.10

fgtsValue

Decimal

z,zzz,zzz,zz9.999

Valor depósito FGTS

Sim

2.10

fgtsInterestValue

Decimal

z,zzz,zzz,zz9.999

Valor juros FGTS

Sim

2.10

fgtsPenaltyPercent

Decimal

z9.99

Percentual Multa FGTS

Sim

2.10

Tabela Temporária

Descrição

Entrada/Saída

tt-rescissionDemonstrativeDetail

Detalhes do demonstrativo de cálculo de rescisão

Saída

Atributo

Tipo

Formato

Descrição

Obrigatório

Evolução

eventCode

Caracter

x(03)

Código do evento

Sim

2.10

eventDescription

Caracter

X(30)

Descrição do evento

Sim

2.10

eventQuantity

Decimal

>>9.999

Quantidade

Sim

2.10

eventAmount

Decimal

zzz,zzz,zz9.99

Valor

Sim

2.10

eventBaseAmount

Decimal

zzz,zzz,zz9.99

Base

Sim

2.10

eventTypeEnum

Inteiro

9

Identificação do evento

Sim

2.10

eventUnit

Caracter

x(20)

Unidade

Sim

2.10

eventSource

Caracter

x(20)

Origem Movimento

Sim

2.10

calculeGroupDescription

Inteiro

Z9

Sequência Cálculo

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_load_rescission

Requisito

Inexistente.

Sintaxe

run procedure pi_load_rescission in h-handle

(input p_cdn_empresa,

 input p_cdn_estab,

 input p_cdn_funcionario,

 input p_data_ini,

 input p_data_fim,

 output tt_load_inform,

 output table tt-erro).

Descrição

O método retornará colaboradores com aviso prévio a imprimir.

 

Parâmetros

Descrição

 

p_cdn_empresa

p_cdn_estab

p_cdn_funcionario

p_data_ini

p_data_fim

tt_load_inform

tt-erro

Empresa

Estabelecimento

Matrícula

Data de início

Data de término

Temp-table com os colaboradores com aviso prévio

Erros do processo.

Retorno

Temp-tables tt_load_inform e tt-erro populadas.

As mensagens possíveis para este método são:

"Não existem colaboradores desligados nesta data!"

procedure pi_print_inform

Requisito

Inexistente.

Sintaxe

run procedure pi_print_inform in h-handle

(input p_cdn_empresa,

 input p_cdn_estab,

 input p_cdn_funcionario,

 input p_data_ini,

 input p_data_fim,

 output tt_inform,

 output table tt-erro).

Descrição

O método retornará o mês de referência da empresa.

 

Parâmetros

Descrição

 

p_cdn_empresa

p_cdn_estab

p_cdn_funcionario

p_data_ini

p_data_fim

tt_inform

tt-erro

Empresa

Estabelecimento

Matrícula

Data de início

Data de fim

Temp-table com os dados do aviso prévio

Erros do processo.

Retorno

Temp-tables tt_inform e tt-erro populadas.

As mensagens possíveis para este método são:

"Rescisão do funcionário não permite emissão do aviso prévio"

procedure pi_record_inform

Requisito

Inexistente.

Sintaxe

run procedure pi_record_inform in h-handle

(input p_cdn_empresa,

 input p_cdn_estab,

 input p_cdn_funcionario,

 input p_data_ini,

 input p_data_fim).

Descrição

O método vai gravar que determinado aviso prévio já foi impresso.

 

Parâmetros

Descrição

 

p_cdn_empresa

p_cdn_estab

p_cdn_funcionario

p_data_ini

p_data_fim

Empresa

Estabelecimento

Matrícula

Data de início

Data de fim

procedure pigetRescissionDemonstrativeData

Requisito

Inexistente.

Sintaxe

run procedure pigetRescissionDemonstrativeData in h-handle

(input p_cdn_empresa,

 input p_cdn_estab,

 input p_cdn_funcionario,

 output table tt-rescissionDemonstrativeHeader,

 output table tt-rescissionDemonstrativeDetail,

 output table tt-erro).

Descrição

O método retornará os dados para impressão do demonstrativo de cálculo de rescisão.

 

Parâmetros

Descrição

 

p_cdn_empresa

p_cdn_estab

p_cdn_funcionario

tt-rescissionDemonstrativeHeader

tt-rescissionDemonstrativeDetail

tt-erro

Empresa

Estabelecimento

Matrícula

Temp-table com o cabeçalho do demonstrativo de cálculo de rescisão

Temp-table com os detalhes do demonstrativo de cálculo de rescisão

Erros do processo.

procedure pi-valida-folha-calculada

Requisito

Inexistente.

Sintaxe

run procedure pi-valida-folha-calculada in h-handle

(input p_cdn_empresa,

 input p_cdn_estab,

 input p_cdn_funcionario,

 input p_dat_rescisao,

 output table tt-erro).

Descrição

O método validará se no momento da solicitação de rescisão a folha de determinado colaborador está calculada.

 

Parâmetros

Descrição

 

p_cdn_empresa

p_cdn_estab

p_cdn_funcionario

p_dat_rescisao

tt-erro

Empresa

Estabelecimento

Matrícula

Data da rescisão

Erros do processo.

Retorno

Temp-table tt-erro populada quando houver erro.

As mensagens possíveis para este método são:

"Folha de Pagamento do mês  que se refere a rescisão encontra-se calculado"

 


Método Negócio

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