Documento de API
Produto: | Datasul |
Ocorrência: | Documentação de API |
Nome Físico | prghur/fpp/fpapi017.p |
Objetivo
Realiza a exportação das informações de períodos aquisitivos de férias dos funcionários e a informações da ultima habilitação de férias de cada período aquisitivo, quando existir.
Funcionamento
A API fpapi017 deve ser executada de forma persistente.
run prghur/fpp/fpapi017.p persistent set h-handle.
Tabelas Temporárias
Nos atributos das tabelas temporárias de entrada e saída:
Tabela Temporária | Descrição | Entrada/Saída |
tt-AcquiredPeriod | Contém informações dos períodos aquisitivos e da ultima programação de férias | 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 |
initialDate | Data | dd/mm/aaaa | Data de início do período aquisitivo | Sim | 2.10 |
acquiredPeriodStatus | Inteiro | 99 | Situação do período aquisitivo | Sim | 2.10 |
endDate | Data | dd/mm/aaaa | Data de término do período aquisitivo | Sim | 2.10 |
daysDue | Decimal | Z9.99 | Número de dias de direito no período aquisitivo | Sim | 2.10 |
daysTaked | Decimal | Z9.99 | Número de dias já concedidos | Sim | 2.10 |
Remainder | Decimal | Z9.99 | Saldo do período aquisitivo | Sim | 2.10 |
daysVacation | Decimal | Z9.99 | Quantidade de dias de férias gozados no período | Sim | 2.10 |
daysRemuneration | Decimal | Z9.99 | Quantidade de dias de abono no período | Sim | 2.10 |
daysLicense | Decimal | Z9.99 | Quantidade de dias de licença no período | Sim | 2.10 |
dateInitVacation | Data | 99/99/9999 | Data de início da ultima programação de férias do período aquisitivo | Não | 2.10 |
daysVacationProg | Decimal | Z9.99 | Quantidade de dias de férias gozados na ultima programação de férias do período aquisitivo | Não | 2.10 |
daysRemunerationProg | Decimal | Z9.99 | Quantidade de dias de abono na ultima programação de férias do período aquisitivo | Não | 2.10 |
daysLicenseProg | Decimal | Z9.99 | Quantidade de dias de licença na ultima programação de férias do período aquisitivo | 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 piAcquiredPeriod
Requisito | Inexistente. | |
Sintaxe | run procedure piAcquiredPeriod in h-handle (output table tt-AcquiredPeriod, output table tt-habilit_ferias, output table tt-erro). | |
Descrição | O método retornará o cadastro de períodos e aquisitivos dos colaboradores. | |
| Parâmetros | Descrição |
| tt-AcquiredPeriod tt-habilit_ferias tt-erro | Temp-table com períodos aquisitivos Temp-table com habilitações de férias Erros do processo. |
Retorno | Temp-tables tt-AcquiredPeriod, 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