Documento de API
Produto: | Datasul |
Ocorrência: | Documentação de API |
Nome Físico | prghur/fpp/fpapi082.p |
Objetivo
Retornar tabelas temporáreas contendo as informações que são necessárias para a impressão do Informe de Rendimentos para um determinado CPF.
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/fpapi082 persistent set h-handle.
run pi-informe-rendimentos in h-handle ( input v_cdn_empresa,
input v_cpf,
input v_ano_refer,
input v_idi_opcao_impr_despesas,
input v_rs_nome,
output table tt-irf,
output table tt-outros,
output table tt-inform-compl-medic,
output table tt-inform-compl-benef).
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-irf
Descrição do Campo | Campo | Formato |
Valor Pensão | Vlr-pensao | zzz,zzz,zz9.99 |
Valor INSS | Vlr-inss | zzz,zzz,zz9.99 |
Valor Previdência Privada | Vlr-prev | zzz,zzz,zz9.99 |
Valor Rendimento | Vlr-rend | zzz,zzz,zz9.99 |
Valor IRF | Vlr-irf | zzz,zzz,zz9.99 |
Valor Lucro | Val_lucro | zzz,zzz,zz9.99 |
Valor Custo | Vlr-custo | zzz,zzz,zz9.99 |
Valor Indenização | Vlr-indeniz | zzz,zzz,zz9.99 |
Valor Recebido | Vlr-receb | zzz,zzz,zz9.99 |
Valor Provisão | Vlr-prov | zzz,zzz,zz9.99 |
Valor Provisão Moléstia | Vlr-prov-molest | zzz,zzz,zz9.99 |
Valor Líquido | Vlr-liquido | zzz,zzz,zz9.99 |
Valor Rendimento 13 salario | Vlr-rend-13 | zzz,zzz,zz9.99 |
Código CPF/CNPJ | Cod-cpf-cgc | X(20) |
Nome Pessoa Jurídica | Nom-pessoa-jurid | X(40) |
Código CPF/CNPJ | Cod-cgc-declar | X(20) |
Código Estab Pagador | Cdn-pagadora | X(5) |
Nome Fonte | Nom-fonte | X(50) |
Temp table: tt-outros:
Descrição do Campo | Campo | Formato |
Código CFP/CNPJ | Cod-cpf-cgc | X(20) |
Outros | c-ev-Outros | X(45) |
Valor Outros | d-vlroutros-c | zz,zzz,zz9.99 |
Temp table: tt-inform-compl-medic:
Descrição do Campo | Campo | Formato |
Código CFP/CNPJ | Cod-cpf-cgc | X(20) |
Evento | Cdn-event-fp | X(3) |
Prestador | Cdn-prestdor | >>>.>>9 |
Nome Prestador | Nom-prestdor | X(40) |
Ident | Cod-ident |
|
Descrição Evento Assist Medica | c-evt-medica | X(55) |
Valor Evento Assit Medica | d-vl-medica | zzz,zzz,zz9.99 |
Sinal | c-sinal | X(01) |
Temp table: tt-inform-compl-benef:
Descrição do Campo | Campo | Formato |
Código CFP/CNPJ | Cod-cpf-cgc | X(20) |
Código Beneficiário | V_cdn_benefic | Z9 |
Nome Beneficiário | c-benefic | X(30) |
Valor Beneficiário | c-benefic-valor | zzz,zz9.99 |
Valor Beneficiário 13º. | c-benefic-valor-13 | zzz,zz9.99 |
Parâmetros utilizados pela API:
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
V_cdn_empresa | Char | X(03) | Empresa | sim | 2.12 |
V_cpf | Char | X(20) | CPF | sim | 2.12 |
V_ano_refer | Int | 9999 | Ano referência | sim | 2.12 |
V_idi_opcao_impres_despesas | Int | 9 | Tipo Opção Impressão Despesas | sim | 2.12 |
V_cdn_beneficio | Int | >>9 | Código Benefício | sim | 2.12 |
V_cdn_regra_benefic | Int | ZZ9 | Regra Benefício | sim | 2.12 |
V_idi_tip_regrac | Int | 9 | Tipo de Regra | sim | 2.12 |
V_rs_nome | Int | 9 | Tipo Nome | 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-informe-rendimentos
Método Básico
pi-informe-rendimentos – Retornar tabelas temporáreas contendo as informações que são necessárias para a impressão do Informe de Rendimentos para um determinado CPF.
Método Negócio
Não há método de negócio disponível nesta api.