Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

Documento de API

Produto:

Datasul

Ocorrência:

Documentação de API

Nome Físicoprgfin/apb/apb767zf

 


Objetivo

Efetuar alteração dos títulos do Contas a Pagar.

 


Parâmetros de entrada

...


Parâmetro

Descrição

p_num_vers_integr_api

Será utilizado para determinar se o programa que está chamando está íntegro com as definições correntes da API.

p_cod_modulo

Conterá o módulo, será utilizado para verificar se o módulo é “APB”.

p_cod_matriz_trad_org_ext

Conterá o código da matriz de tradução da organização externa que tem por finalidade relacionar os códigos externos aos códigos presentes no Datasul-EMS5, caso a matriz de tradução não tiver sido informada, o parâmetro estará em branco.

p_log_estorn_comis

 


tt_tit_ap_alteracao_base_aux_3Conterá os dados dos títulos para alteração.
tt_tit_ap_alteracao_rateioConterá os dados dos rateios para alteração.
tt_params_generic_apiConterá campos novos das temp-tables passadas como parâmetro.
tt_log_erros_tit_ap_alteracaoConterá os dados dos erros apresentados na alteração

Funcionamento

Na forma padrão, realiza-se a chamada através de um comando RUN normal, passando-se as temp-tables carregadas com as informações necessárias.

...

run prgfin/apb/apb767zf.py persistent set v_hdl_aux.

 


run pi_main_code_api_integr_ap_alter_tit_ap_6 in v_hdl_aux (Input 1,

...

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_tit_ap_alteracao_base_aux_3

Conterá as informações dos títulos para alteração.

Entrada e Saída

 


(*) A partir da 5.07A o estabelecimento passa a ter cinco dígitos.

(**) Liberado o número de documento com 16 posições e série com5, apartir de maio/2011.

Atributo

Tipo

Formato

Descrição

Obrig.

Evol.

ttv_cod_usuar_corren

character

x(12)

Usuário Corrente

 

 



tta_cod_empresa

character

x(3)

Empresa

 

 



tta_cod_estab

character

x(3) / x(5)*

Estabelecimento

 

 



tta_num_id_tit_ap

integer

9999999999

Token Tit AP

 

 



ttv_rec_tit_ap

recid

>>>>>>9

Recid Título

 

 



tta_cdn_fornecedor

Integer

>>>,>>>,>>9

Fornecedor

 

 



tta_cod_espec_docto

character

x(3)

Espécie Documento

 

 



tta_cod_ser_docto

character

x(3)/x(5)**

Série Documento

 

 



tta_cod_tit_ap

character

x(10)/x(16)**

Título

 

 



tta_cod_parcela

character

x(02)

Parcela

 

 



ttv_dat_transacao

date

99/99/9999

Data Transação

 

 



ttv_cod_refer

character

x(10)

Referência

 

 



tta_val_sdo_tit_ap

decimal

->>>,>>>,>>9.99

Valor Saldo

 

 



tta_dat_emis_docto

date

99/99/9999

Data Emissão

 

 

tta



tta_dat_vencto_tit_ap

date

99/99/9999

Data Vencimento

 

 



tta_dat_prev_pagto

date

99/99/9999

Data Prevista Pgto

 

 



tta_dat_ult_pagto

date

99/99/9999

Data último Pagto

 

 



tta_num_dias_atraso

integer

>9

Dias Atraso

 

 



tta_val_perc_multa_atraso

decimal

>9.99

Perc Multa Atraso

 

 



tta_val_juros_dia_atraso

decimal

->>>,>>>,>>9.99

Valor Juro

 

 



tta_val_perc_juros_dia_atraso

decimal

>9.999999

Perc Jur Dia Atraso

 

 



tta_dat_desconto

date

99/99/9999

Data Desconto

 

 



tta_val_perc_desc

decimal

>9.9999

Percentual Desconto

 

 



tta_val_desconto

decimal

->>>,>>>,>>9.99

Valor Desconto

 

 



tta_cod_portador

character

x(5)

Portador

 

 



ttv_cod_portador_mov

character

x(5)

Portador Movto

 

 



tta_log_pagto_bloqdo

logical

Sim/NÃo

Bloqueia Pagamento

 

 



tta_cod_seguradora

character

x(8)

Seguradora

 

 



tta_cod_apol_seguro

character

x(12)

Apólice Seguro

 

 



tta_cod_arrendador

character

x(6)

Arrendador

 

 



tta_cod_contrat_leas

character

x(12)

Contrato Leasing

 

 



tta_ind_tip_espec_docto

character

X(17)

Tipo Espécie

 

 

tta



tta_cod_indic_econ

character

x(8)

Moeda

 

 



tta_num_seq_refer

integer

>>>9

Sequência

 

 



ttv_ind_motiv_alter_val_tit_ap

character

X(09)

Motivo Alteração

 

 



ttv_wgh_lista

widget-handle

>>>>>>9

 

 

 




ttv_log_gera_ocor_alter_valores

logical

Sim/NÃo

 

 

 




tta_cb4_tit_ap_bco_cobdor

Character

x(50)

Titulo Bco Cobrador

 

 



tta_cod_histor_padr

character

x(8)

Histórico Padrão

 

 



tta_des_histor_padr

character

x(40)

Descrição

 

 



tta_ind_sit_tit_ap

character

X(13)

Situação

 

 



tta_cod_forma_pagto

character

x(3)

Forma Pagamento

 

 



tta_cod_tit_ap_bco_cobdor

Character

x(20)

Título Banco Cobdor

 

 



tta_cod_estab_ext

Character

x(8)

Estabelecimento Ext

 

 



tta_num_ord_invest

Integer

>>>>,>>9

Ordem Investimento

 

 



ttv_num_ped_compra

Integer

>>>>>,>>9

Ped Compra

 

 



tta_num_ord_compra

integer

>>>>>9,99

Ordem Compra

 

 



ttv_num_event_invest

Integer

>,>>9

Evento Investimento

 

 



ttv_val_1099

Decimal

->>,>>>,>>>,>>9.99

Valor 1099

 

 

tta



tta_cod_tax_ident_number

Character

x(15)

Tax Id Number

 

 



tta_ind_tip_trans_1099

Character

X(50)

Tipo Transação 1099

 

 



ttv_log_atualiz_tit_impto_vinc

logical

Sim/Não

Atualiza Imposto Vinculado

 

 

 




def temp-table tt_tit_ap_alteracao_base_aux_3 no-undo

...

          tta_cod_parcela                  ascending

    .

 


Tabela Temporária

Descrição

Entrada/Saída

tt_tit_ap_alteracao_rateio

Conterá as informações dos rateios para os títulos alterados.

Entrada e Saída

...


(*) A partir da 5.07A o estabelecimento passa a ter cinco dígitos.

(**) Liberado o centro de custo com 20 posições, a partir de maio/2011.

Atributo

Tipo

Formato

Descrição

Obrig.

Evol.

ttv_rec_tit_ap

recid

>>>>>>9

 Recid Título

 

 



tta_cod_estab

character

x(3) / x(5)*

Estabelecimento

 

 



tta_cod_refer

character

x(10)

Referência

 

 



tta_num_seq_refer

integer

>>>9

Sequência

 

 



tta_cod_tip_fluxo_financ

character

x(12)

Tipo Fluxo Financ

 

 



tta_cod_plano_cta_ctbl

character

x(8)

Plano Contas

 

 



tta_cod_cta_ctbl

character

x(20)

Conta Contábil

 

 



tta_cod_unid_negoc

character

x(3)

Unid Negócio

 

 



tta_cod_plano_ccusto

character

x(8)

Plano Centros Custo

 

 



tta_cod_ccusto

Character

x(11)/x(20)**

Centro Custo

 

 



tta_val_aprop_ctbl

decimal

->>>,>>>,>>9.99

Valor Aprop Ctbl

 

 



ttv_ind_tip_rat

character

X(08)

 

 

 




tta_num_id_tit_ap

integer

1E+10

Token Tit AP

 

 



tta_num_id_aprop_ctbl_ap

integer

1E+10

Id Aprop Ctbl AP

 

 

 




def def temp-table tt_tit_ap_alteracao_rateio no-undo

...

          ttv_rec_tit_ap                   ascending

    .

 


Tabela Temporária

Descrição

Entrada/Saída

tt_log_erros_tit_ap_alteracao

Conterá as informações dos erros apresentados na alteração.

Saída

 


(*) A partir da 5.07A o estabelecimento passa a ter cinco dígitos.

(**) Liberado o número de documento com 16 posições e série com5, apartir de maio/2011.

Atributo

Tipo

Formato

Descrição

Obrig.

Evol.

tta_cod_estab

character

x(3) / x(5)*

Estabelecimento

 

 



tta_cdn_fornecedor

Integer

>>>,>>>,>>9

Fornecedor

 

 



tta_cod_espec_docto

character

x(3)

Espécie Documento

 

 



tta_cod_ser_docto

character

x(3)/x(5)**

Série Documento

 

 



tta_cod_tit_ap

character

x(10)/x(16)**

Título

 

 



tta_cod_parcela

character

x(02)

Parcela

 

 



tta_num_id_tit_ap

integer

9999999999

Token Tit AP

 

 



ttv_num_mensagem

integer

>>>>,>>9

Número

 

 



ttv_cod_tip_msg_dwb

character

x(12)

Tipo Mensagem

 

 



ttv_des_msg_erro

character

x(60)

Mensagem Erro

 

 



ttv_des_msg_ajuda_1

character

x(360)

 

 

 




ttv_wgh_focus

widget-handle

>>>>>>9

 

 

 

 





def temp-table tt_log_erros_tit_ap_alteracao no-undo

...

    field ttv_wgh_focus                    as widget-handle format ">>>>>>9"

    . 


Tabela Temporária

Descrição

Entrada/Saída

tt_params_generic_api

Conterá campos novos das temp-tables passadas como parâmetro.

Entrada / Saída

Atributo

Tipo

Formato

Descrição

Obrig.

Evol.

ttv_rec_id

recid

>>>>>>9

 

 

 




ttv_cod_tabela

character

X(28)

Tabela

 

 

ttv



ttv_cod_campo

character

X(25)

Campo

 

 



ttv_cod_valor

character

X(8)

Valor

 

 

 




def temp-table tt_params_generic_api no-undo

...

          ttv_cod_campo                    ascending

    .

 


Exemplo Criação temp-table tt_params_generic_api:

create tt_params_generic_api.
assign tt_params_generic_api.ttv_rec_id = tt_tit_ap_alteracao_base_aux_3.ttv_rec_tit_ap
           tt_params_generic_api.ttv_cod_tabela = "tt_tit_ap_alteracao_base_aux_3"
           tt_params_generic_api.ttv_cod_campo = "log_prestac_serv_auton"
           tt_params_generic_api.ttv_cod_valor = "no".


Mão-de-Obra ou Empreitada (REINF):

Caso o título seja do tipo Mão-de-Obra ou Empreitada será necessário informar o tipo de serviço prestado pelo mesmo para o REINF. Para cadastrar essas informações através da API será necessário que o título seja de espécie normal, origem APB (Contas a Pagar), o fornecedor do título esteja relacionado a um pessoa jurídica e possuir o tipo de fornecimento Serviços ou Produtos/Serviços.

create tt_params_generic_api.
assign tt_params_generic_api.ttv_rec_id = tt_tit_ap_alteracao_base_aux_3.ttv_rec_tit_ap
           tt_params_generic_api.ttv_cod_tabela = 'tt_tit_ap_alteracao_base_aux_3'
          tt_params_generic_api.ttv_cod_campo = 'log_mdo_emptda'
          tt_params_generic_api.ttv_cod_valor = 'yes'.

Abaixo exemplo dos 2 registros necessários.