Documento de API
Produto: | Datasul |
Ocorrência: | Documentação de API |
Nome Físico | prghur/fpp/fpapi026.p |
Objetivo
Realiza a simulação do cálculo de férias e a impressão do demonstrativo e do recibo de férias.
Funcionamento
A API fpapi026 deve ser executada de forma persistente.
Sintaxe para executar a API em modo persistente:
run prghur/fpp/fpapi026.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-movto-calc-ferias-simul | Contém informações dos movimentos de férias dos colaboradores. | 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 |
vacationInitialDate | Data | 99/99/9999 | Data de início das férias | Sim | 2.10 |
vacationEndDate | Data | 99/99/9999 | Data de fim das férias | Sim | 2.10 |
acquiredPeriodInitialDate | Data | 99/99/9999 | Data de início do período aquisitivo de férias | Sim | 2.10 |
acquiredPeriodEndDate | Data | 99/99/9999 | Data de fim do período aquisitivo de férias | Sim | 2.10 |
vacationBonusInitialDate | Data | 99/99/9999 | Data de início do abono | Sim | 2.10 |
vacationBonusEndDate | Data | 99/99/9999 | Data de fim do abono | Sim | 2.10 |
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 do evento | Sim | 2.10 |
eventAmount | Decimal | zzz,zzz,zz9.99 | Valor do evento | Sim | 2.10 |
eventBaseAmount | Decimal | zzz,zzz,zz9.99 | Valor base do evento | Sim | 2.10 |
Tabela Temporária | Descrição | Entrada/Saída |
tt-vacationAbsenceReason | Contém as situações de afastamento dos colaboradores. | Saída |
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
absenceReasonCode | Inteiro | Z9 | Código da situação de afastamento | Sim | 2.10 |
absenceReasonDescription | Caracter | X(30) | Descrição da situação de afastamento | Sim | 2.10 |
absenceReasonInitialDate | Data | 99/99/9999 | Data de início da situação de afastamento | Sim | 2.10 |
absenceReasonEndDate | Data | 99/99/9999 | Data de fim da situação de afastamento | Sim | 2.10 |
Tabela Temporária | Descrição | Entrada/Saída |
tt-vacationReceiptHeader | Cabeçalho do demonstrativo de férias | Saída |
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
vacationInitialDate | Data | 99/99/9999 | Data de início das férias | Sim | 2.10 |
vacationEndDate | Data | 99/99/9999 | Data de fim das férias | Sim | 2.10 |
quantityDays | Decimal | z9.99 | Quantidade de dias de férias | Sim | 2.10 |
acquiredPeriodInitialDate | Data | 99/99/9999 | Data de início do período aquisitivo de férias | Sim | 2.10 |
acquiredPeriodEndDate | Data | 99/99/9999 | Data de fim do período aquisitivo de férias | Sim | 2.10 |
payedLicenseInitialDate | Data | 99/99/9999 | Data de início da licença | Não | 2.10 |
payedLicenseEndDate | Data | 99/99/9999 | Data de fim da licença | Não | 2.10 |
vacationBenefitedInitialDate | Data | 99/99/9999 | Data de início do abono | Não | 2.10 |
vacationBenefitedEndDAte | Data | 99/99/9999 | Data de fim do abono | Não | 2.10 |
vacationBenefitedDays | Decimal | z9.99 | Quantidade de dias de abono | Não | 2.10 |
numberOfDependents | Inteiro | Z9 | Quantidade de dependentes | Não | 2.10 |
salary | Decimal | z,zzz,zz9.9999 | Valor do salário atual | Sim | 2.10 |
paymentDate | Data | 99/99/9999 | Data do pagamento das férias | Sim | 2.10 |
locality | Caracter | X(40) | Descrição da localidade | Sim | 2.10 |
Tabela Temporária | Descrição | Entrada/Saída |
tt-vacationReceiptDetail | Detalhe do demonstrativo de férias | 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 do evento | Sim | 2.10 |
eventAmount | Decimal | zzz,zzz,zz9.99 | Valor do evento | Sim | 2.10 |
eventBaseAmount | Decimal | zzz,zzz,zz9.99 | Valor base do evento | Sim | 2.10 |
eventTypeEnum | Inteiro | Z9 | Tipo de evento | Sim | 2.10 |
Tabela Temporária | Descrição | Entrada/Saída |
tt-vacationsReceiptForMyTeam | Colaboradores com demonstrativo a imprimir | 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 |
vacationInitialDate | Data | 99/99/9999 | Data de início de férias | Sim | 2.10 |
vacationPaymentDate | Data | 99/99/9999 | Data de pagamento de férias | Sim | 2.10 |
printed | Lógico | Yes/No | Imprime aviso de férias? | Sim | 2.10 |
Tabela Temporária | Descrição | Entrada/Saída |
tt-histvar | Contém informações de vínculo dos colaboradores. | Saída |
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
ev-codigo | Inteiro | Zz9 | Código do evento | Sim | 2.10 |
var-sal | Decimal | Zz9.99 | Salário variável | 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-simulacao-calculo-ferias
Requisito | Inexistente. | |
Sintaxe | run procedure pi-simulacao-calculo-ferias in h-handle (input p_cdn_empresa, input p_cdn_estab, input p_cdn_funcionario, input p_dat_inic_ferias, input p_qtde_dias_ferias, input p_qtde_dias_abono, input p_perc_adto_13º, output table tt-erro). | |
Descrição | O método retornará a simulação do cálculo de férias de um colaborador. | |
| Parâmetros | Descrição |
| p_cdn_empresa p_cdn_estab p_cdn_funcionario p_dat_inic_ferias p_qtde_dias_ferias p_qtde_dias_abono p_perc_adto_13º tt-erro | Empresa Estabelecimento Matrícula Data de início de férias Quantidade de dias de férias Quantidade de dias de abono Percentual de adiantamento do 13 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) Período Aquisitivo Férias informado(a) em seu cadastro."" |
procedure validateVacation
Requisito | Inexistente. | |||
Sintaxe | run procedure validateVacation in h-handle (input p_cdn_empresa, input p_cdn_estab, input p_cdn_funcionario, input p_dat_inic_ferias, input p_qtde_dias_ferias, input p_qtde_dias_abono, output table tt-erro). | |||
Descrição | O método executará a validação para o cálculo de férias dos colaboradores. | |||
| Parâmetros | Descrição | ||
| p_cdn_empresa p_cdn_estab p_cdn_funcionario p_dat_inic_ferias p_qtde_dias_ferias p_qtde_dias_abono tt-erro | Empresa Estabelecimento Matrícula Data de início de férias Quantidade de dias de férias Quantidade de dias de abono Erros do processo. | ||
Retorno | Temp-table tt-erro populada quando houver erro. As mensagens possíveis para este método são: "Já foi calculado folha normal para o funcionário." "Funcionário possui férias programadas em data(s) coincidente(s)." "Funcionário possui férias programadas com início superior." "Funcionário já possui adiantamento de décimo terceiro salário no ano." "Quantidade de dias de férias superior ao saldo do período aquisitivo." "O ponto eletrônico já foi integrado com a folha de pagamento no mês correspondente as férias." "Data de início das férias deve ser em dia trabalhado no calendário do funcionário." "Não existe período aquisitivo em aberto para o funcionário." "Funcionário com menos de 18 anos ou mais de 50. Conceder 30 dias de férias!" "Quantidade de dias de abono deve ser 0 ou 10!" “Eventos especificos de ferias nao atualizados”. |
procedure pivacationsReceiptForMyTeam
Requisito | Inexistente. | |||
Sintaxe | run procedure pivacationsReceiptForMyTeam in h-handle (input p_cdn_empresa, input p_cdn_estab, input p_cdn_funcionario, input p_dat_param_inic, input p_dat_param_fim, input p_tipo_filtro_data, input p_tipo_filtro_aviso, Output table tt-vacationsReceiptForMyTeam, Output table tt-erro). | |||
Descrição | O método retornará os colaboradores com aviso de férias ou demonstrativo de férias a imprimir. | |||
| Parâmetros | Descrição | ||
| p_cdn_empresa p_cdn_estab p_cdn_funcionario p_dat_param_inic p_dat_param_fim p_tipo_filtro_data p_tipo_filtro_aviso tt-vacationsReceiptForMyTeam tt-erro | Código da empresa do colaborador. Código do estabelecimento do colaborador. Código de matrícula do colaborador. Data de início Data de fim Filtro por tipo de data de início de férias ou pagamento Filtro por tipo de aviso Colaboradores com informações a imprimir Erros do processo | ||
Retorno | Temp-tables tt-vacationsReceiptForMyTeam e tt-erro populadas. |
procedure pi-imprime-recibo-ferias
Requisito | Inexistente. | |||
Sintaxe | run procedure pi-imprime-recibo-ferias in h-handle (input p_cdn_empresa, input p_cdn_estab, input p_cdn_funcionario, input p_dat_inic_ferias, input p_log_simulacao, output table tt-vacationReceiptHeader, output table tt-vacationReceiptDetail, output table for tt-vacationAbsenceReason, Output table tt-erro). | |||
Descrição | O método retornará os dados para impressão do demonstrativo de cálculo de férias dos colaboradores. | |||
| Parâmetros | Descrição | ||
| p_cdn_empresa p_cdn_estab p_cdn_funcionario p_dat_inic_ferias p_log_simulacao tt-vacationReceiptHeader tt-vacationReceiptDetail tt-vacationAbsenceReason tt-erro | Código da empresa do colaborador. Código do estabelecimento do colaborador. Código de matrícula do colaborador. Data de início das férias Indica se é simulação Dados do cabeçalho do demonstrativo Detalhes do demonstrativo Situações de afastamento Erros do processo. | ||
Retorno | Temp-tables tt-vacationReceiptHeader, tt-vacationReceiptDetail, tt-vacationAbsenceReason e tt-erro populadas. As mensagens possíveis para este método são: "Funcionário não encontrado!" |
Método Negócio