Árvore de páginas

Carregando...

 

Documento de API

Produto:

Datasul

Ocorrência:

Documentação de API

Nome Físico

 prghur/fpp/fpapi060.p 

 

Objetivo

Retornar os períodos aquisitivos de férias dos colaboradores.

 

Funcionamento

A API fpapi060 deve ser executada de forma persistente.

Sintaxe para executar a API em modo persistente:

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

Contém os históricos de períodos aquisitivos

Saída

Atributo

Tipo

Formato

Descrição

Obrigatório

Evolução

companyCode

Inteiro

zz9

Empresa

Sim

2.10

siteCode

Inteiro

zz9

Estabelecimento

Sim

2.10

registry

Inteiro

zzzzzzz9

Matrícula

Sim

2.10

initialDate

Data

99/99/9999

Início Período Aquisitivo

Sim

2.10

acquiredPeriodStatus

Inteiro

99

Situação Período Aquisitivo

Sim

2.10

endDate

Data

99/99/9999

Fim Período Aquisitivo

Sim

2.10

daysDue

Decimal

z9.99

Dias de Direito

Não

2.10

daysTaked

Decimal

z9.99

Dias Concedidos

Não

2.10

remainder

Decimal

z9.99

Dias restantes

Não

2.10

daysVacation

Decimal

z9.99

Dias a gozar

Não

2.10

daysRemuneration

Decimal

z9.99

Dias Abono

Não

2.10

daysLicense

Decimal

z9.99

Dias Licença

Não

2.10

Tabela Temporária

Descrição

Entrada/Saída

tt-habilit_ferias

Contém os históricos de férias

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

dat_inic_period_aqst_ferias

Data

99/99/9999

Início Período Aquisitivo

Sim

2.10

dat_inic_ferias

Data

99/99/9999

Data início de férias

Sim

2.10

dat_term_ferias

Data

99/99/9999

Data Fim férias

Sim

2.10

qtd_dias_ferias_gozar

Decimal

z9.99

Dias a gozar

Não

2.10

qtd_dias_abono_ferias

Decimal

z9.99

Dias Abono

Não

2.10

qtd_dias_licenc

Decimal

z9.99

Dias Licença

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 pi-hist_graduacao

Requisito

Inexistente.

Sintaxe

run procedure pi-hist_graduacao in h-handle

(input p_cdn_empresa,

 input p_cdn_estab,

 input p_cdn_funcionario,

 input p_dat_inicio,

 input p_dat_fim,

 output table tt-hist_ferias,

 output table tt-habilit_ferias,

 output table tt-erro).

Descrição

O método retornará os históricos de períodos aquisitivos e férias dos colaboradores.

 

Parâmetros

Descrição

 

p_cdn_empresa

p_cdn_estab

p_cdn_funcionario

p_dat_inicio

p_dat_fim

tt-hist_ferias

tt-habilit_ferias

tt-erro

Empresa

Estabelecimento

Matrícula

Data início

Data fim

Temp-table com os históricos períodos aquisitivos

Temp-table com os históricos de férias

Erros do processo.

Retorno

Temp-tables tt-hist_ferias, tt-habilit_ferias e tt-erro populadas.

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

"Não existem períodos aquisitivos abertos cadastrados!"


Método Negócio

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