Documento de API

Produto:

Datasul

Ocorrência:

Documentação de API

Nome Físicoprgfin/apb/apb547za


Objetivo

Retornar valores de imposto de renda de títulos com baixas por antecipações, cujas antecipações tiveram retenção de IR.


Parâmetros de Entrada

p_cod_estab:  Código do estabelecimento do título. Aceita o estabelecimento do recebimento ou do APB.
p_cdn_fornecedor:
Código do fornecedor.
p_cod_espec_docto:
Espécie do documento.
p_cod_ser_docto:
Série do documento.
p_cod_tit_ap:
Número do documento
p_cod_parcela:
Número da parcela.


Parâmetros de Saída

tt_compl_impto_retid_ap_an: Retorna as informações do título de antecipação utilizadas para baixar o título consultado, além do saldo de retenção de IR no título. OBS: Se não existir baixa por antecipação a tabela retornará vazia.

Funcionamento

A sintaxe para executar a API em modo persistente é:

RUN prgfin/apb/apb547za.py PERSISTENT SET v_handle.

RUN pi_dados_imp_renda_ap_an_reinf IN v_handle ( INPUT p_cod_estab    ,
                                                                                    INPUT  p_cdn_fornecedor ,
                                                                                    INPUT  p_cod_espec_docto  ,
                                                                                    INPUT p_cod_ser_docto   ,
                                                                                    INPUT p_cod_tit_ap ,
                                                                                    INPUT p_cod_parcela:       , 
                                                                                    OUTPUT TABLE tt_compl_impto_retid_ap_an ).


Atenção: Os campos da tabela temporária ttv_val_impto_indic_econ_dupl e ttv_val_rendto_tribut_dupl contém, respectivamente: o saldo de imposto de renda do título e o valor de saldo de rendimento tributável. O cálculo é realizado descontando o valor de IR já retido na antecipação.

Retorno: Tabela Temporária 


Tabela Temporária

Descrição

Entrada/Saída

tt_compl_impto_retid_ap_an

Conterá as informações referente a retenção de IR na antecipação.

Saída

Atributo

Tipo

Formato

Descrição

Obrig.

Evol.

cod_empresa

character

x(3) 

Empresa



cod_estabcharacterx(5)Estabelecimento

num_id_tit_apinteger999999999Token Tit AP 

cdn_fornec_favorecinteger>>>,>>>,>>9Fornec Favorecido 

cdn_fornecedorinteger>>>,>>>,>>9Fornecedor

cod_indic_econ_origcharacterx(8)Indicador Economico

val_rendto_tributinteger>,>>>,>>>,>>9.99Rendto Tributável 

val_aliq_imptointeger>9.9999Alíquota

val_impto_indic_econ_originteger->>>,>>>,>>9.99Val Impto Orig

cod_paischaracterx(3)País

cod_unid_federaccharacterx(3)Unidade Federação 

cod_impostocharacterx(5)Imposto

cod_classif_imptocharacterx(5)Class Imposto

num_id_tit_ap_paiinteger999999999Token

log_impto_vincul_anteciplogical
Impto Vincul Antecip

val_sdo_dispon_imptointeger->>>,>>>,>>9.99Sdo Disponível Impto

dat_vencto_tit_apdate
Data Vencimento

cod_indic_econ_imptocharacterx(8)Indicador Economico

num_id_movto_tit_ap_paiinteger999999999Tk Mv Tit Ap Pai

ind_clas_imptocharacterx(14)Classe Imposto

cod_estab_tit_ap_paicharacterx(5)Estab Tit Pai


log_dados_dirf_geradlogical
Gerou Dados Dirf

log_tit_ap_transfdological
Título Transferido

cod_livre_1characterx(100) Livre 1

log_livre_1logical
Livre 1

num_livre_1integer>>>>>9Livre 1

val_livre_1integer>>>,>>>,>>9.9999Livre 1

dat_livre_1date
Livre 1

cod_livre_2characterx(100)Livre 2


dat_livre_2date
Livre 2

log_livre_2logical
Livre 2

num_livre_2integer>>>>>9Livre 2

val_livre_2decimal>>>,>>>,>>9.9999Livre 2

val_base_liq_imptodecimal>,>>>,>>>,>>9.99 Base Líquida Imposto

val_eqpto_deduc_inssdecimal->>>,>>>,>>9.99 Val Equipto Ded INSS

val_alimen_deduc_inssdecimal->>>,>>>,>>9.99Val Aliment Ded INSS

val_transp_deduc_inssdecimal->>>,>>>,>>9.99Val Transp Ded INSS

ind_tip_proces_rendto_acumcharacterx(15)Tipo Proc Rendto Ac

cod_proces_rendto_acumcharacterx(20)Cod Processo Rendto

cod_natur_rendto_acumcharacterx(40)Natureza Rendto Acum

qtd_meses_rendto_acumdecimal>>>>9Qtd Meses Rend Acum

val_despes_procesdecimal->>>,>>>,>>9.99Val Despesa Processo

cod_process_judiccharacterx(21)Nr Processo Judicial

val_nao_retiddecimal>>>,>>>,>>>,>>9.99Valor não Retido

ttv_cod_estab_duplcharacterx(8)Estabelecimento do título Liquidado por antecipação

ttv_num_id_tit_ap_duplinteger9999999999Numero do título

ttv_val_impto_indic_econ_dupldecimal->>,>>>,>>>,>>9.99Valor saldo de imposto a reter no título

ttv_val_rendto_tribut_dupldecimal>>,>>>,>>>,>>9.99Valor saldo de rendimento tributável do título.

ttv_num_seq_imptointeger>>>>,>>9Sequencial


def temp-table tt_compl_impto_retid_ap_an no-undo like compl_impto_retid_ap
    field ttv_cod_estab_dupl                     as character format "x(8)" label "Estabelecimento" column-label "Estab"
    field ttv_num_id_tit_ap_dupl               as integer format "9999999999"
    field ttv_val_impto_indic_econ_dupl   as decimal format "->>,>>>,>>>,>>9.99" decimals 2
    field ttv_val_rendto_tribut_dupl          as decimal format ">>,>>>,>>>,>>9.99" decimals 2
    field ttv_num_seq_impto                    as integer format ">>>>,>>9"
    index tt_seq_impto                    
          cod_estab                        ascending
          num_id_tit_ap                  ascending
          ttv_num_seq_impto          ascending.