Documento de API
Produto: | Datasul |
Ocorrência: | Documentação de API |
Nome Físico | prghur/fpp/fpapi031.p |
Objetivo
Realiza a exportação das categorias salariais.
Funcionamento
A API fpapi031 deve ser executada de forma persistente.
run prghur/fpp/fpapi031.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-HoursWork | Contém informações das jornadas de trabalho | 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 |
codePaymentCategory | Inteiro | 99 | Código da Categoria Salarial | Sim | 2.10 |
descriptionPaymentCategory | Caracter | X(15) | Descrição da Categoria Salarial | Sim | 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 piPaymentCategory
Requisito | Inexistente. | |
Sintaxe | run procedure piPaymentCategory in h-handle (output table tt-PaymentCategory, output table tt-erro). | |
Descrição | O método retornará o cadastro de categorias salariais. | |
| Parâmetros | Descrição |
| tt-PaymentCategory tt-erro | Temp-table com o cadastro de categorias salariais Erros do processo. |
Retorno | Temp-tables tt-erro e tt-PaymentCategory populadas. As mensagens possíveis para este método são: "Não existem categorias salariais cadastradas!" |
Método Negócio