Linha Datasul

Árvore de páginas

 

Documento de API

Produto:

Datasul

Ocorrência:

Documentação de API

Nome Físico

 prghur/cap/caapi001.p

 

Objetivo

Efetua a geração de uma temp-table contendo informações referentes a remuneração dos funcionários por eventos do módulo de Cargos e Salários.


Funcionamento

A API irá verificar todos os movimentos calculados do tipo normal e seus respectivos eventos que possuem incidência positiva ou negativa no movimento calculado e que o identificador seja “vencimento”.

A API deverá receber como entrada as informações dos funcionários e dos eventos a serem verificados (se não forem enviadas informações de eventos serão consultados todos os eventos calculados).

O retorno da API será o valor total de remuneração encontrado através da consulta aos movimentos calculados do funcionário.

E se através do parâmetro de entrada a empresa informar como SIM o campo de salário categoria, o valor total da remuneração será dividido pela quantidade de horas da categoria (mensal, semanal, etc.).

 

A sintaxe para a chamada da API é:

             run prghur/cap/caapi001.p (input funcionario.cdn_empresa,

                                        input funcionario.cdn_estab,

                                        input funcionario.cdn_funcionario,

                                        input funcionario.cdn_turno_trab,

                                        input funcionario.cdn_categ_sal,

                                        input no /* Considera Categ.Salarial */,

                                        input table tt-event,                                       

                                        output v_val_remun_event).

 

Retorno

A API irá setar o return-value de forma a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta, turma criada) e NOK (execução com problemas).

 

Tabelas Temporárias

Nos atributos das tabelas temporárias de entrada e saída:

Tabela Temporária

Descrição

Entrada/Saída

tt-event

Contém os eventos a serem considerados no cálculo da remuneração do funcionário.

Entrada

Atributo

Tipo

Formato

Descrição

Obrigatório

Evolução

cdn_event_fp

<conforme dicionário>

<conforme dicionário>

Código do Evento Folha de Pagamento

Sim

2.08

Campos

Descrição

Entrada/Saída

v_cdn_empresa

Código da empresa do funcionário

Entrada

v_cdn_estab

Código do estabelecimento do funcionário

Entrada

v_cdn_funcionario

Código da matrícula do funcionário

Entrada

v_cdn_turno_trab

Código do turno do funcionário

Entrada

v_cdn_categ_sal

Código da categoria salarial do funcionário

Entrada

v_log_sal_categ

Campo lógico informando se a empresa irá considerar a categoria salarial do funcionário no momento de verificar a remuneração deste

Entrada

v_val_remun

Valor total da remuneração calculada pela API

Saída