Histórico da Página

Documento de API

Produto:	Datasul
Ocorrência:	Documentação de API
Nome Físico	prgfin/acr/acr367za

Objetivo

Retornar a movimentação de comissões e seus relacionamentos atrelados a determinado processo de integração.

Funcionamento

Executar o programa API(utilizar o nome externo), da seguinte forma:

def var v_hdl_aux as handle no-undo.

run prgfin\acr\acr367za.py persistent set v_hdl_aux.

run pi_main_code_movto_comis_repres_proces IN v_hdl_aux (Input table tt_param_api_proces_comis,

Input table tt_params_generic_api,

output table tt_rpt_movto_comis_repr_proces,

output table tt_rpt_movto_comis_proces_un,

output table tt_rpt_titan_apb_mov_ger,

output table tt_rpt_tit_apb_gerados,

output table tt_log_erros_process_comis).

delete procedure v_hdl_aux.

Parâmetros da API

tt_param_api_proces_comis: conterá os parâmetros para que seja efetuada a busca da movimentação;

tt_params_generic_api: conterá campos novos das temp-tables passadas como parâmetro.

tt_rpt_movto_comis_repr_proces : conterá os movimentos de comissões retornados da busca;

tt_rpt_movto_comis_proces_un : conterá os movimentos de comissões quebrados por unidade de negócio retornados da busca;

tt_rpt_titan_apb_mov_ger : conterá os títulos do Contas a Pagar movimentados e as antecipações geradas por movimentos de comissões retornados da busca;

tt_rpt_tit_apb_gerados: conterá os dados dos títulos do Contas a Pagar gerados na integração desse processo;

tt_log_erros_process_comis: conterá os erros ocorridos durante a busca.

Tabelas temporárias

Tabela Temporária	Descrição	Entrada/Saída
tt_param_api_proces_comis	Conterá os parâmetros para que seja efetuada a busca da movimentação.	Entrada

(*)Os estabelecimentos deverão estar separados por “,” Ex: 1,2,3,4...

Atributo	Tipo	Formato	Descrição	Obrig.	Evol.
ttv_des_estab_select	character	x(2000)	Estabelecimentos	SIM
ttv_cod_grp_repres_ini	character	x(4)	Grupo Representante inicial	SIM
ttv_cod_grp_repres_fim	character	x(4)	Grupo Representante final	SIM
ttv_cdn_repres_ini	Integer	>>>,>>9	Representante inicial	SIM
ttv_cdn_repres_fim	Integer	>>>,>>9	Representante final	SIM
ttv_num_process_inicial	Integer	>>>>,>>9	Número Processo Inicial	SIM
ttv_num_process_final	Integer	>>>>,>>9	Número Processo Final	SIM
ttv_dat_gerac_inicial	date	99/99/9999	Data Geração Processo Inicial	SIM
ttv_dat_gerac_fim	date	99/99/9999	Data Geração Processo Final	SIM
ttv_log_tip_movto_comis_re	logical	Sim/Não	Indica que serão buscados os movimentos do tipo “Realizado”	SIM
ttv_log_tip_movto_comis_no_re	logical	Sim/Não	Indica que serão buscados os movimentos do tipo “Não Realizado”	SIM
ttv_log_histor_comis_unid_negoc	logical	Sim/Não	Indica que será retornada a tabela com a quebra por Unidade de negócio	SIM
ttv_ind_func_auton	character	X(08)	Indica o tipo de representante a considerar na busca, podendo ser: “Funcionário”, “Autônomo” ou “Todos”.	SIM
ttv_ind_orig_movto_comis_2	character	X(08)	Indica a origem do movimento de comissão a considerar na busca, podendo ser: “Sistema”, “Usuário” ou “Todas”.	SIM

def temp-table tt_param_api_proces_comis no-undo

field ttv_des_estab_select as character format "x(2000)" label "Selecionados" column-label "Selecionados"

field ttv_cod_grp_repres_ini as character format "x(4)" label "Grupo Representante" column-label "Grupo Representante"

field ttv_cod_grp_repres_fim as character format "x(4)" label "Grupo Representante" column-label "Grupo Representante"

field ttv_cdn_repres_ini as Integer format ">>>,>>9" initial 0 label "Representante" column-label "Representante"

field ttv_cdn_repres_fim as Integer format ">>>,>>9" initial 0 label "até" column-label "Repres Final"

field ttv_num_process_inicial as integer format ">>>>,>>9" initial 0 label "Número do Processo"

field ttv_num_process_final as integer format ">>>>,>>9" initial 9999999 label "até"

field ttv_dat_gerac_inicial as date format "99/99/9999" label "Data Geração Inicial" column-label "Data Geração Inicial"

field ttv_dat_gerac_fim as date format "99/99/9999" initial 12/31/9999 label "até"

field ttv_log_tip_movto_comis_re as logical format "Sim/Não" initial no

field ttv_log_tip_movto_comis_no_re as logical format "Sim/Não" initial no

field ttv_log_histor_comis_unid_negoc as logical format "Sim/Não" initial no

field ttv_ind_func_auton as character format "X(08)" initial "Todos" label "Tipo Repres."

field ttv_ind_orig_movto_comis_2 as character format "X(08)" initial "Todas" label "Origem Movimento" column-label "Origem Movimento"

.

Tabela Temporária		Descrição					Entrada/Saída
tt_params_generic_api		Conterá campos novos das temp-tables passadas como parâmetro.					Entrada
Atributo	Tipo		Formato	Descrição	Obrig.	Evol.
ttv_rec_id	recid		>>>>>>9
ttv_cod_tabela	character		X(28)	Tabela
ttv_cod_campo	character		X(25)	Campo
ttv_cod_valor	character		X(8)	Valor

def temp-table tt_params_generic_api no-undo

field ttv_rec_id as recid format ">>>>>>9"

field ttv_cod_tabela as character format "x(28)" label "Tabela" column-label "Tabela"

field ttv_cod_campo as character format "x(35)" label "Campo" column-label "Campo"

field ttv_cod_valor as character format "x(8)" label "Valor" column-label "Valor"

index tt_idx_param_generic is primary unique

ttv_cod_tabela ascending

ttv_rec_id ascending

ttv_cod_campo ascending

.

Tabela Temporária	Descrição	Entrada/Saída
tt_rpt_movto_comis_repr_proces	Conterá os movimentos de comissões retornados da busca.	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 com 5, a partir de maio/2011.

Atributo	Tipo	Formato	Descrição	Obrig.	Evol.
ttv_rec_movto_comis_repres	recid	>>>>>>9	Recid da tabela de movimento de comissão
tta_cod_empresa	character	x(3)	Empresa
tta_cdn_repres	Integer	>>>,>>9	Representante
tta_num_seq_movto_comis	Character	x(8)	Sequência do Movimento
tta_cod_indic_econ	Integer	>>>,>>9	Indicador econômico \ moeda
tta_num_proces_integr_comis	Integer	>>>>,>>9	Número Processo
tta_cdn_fornecedor	Integer	>>>,>>>,>>9	Fornecedor
tta_nom_pessoa	Character	x(40)	Nome Pessoa
tta_cod_estab	Character	x(5)	Estabelecimento
tta_cod_espec_docto	Character	x(3)	Espécie
tta_cod_ser_docto	Character	x(5)	Série
tta_cod_tit_acr	Character	x(16)	Código do Título
tta_cod_parcela	Character	x(2)	Parcela
tta_nom_abrev	Character	x(15)	Nome Abreviado
tta_dat_emis_docto	Date	99/99/9999	Data Emissão
tta_dat_vencto_tit_acr	Date	99/99/9999	Data Vencimento
ttv_dat_comis	Date	99/99/9999	Data Comissão
ttv_ind_orig_movto_comis_abrev	Character	X(02)	Origem Movimento Comissão Abreviado
tta_val_base_calc_comis	Decimal	>>>,>>>,>>9.99	Base de cálculo
ttv_val_perc_comis	Decimal	>>9.9999	Percentual Comissão
tta_val_movto_comis	Decimal	->>,>>>,>>>,>>9.99	Valor do movimento
ttv_val_movto_comis_impto	Decimal	->>,>>>,>>>,>>9.99	Valor do imposto
ttv_ind_natur_lancto	Character	X(02)	Natureza
ttv_ind_tip_movto_financ	Character	X(02)	Tipo de Movimento
ttv_log_movto_comis_envdo	Logical	Sim/Não	Comissão Enviada
ttv_cdn_motiv_movto_comis	Integer	>>>9	Motivo de Movimento
ttv_ind_tip_comis_ext	Character	X(15)	Tipo de Comissão
tta_ind_trans_comis	Character	X(40)	Transação Comissão
ttv_log_db_mes	Logical	Sim/Não	Débito do mês
tta_num_id_movto_tit_acr	Integer	999999999	ID do movimento ACR
tta_ind_trans_acr	Character	X(29)	Transação do movimento ACR
tta_dat_gerac_proces	Date	99/99/9999	Data de Geração do Processo
tta_cod_grp_repres	Character	X(4)	Grupo Representante
ttv_cod_unid_negoc	Character	X(3)	Unidade de Negócio

def temp-table tt_rpt_movto_comis_repr_proces no-undo

field ttv_rec_movto_comis_repres as recid format ">>>>>>9" initial ?

field tta_cod_empresa as character format "x(3)" label "Empresa" column-label "Empresa"

field tta_cdn_repres as Integer format ">>>,>>9" initial 0 label "Representante" column-label "Representante"

field tta_num_seq_movto_comis as integer format ">>>>,>>9" initial 0 label "Sequência" column-label "Sequência"

field tta_cod_indic_econ as character format "x(8)" label "Moeda" column-label "Moeda"

field tta_num_proces_integr_comis as integer format ">>>>,>>9" initial 0 label "Nro Proces Integr" column-label "Nro Proces Integr"

field tta_cdn_fornecedor as Integer format ">>>,>>>,>>9" initial 0 label "Fornecedor" column-label "Fornecedor"

field tta_nom_pessoa as character format "x(40)" label "Nome" column-label "Nome"

&IF "{&emsfin_version}" >= "" AND "{&emsfin_version}" < "5.07A" &THEN

field tta_cod_estab as character format "x(3)" label "Estabelecimento" column-label "Estab"

&ENDIF

&IF "{&emsfin_version}" >= "5.07A" AND "{&emsfin_version}" < "9.99" &THEN

field tta_cod_estab as Character format "x(5)" label "Estabelecimento" column-label "Estab"

&ENDIF

field tta_cod_espec_docto as character format "x(3)" label "Espécie Documento" column-label "Espécie"

&IF "{&emsfin_version}" >= "" AND "{&emsfin_version}" < "5.06" &THEN

field tta_cod_ser_docto as character format "x(3)" label "Série Documento" column-label "Série"

&ENDIF

&IF "{&emsfin_version}" >= "5.06" AND "{&emsfin_version}" < "9.99" &THEN

field tta_cod_ser_docto as character format "x(5)" label "Série Documento" column-label "Série"

&ENDIF

&IF "{&emsfin_version}" >= "" AND "{&emsfin_version}" < "5.06" &THEN

field tta_cod_tit_acr as character format "x(10)" label "Título" column-label "Título"

&ENDIF

&IF "{&emsfin_version}" >= "5.06" AND "{&emsfin_version}" < "9.99" &THEN

field tta_cod_tit_acr as character format "x(16)" label "Título" column-label "Título"

&ENDIF

field tta_cod_parcela as character format "x(02)" label "Parcela" column-label "Parcela"

field tta_nom_abrev as character format "x(15)" label "Nome Abreviado" column-label "Nome Abreviado"

field tta_dat_emis_docto as date format "99/99/9999" initial today label "Data Emissão" column-label "Dt Emissão"

field tta_dat_vencto_tit_acr as date format "99/99/9999" initial ? label "Vencimento" column-label "Vencimento"

field ttv_dat_comis as date format "99/99/9999" label "Data Comissão" column-label "Data Comissão"

field ttv_ind_orig_movto_comis_abrev as character format "X(02)" label "Origem Comissão" column-label "Origem"

field tta_val_base_calc_comis as decimal format ">>>,>>>,>>9.99" decimals 2 initial 0 label "Base Calc Comis" column-label "Base Calc Comis"

field ttv_val_perc_comis as decimal format ">>9.9999" decimals 4 label "Percentual Comissão" column-label "Percentual Comissão"

field tta_val_movto_comis as decimal format "->>,>>>,>>>,>>9.99" decimals 2 initial 0 label "Valor Movimento" column-label "Valor Movimento"

field ttv_val_movto_comis_impto as decimal format "->>,>>>,>>>,>>9.99" decimals 2

field ttv_ind_natur_lancto as character format "X(02)" label "Natureza Lançamento" column-label "Natureza Lançamento"

field ttv_ind_tip_movto_financ as character format "X(02)" label "Tipo Movimento" column-label "Tipo Movimento"

field ttv_log_movto_comis_envdo as logical format "Sim/Não" initial no label "Integrado" column-label "Integrado"

field ttv_cdn_motiv_movto_comis as Integer format ">>>9" label "Código Motiv Movto" column-label "Código Motiv Movto"

field ttv_ind_tip_comis_ext as character format "X(15)" initial "Nenhum" label "Tipo de Comissão" column-label "Tipo de Comissão"

field tta_ind_trans_comis as character format "X(40)" label "Transação Comissão" column-label "Transação Comissão"

field ttv_log_db_mes as logical format "Sim/Não" initial no

field tta_num_id_movto_tit_acr as integer format "999999999" initial 0 label "Token Movto Tit ACR" column-label "Token Movto Tit ACR"

field tta_ind_trans_acr as character format "X(29)" initial "Implantação" label "Transação" column-label "Transação"

field tta_dat_gerac_proces as date format "99/99/9999" initial ? label "Data Geração" column-label "Data Geração"

field tta_cod_grp_repres as character format "x(4)" label "Grupo Repres" column-label "Grupo Repres"

field ttv_cod_dwb_field_rpt as character extent 13 format "x(32)" label "Conjunto" column-label "Conjunto"

field ttv_cod_unid_negoc as character format "x(3)" label "Unid Negócio" column-label "Un Neg"

index tt_idx_movto_comis is primary unique

tta_cod_empresa ascending

tta_cdn_repres ascending

tta_num_seq_movto_comis ascending

index tt_idx_movto_un

tta_cod_empresa ascending

tta_cdn_repres ascending

tta_num_seq_movto_comis ascending

ttv_cod_unid_negoc ascending

index tt_idx_proces

tta_cod_empresa ascending

tta_cdn_repres ascending

tta_cod_indic_econ ascending

tta_num_proces_integr_comis ascending

index tt_idx_titacr

tta_cod_estab ascending

tta_cod_espec_docto ascending

tta_cod_ser_docto ascending

tta_cod_tit_acr ascending

tta_cod_parcela ascending

.

Tabela Temporária	Descrição	Entrada/Saída
tt_rpt_movto_comis_proces_un	Conterá os movimentos de comissões quebrados por unidade de negócio retornados da busca.	Saída

Atributo	Tipo	Formato	Descrição	Obrig.	Evol.
ttv_rec_movto_comis_repres	recid	>>>>>>9	Recid da tabela de movimento de comissão
tta_cod_empresa	character	x(3)	Empresa
tta_cdn_repres	Integer	>>>,>>9	Representante
tta_num_seq_movto_comis	integer	>>>>,>>9	Sequência do Movimento
tta_cod_indic_econ	character	x(8)	Indicador econômico \ moeda
tta_num_proces_integr_comis	integer	>>>>,>>9	Número Processo
tta_dat_emis_docto	date	99/99/9999	Data Emissão
tta_dat_vencto_tit_acr	date	99/99/9999	Data Vencimento
ttv_dat_comis	date	99/99/9999	Data Comissão
ttv_ind_orig_movto_comis_abrev	character	X(02)	Origem Movimento Comissão Abreviado
tta_val_base_calc_comis	decimal	>>>,>>>,>>9.99	Base Cálculo
ttv_val_perc_comis	decimal	>>9.9999	Percentual Comissão
tta_val_movto_comis	decimal	->>,>>>,>>>,>>9.99	Valor do movimento
ttv_ind_natur_lancto	character	X(02)	Natureza
ttv_ind_tip_movto_financ	character	X(02)	Tipo de Movimento
ttv_log_movto_comis_envdo	logical	Sim/Não	Comissão Enviada
ttv_cdn_motiv_movto_comis	Integer	>>>9	Motivo de Movimento
ttv_ind_tip_comis_ext	character	X(15)	Tipo de Comissão
tta_ind_trans_comis	character	X(40)	Transação Comissão
tta_num_id_movto_tit_acr	integer	999999999	ID do movimento ACR
tta_ind_trans_acr	character	X(29)	Transação do movimento ACR
tta_dat_gerac_proces	date form	99/99/9999	Data de Geração do Processo
tta_cod_grp_repres	character	x(4)	Grupo Representante
ttv_cod_unid_negoc	character	x(3)	Unida de Negócio
ttv_val_tot_comis_control	decimal	->>,>>>,>>>,>>9.99	Valor total de comissão

def temp-table tt_rpt_movto_comis_proces_un no-undo