Documento de API
Produto: | Datasul |
Ocorrência: | Documentação de API |
Nome Físico | prghur/frp/frapi003.p |
Objetivo
Api gera programação de rescisão para um determinado funcionário.
Funcionamento
A API/BO
Na forma padrão, realiza-se a chamada através de um comando RUN normal, passando-se as informações necessárias.
A sintaxe para a chamada da API/BO é:
A api somente poderá ser executada em modo persistente.
A sintaxe para executar a API/BO em modo persistente é:
run prghur/fpp/fpapi200 persistent set h-handle.
run pi-recisao in h-handle ( Input v_cdn_empresa,
Input v_p_cdn_estab,
Input v_cdn_funcionario,
Input v_log_valida_portal,
Input v_cdn_sit_afast,
Input v_dat_desligto,
Input v_dat_pagto,
Input v_dat_lim_pagto_rescis,
Input v_tip_aviso,
Input v_num_dias_aviso,
Input v_tip_jornada,
Input v_dat_aviso,
Input v_dat_inicio_aviso,
Input v_dat_termino_aviso,
Input v_log_imprime_aviso,
Input v_fgts_mes,
Input v_num_perc_multa,
Input v_cod_saque,
Input v_val_fgts,
Input v_val_jam_fgts,
Input v_log_fgts_mes_anterior_grfp,
Input v_log_rec_ferias_proporc,
Input v_log_rec_13_proporc,
Input v_log-calc-adic,
Input v_tip_movto,
Input v_rs-cheque,
Input v_log_valida_feriado,
Input v_nom_local_pagto,
Ouput table tt-erro).
A variável denominada h-handle irá receber o “handle” do programa, permitindo o acesso aos “métodos” internos da API.
Tabelas Temporárias
Temp table: tt-erro
Descrição do Campo | Campo | Formato |
Código do Erro | Code | 999 |
Descrição do Erro | Description | X(60) |
Parâmetros utilizados pela API :
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
V_cdn_empresa | Char | X(3) | Empresa | sim | 2.12 |
v_cdn_estab, | Char | X(5) | Empresa | sim | 2.12 |
v_cdn_funcionario, | Int | Zzzzzzz9 | Matrícula | sim | 2.12 |
v_log_valida_portal, | log | Yes/No | Somente Validação | sim | 2.12 |
v_cdn_sit_afast, | int | 99 | Situação de Afastamento | sim | 2.12 |
v_dat_desligto, | date | 99/99/9999 | Data Desligamento | sim | 2.12 |
v_dat_pagto, | date | 99/99/9999 | Data de Pagamento | sim | 2.12 |
v_dat_lim_pagto_rescis, | date | 99/99/9999 | Data Limite Pgto Rescisão | sim | 2.12 |
v_tip_aviso, | int | 9 | Tipo Aviso | sim | 2.12 |
v_num_dias_aviso, | int | 999 | Número de dias Aviso | sim | 2.12 |
v_tip_jornada, | int | 9 | Tipo de Jornada | sim | 2.12 |
v_dat_aviso, | date | 99/99/9999 | Data do Aviso | sim | 2.12 |
v_dat_inicio_aviso, | date | 99/99/9999 | Data Início do Aviso | sim | 2.12 |
v_dat_termino_aviso, | date | 99/99/9999 | Data Término Aviso | sim | 2.12 |
v_log_imprime_aviso, | log | Yes/No | Imprime aviso | sim | 2.12 |
v_fgts_mes, | int | 9 | FGTS do período de Rescisão | sim | 2.12 |
v_num_perc_multa, | int |
| Percentual de Multa | sim | 2.12 |
v_cod_saque, | char |
| Código do Saque | sim | 2.12 |
v_val_fgts, | dec |
| Valor do saque do FGTS | sim | 2.12 |
v_val_jam_fgts, | dec |
| Valor do Juros do FGTS | sim | 2.12 |
v_log_fgts_mes_anterior_grfp, | log | Yes/No | Indicativo se ir recuperar o valor do FGTS do mês anterior e somar ao FGTS da rescisão automaticamente | sim | 2.12 |
v_log_rec_ferias_proporc, | log | Yes/No | Indicativo se deve receber férias proporcionais aos meses de trabalho | sim | 2.12 |
v_log_rec_13_proporc, | log | Yes/No | Indicativo se deve receber 13§ sal rio proporcional aos meses de trabalho | sim | 2.12 |
v_log-calc-adic, | log | Yes/No | Indicativo que ser realizado o cálculo dos adicionais de férias e 13o salário para os funcionários que tiverem menos de um ano de empresa. | sim | 2.12 |
v_tip_movto, | int |
| Tipo de movimentação | sim | 2.12 |
v_rs-cheque, | int |
| Tipo de cheque | sim | 2.12 |
v_log_valida_feriado, | log | Yes/No | Indicativo se deve validar os dias fora dos limites para data de pagamento | sim | 2.12 |
v_nom_local_pagto, | char |
| Código do local de pagamento | sim | 2.12 |
Métodos
Quando a API/BO for executada em modo persistente, os seguintes métodos estarão disponíveis para execução:
pi-recisao
Método Básico
pi-recisao: gera programação de rescisão para um determinado funcionário.
Método Negócio
Não há método de negócio disponível nesta api.