Documento de API
Produto: | Datasul |
Ocorrência: | Documentação de API |
| Nome Físico | prgfin/acr/acr262za |
Objetivo
Retorna os movimentos de liquidações de títulos por período, a apropriação contábil e o título original relacionado a cada movimento.
Parâmetros Entrada
Tabela temporária: tt_param_api_con_liquid_Acr
Parâmetros Saída
Tabelas temporárias:
- tt_tit_acr_liquid_un: movimentos de liquidação por período e unidade de negócio
- tt_param_relacto_tit_acr: títulos relacionados.
- tt_aprop_ctbl_acr: apropriação contábil por movimento
- tt_erro_msg: mensagens de erro.
Funcionamento
A sintaxe para executar a API/BO em modo persistente é:
run prgfin/acr/acr262za.r persistent set v_handle_acr262za.
run pi_main_con_movtos_liquid_period_2 in v_handle_acr262za (Input 1,
INPUT TABLE tt_param_api_con_liquid_Acr,
OUTPUT TABLE tt_tit_acr_liquid_un,
OUTPUT TABLE tt_param_relacto_tit_acr,
OUTPUT TABLE tt_aprop_ctbl_acr,
OUTPUT TABLE tt_erro_msg) .
Utilizar o procedimento principal para execução da api, pi_main_con_movtos_liquid_period_2.
Tabelas Temporárias
Tabela Temporária | Descrição | Entrada/Saída |
tt_param_api_con_liquid_Acr | Parâmetros se seleção para a consulta de movimentos de liquidação por período | Entrada |
Atributo | Tipo | Formato | Descrição | Obrig. | Evol. |
ttv_cod_estab_ini | Character | x(5) | Estabelecimento inicial | Sim | |
ttv_cod_estab_fim | Character | x(5) | Estabelecimento final | Sim | |
| ttv_cod_espec_docto_ini | Character | x(3) | Código Espécie Inicial | Sim | |
| ttv_cod_espec_docto_fim | Character | x(3) | Código Espécie Final | Sim | |
| ttv_cdn_cliente_ini | Integer | >>>,>>>,>>9 | Cliente inicial | Sim | |
| ttv_cdn_cliente_fim | Integer | >>>,>>>,>>9 | Cliente final | Sim | |
| ttv_cod_indic_econ_ini | Character | x(8) | Moeda Inicial | Sim | |
| ttv_cod_indic_econ_fim | Character | x(8) | Moeda Final | Sim | |
| ttv_cod_portador_ini | Character | x(5) | Portador Inicial | Sim | |
| ttv_cod_portador_fim | Character | x(5) | Portador Final | Sim | |
| ttv_dat_transacao_ini | Date | 99/99/9999 | Data Transação inicial | Sim | |
| ttv_dat_transacao_fim | Date | 99/99/9999 | Data transação final | Sim | |
| ttv_dat_liquidac_ini | Date | 99/99/9999 | Data Liquidação inicial | Sim | |
| ttv_dat_liquidac_fim | Date | 99/99/9999 | Data Liquidação final | Sim | |
| ttv_cod_proces_export_ini | Character | x(12) | Processo Exportação | sim | |
| ttv_cod_proces_export_fim | Character | x(12) | Processo Exportação | sim | |
| ttv_log_mostra_liquidac_pagto | Logical | yes/no | Liquidação c/ Pagto | sim | |
| ttv_log_mostra_liquidac_antecip | Logical | yes/no | Liquidação contra AN | sim | |
| ttv_log_mostra_liquidac_estorn | Logical | yes/no | Liquid. Estornadas | Sim | |
| ttv_cod_finalid_econ | Character | x(10) | Finalidade Econômica | sim | |
| ttv_dat_cotac_indic_econ | Date | 99/99/9999 | Data Cotação | sim | |
| ttv_log_mostra_normal | Logical | yes/no | Mostra título normal | sim | |
| ttv_log_mostra_antecip | Logical | yes/no | Mostra título Antecipação | sim | |
| ttv_log_mostra_prev | Logical | yes/no | Mostra Previsão | sim | |
| ttv_log_mostra_ndebito | Logical | yes/no | Mostra nota de débito | sim | |
| ttv_log_mostra_cheq | Logical | yes/no | Mostra título de cheque | sim | |
| ttv_log_mostra_aviso_db | Logical | yes/no | Mostra Aviso de débito | sim | |
| ttv_log_mostra_docto_vendor | Logical | yes/no | Vendor | sim | |
| ttv_log_mostra_liquidac | Logical | yes/no | Liquidação | sim | |
| ttv_log_mostra_liquidac_renegoc | Logical | yes/no | Renegociação | sim | |
| ttv_log_mostra_liq_enctro_cta | Logical | yes/no | Liquidação encontro de contas | sim | |
| ttv_log_mostra_perda_dedut | Logical | yes/no | Perda dedutível | sim | |
| ttv_log_mostra_transf_estab | Logical | yes/no | Transferência Estabelecimento | sim | |
| ttv_log_mostra_acerto_val_cr | Logical | yes/no | Acerto Valor a CR | sim | |
| ttv_log_mostra_acerto_val_menor | Logical | yes/no | Acerto Valor a Menor | sim | |
| ttv_log_mostra_devol | Logical | yes/no | Devolução | sim | |
| ttv_log_mostra_cta_ctbl | Logical | yes/no | Mostra Contas | sim | |
| ttv_ind_visualiz_tit_acr_vert | character | x(20) | Visualiza Título | sim | |
| ttv_ind_classif_tit_acr | Character | x(8) | Classificação título | sim | |
| ttv_cod_finalid_econ_apres | Character | x(10) | Finalidade econômica apresentação | sim | |
| ttv_log_mostra_tit_relac | Logical | yes/no | Mostra título relacionado | sim | |
| ttv_log_mostra_ctbzdo | Logical | yes/no | Mostra movimento contabilizado | sim |
def temp-table tt_param_api_con_liquid_Acr no-undo
field ttv_cod_estab_ini as character format "x(5)" label "Estabelecimento" column-label "Estab Inicial"
field ttv_cod_estab_fim as character format "x(5)" label "até" column-label "Estab Final"
field ttv_cod_espec_inic as character format "x(3)" label "Espécie Inicial"
field ttv_cod_espec_fim as character format "x(3)" label "até"
field ttv_cdn_cliente_ini as Integer format ">>>,>>>,>>9" initial 0 label "Cliente" column-label "Cliente Inicial"
field ttv_cdn_cliente_fim as Integer format ">>>,>>>,>>9" initial 0 label "até" column-label "Cliente Final"
field ttv_cod_indic_econ_ini as character format "x(8)" label "Moeda" column-label "Inicial"
field ttv_cod_indic_econ_fim as character format "x(8)" label "até" column-label "Final"
field ttv_cod_portador_ini as character format "x(5)" label "Portador" column-label "Portador Inicial"
field ttv_cod_portador_fim as character format "x(5)" label "até" column-label "Portador Final"
field ttv_dat_transacao_ini as date format "99/99/9999" initial today label "Data Transação" column-label "Data Transação"
field ttv_dat_transacao_fim as date format "99/99/9999" initial today label "até" column-label "Final"
field ttv_dat_liquidac_inic as date format "99/99/9999" label "Data de Liquidação" column-label "Liquidação"
field ttv_dat_liquidac_fim as date format "99/99/9999" label "até"
field ttv_cod_proces_export_ini as character format "x(12)" label "Processo Exportação" column-label "Proc Exp Inicial"
field ttv_cod_proces_export_fim as character format "x(12)" label "até" column-label "Proc Exp Final"
field ttv_log_mostra_liquidac_pagto as logical format "Sim/Não" initial no label "Liquidação c/ Pagto"
field ttv_log_mostra_liquidac_antecip as logical format "Sim/Não" initial no label "Liquidação contra AN"
field ttv_log_mostra_liquidac_estorn as logical format "Sim/Não" initial no label "Liquid. Estornadas"
field ttv_cod_finalid_econ as character format "x(10)" label "Finalidade Econômica" column-label "Finalidade Econômica"
field ttv_dat_cotac_indic_econ as date format "99/99/9999" initial today label "Data Cotação" column-label "Data Cotação"
field ttv_log_mostra_normal as logical format "Sim/Não" initial yes label "Normal"
field ttv_log_mostra_antecip as logical format "Sim/Não" initial no label "Antecipação" column-label "Antecipação"
field ttv_log_mostra_prev as logical format "Sim/Não" initial no label "Previsão"
field ttv_log_mostra_ndebito as logical format "Sim/Não" initial no label "Nota de Débito"
field ttv_log_mostra_cheq as logical format "Sim/Não" initial yes label "Cheque" column-label "Cheque"
field ttv_log_mostra_aviso_db as logical format "Sim/Não" initial yes label "Aviso Débito" column-label "Aviso Débito"
field ttv_log_mostra_docto_vendor as logical format "Sim/Não" initial yes label "Vendor" column-label "Vendor"
field ttv_log_mostra_liquidac as logical format "Sim/Não" initial yes label "Liquidação"
field ttv_log_mostra_liquidac_renegoc as logical format "Sim/Não" initial no label "Liquid Renegociação"
field ttv_log_mostra_liq_enctro_cta as logical format "Sim/Não" initial yes label "Liq Encontro Ctas" column-label "Liq Encontro Ctas"
field ttv_log_mostra_perda_dedut as logical format "Sim/Não" initial no label "Liquid Perda Dedut" column-label "Liquid Perda Dedut"
field ttv_log_mostra_transf_estab as logical format "Sim/Não" initial no label "Transf Estabelec"
field ttv_log_mostra_acerto_val_cr as logical format "Sim/Não" initial no label "Acerto Valor a CR"
field ttv_log_mostra_acerto_val_menor as logical format "Sim/Não" initial no label "Acerto Valor a Menor"
field ttv_log_mostra_devol as logical format "Sim/Não" initial no label "Devolução"
field ttv_log_mostra_cta_ctbl as logical format "Sim/Não" initial yes label "Mostra Contas"
field ttv_ind_visualiz_tit_acr_vert as character format "X(20)" initial "Por Estabelecimento" label "Visualiza Título" column-label "Visualiza Título"
field ttv_ind_classif_tit_acr as character format "X(08)"
field ttv_cod_finalid_econ_apres as character format "x(10)" initial "Corrente" label "Finalid Apresentação" column-label "Finalid Apresentação"
field ttv_log_mostra_tit_relac as logical format "Sim/Não" initial yes label "Título relacionado"
field ttv_log_mostra_ctbzdo as logical format "Sim/Não" initial no.
Tabela Temporária | Descrição | Entrada/Saída |
tt_tit_acr_liquid_un | Movimentos de liquidação por Periodo e unidade de negócio | Saída |
Atributo | Tipo | Formato | Descrição | Obrig. | Evol. |
| tta_cod_empresa | Character | x(3) | Empresa | Sim | |
| tta_cod_estab | Character | x(5) | Estabelecimento | Sim | |
| tta_cod_ser_docto | Character | x(5) | Série documento | Sim | |
| tta_cod_tit_acr | Character | x(16) | Título | Sim | |
| tta_cod_espec_docto | Character | x(3) | Espécie Documento | Sim | |
| tta_cod_parcela | Character | x(02) | Parcela | Sim | |
| tta_cdn_cliente | Integer | >>>,>>>,>>9 | Cliente | Sim | |
| tta_ind_trans_acr_abrev | Character | x(04) | Trans Abrev | Sim | |
| tta_log_movto_estordo | Logical | Yes/No | Movimento estornado | Sim | |
| tta_log_liquidac_contra_antecip | Logical | yes/no | Liquidação contra AN | Sim | |
| tta_val_movto_tit_acr | Decimal | ->>>,>>>,>>9.99 | Valor Movimento | Sim | |
| tta_dat_transacao | Date | 99/99/9999 | Data Transação | Sim | |
| tta_dat_cr_movto_tit_acr | Date | 99/99/9999 | Crédito | Sim | |
| ttv_row_movto_tit_acr | Rowid | Rowid Movimento | Sim | ||
| tta_num_id_movto_tit_acr | Integer | "999999999" | Token Movto Tit ACR | Sim | |
| tta_nom_abrev | Character | x(15) | Nome Abreviado | Sim | |
| tta_nom_pessoa | Character | x(40) | Nome | Sim | |
| tta_cod_indic_econ | Character | x(8) | Moeda | Sim | |
| tta_ind_espec_docto | Character | x(8) | Espécie Documento | Sim | |
| tta_dat_liquidac_tit_acr | Date | 99/99/9999 | Liquidação | Sim | |
| tta_dat_vencto_tit_acr | Date | 99/99/9999 | Data de vencimento | Sim | |
| tta_val_desconto | decimal | ->>>,>>>,>>9.99 | Valor de desconto | Sim | |
| tta_val_abat_tit_acr | Decimal | ->>>,>>>,>>9.99 | Valor abatimento | Sim | |
| tta_val_juros | Decimal | ->>>,>>>,>>9.99 | Valor Juros | Sim | |
| tta_val_multa_tit_acr | Decimal | ->>>,>>>,>>9.99 | Valor multa | Sim | |
| ttv_cod_proces_export | character | x(12) | Processo Exportação | Sim | |
| tta_cod_unid_negoc | Character | x(3) | Unidade Negócio | sim | |
| tta_cod_tip_fluxo_financ | Character | x(12) | Tipo Fluxo Financeiro | Sim | |
| tta_cod_finalid_econ | Character | x(10) | Finalidade econômica | Sim | |
| tta_num_id_tit_acr | Integer | 999999999 | Token Cta Receber | Sim |
def temp-table tt_tit_acr_liquid_un no-undo
field tta_cod_empresa as character format "x(3)" label "Empresa" column-label "Empresa"
field tta_cod_estab as Character format "x(5)" label "Estabelecimento" column-label "Estab"
field tta_cod_ser_docto as character format "x(5)" label "Série Documento" column-label "Série"
field tta_cod_tit_acr as character format "x(16)" label "Título" column-label "Título"
field tta_cod_espec_docto as character format "x(3)" label "Espécie Documento" column-label "Espécie"
field tta_cod_parcela as character format "x(02)" label "Parcela" column-label "Parcela"
field tta_cdn_cliente as Integer format ">>>,>>>,>>9" initial 0 label "Cliente" column-label "Cliente"
field tta_ind_trans_acr_abrev as character format "X(04)" label "Trans Abrev" column-label "Trans Abrev"
field tta_log_movto_estordo as logical format "Sim/Não" initial no label "Estornado" column-label "Estornado"
field tta_log_liquidac_contra_antecip as logical format "Sim/Não" initial no label "Liquidac AN" column-label "Liquidac AN"
field tta_val_movto_tit_acr as decimal format "->>>,>>>,>>9.99" decimals 2 initial 0 label "Vl Movimento" column-label "Vl Movimento"
field tta_dat_transacao as date format "99/99/9999" initial today label "Data Transação" column-label "Dat Transac"
field tta_dat_cr_movto_tit_acr as date format "99/99/9999" initial ? label "Crédito" column-label "Crédito"
field ttv_row_movto_tit_acr as Rowid
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_nom_abrev as character format "x(15)" label "Nome Abreviado" column-label "Nome Abreviado"
field tta_nom_pessoa as character format "x(40)" label "Nome" column-label "Nome"
field tta_cod_indic_econ as character format "x(8)" label "Moeda" column-label "Moeda"
field tta_ind_espec_docto as character format "X(08)" label "Espécie Documento" column-label "Espécie Documento"
field tta_dat_liquidac_tit_acr as date format "99/99/9999" initial ? label "Liquidação" column-label "Liquidação"
field tta_dat_vencto_tit_acr as date format "99/99/9999" initial ? label "Vencimento" column-label "Vencimento"
field tta_val_desconto as decimal format "->>>,>>>,>>9.99" decimals 2 initial 0 label "Valor Desconto" column-label "Valor Desconto"
field tta_val_abat_tit_acr as decimal format ">>>>,>>>,>>9.99" decimals 2 initial 0 label "Vl Abatimento" column-label "Vl Abatimento"
field tta_val_juros as decimal format ">>>>,>>>,>>9.99" decimals 2 initial 0 label "Valor Juros" column-label "Valor Juros"
field tta_val_multa_tit_acr as decimal format ">>>>,>>>,>>9.99" decimals 2 initial 0 label "Vl Multa" column-label "Vl Multa"
field ttv_cod_proces_export as character format "x(12)" label "Processo Exportação" column-label "Processo Exportação"
field tta_cod_unid_negoc as character format "x(3)" label "Unid Negócio" column-label "Un Neg"
field tta_cod_tip_fluxo_financ as character format "x(12)" label "Tipo Fluxo Financ" column-label "Tipo Fluxo Financ"
field tta_cod_finalid_econ as character format "x(10)" label "Finalidade" column-label "Finalidade"
field tta_num_id_tit_acr as integer format "999999999" initial 0 label "Token Cta Receber" column-label "Token Cta Receber"
index tt_estab_un
tta_cod_estab ascending
tta_cod_unid_negoc ascending
index tt_id is primary unique
tta_cod_estab ascending
tta_num_id_movto_tit_acr ascending
tta_cod_finalid_econ ascending
tta_cod_unid_negoc ascending
.
Tabela Temporária | Descrição | Entrada/Saída |
tt_aprop_ctbl_acr | Apropriação Contábil | Saída |
def temp-table tt_aprop_ctbl_acr no-undo like aprop_ctbl_acr
.
Tabela Temporária | Descrição | Entrada/Saída |
tt_param_relacto_tit_acr | Títulos relacionados | Saída |
Atributo | Tipo | Formato | Descrição | Obrig. | Evol. |
tta_val_relacto_tit_acr | Decimal | ->>>,>>>,>>9.99 | Valor relacionado | Sim | |
tta_dat_gerac_movto | Date | 99/99/9999 | Data geração movimento | Sim | |
tta_hra_gerac_movto | Character | 99:99:99 | Hora geração | Sim | |
| ttv_row_tit_acr | Rowid | Rowid do título | sim | ||
| tta_cod_estab_tit_acr_pai | character | x(5) | Estabelecimento título Pai | Sim | |
| tta_num_id_tit_acr_pai | Integer | 9999999999 | Token título pai | Sim |
def temp-table tt_param_relacto_tit_acr no-undo like tit_acr
field tta_val_relacto_tit_acr as decimal format "->>>,>>>,>>9.99" decimals 2 initial 0 label "Vl Relacto" column-label "Vl Relacto"
field tta_dat_gerac_movto as date format "99/99/9999" initial ? label "Data Geração Movto" column-label "Data Geração Movto"
field tta_hra_gerac_movto as Character format "99:99:99" label "Hora Geração Movto" column-label "Hora Geração Movto"
field ttv_row_tit_acr as Rowid
field tta_cod_estab_tit_acr_pai as character format "x(5)" label "Estab Tit Pai" column-label "Estab Tit Pai"
field tta_num_id_tit_acr_pai as integer format "9999999999" initial 0 label "Token" column-label "Token"
.
Tabela Temporária | Descrição | Entrada/Saída |
tt_erro_msg | Mensagens de erro | Saída |
Atributo | Tipo | Formato | Descrição | Obrig. | Evol. |
ttv_num_msg_erro | Integer | >>>>>>9 | Mensagem | Sim | |
ttv_des_msg_erro | Character | X(40) | Mensagem Erro | Sim | |
ttv_des_help_erro | Character | x(200) | Descrição Ajuda Erro | Sim |
def temp-table tt_erro_msg no-undo
field ttv_num_msg_erro as integer format ">>>>>>9" label "Mensagem" column-label "Mensagem"
field ttv_des_msg_erro as character format "x(60)" label "Mensagem Erro" column-label "Inconsistência"
field ttv_des_help_erro as character format "x(200)"
index tt_num_erro
ttv_num_msg_erro ascending
.
Exemplo de utilização da API
def var v_handle_acr262za as handle no-undo.
for each tt_tit_acr_liquid_un:
delete tt_tit_acr_liquid_un.
end.
for each tt_param_relacto_tit_acr:
delete tt_param_relacto_tit_acr.
end.
for each tt_aprop_ctbl_acr:
delete tt_aprop_ctbl_acr.
end.
create tt_param_api_con_liquid_Acr.
assign tt_param_api_con_liquid_Acr.ttv_cod_estab_ini = ''
tt_param_api_con_liquid_Acr.ttv_cod_estab_fim = 'ZZZZZ'
tt_param_api_con_liquid_Acr.ttv_cod_espec_inic = ''
tt_param_api_con_liquid_Acr.ttv_cod_espec_fim = 'ZZ'
tt_param_api_con_liquid_Acr.ttv_cdn_cliente_ini = 0
tt_param_api_con_liquid_Acr.ttv_cdn_cliente_fim = 99999999
tt_param_api_con_liquid_Acr.ttv_cod_indic_econ_ini = ''
tt_param_api_con_liquid_Acr.ttv_cod_indic_econ_fim = 'ZZZZZ'
tt_param_api_con_liquid_Acr.ttv_cod_portador_ini = ''
tt_param_api_con_liquid_Acr.ttv_cod_portador_fim = 'ZZZZZZZZZ'
tt_param_api_con_liquid_Acr.ttv_dat_transacao_ini = 03/01/2016
tt_param_api_con_liquid_Acr.ttv_dat_transacao_fim = 03/31/2016
tt_param_api_con_liquid_Acr.ttv_dat_liquidac_inic = 03/01/2016
tt_param_api_con_liquid_Acr.ttv_dat_liquidac_fim = 03/31/2016
tt_param_api_con_liquid_Acr.ttv_cod_proces_export_ini = ''
tt_param_api_con_liquid_Acr.ttv_cod_proces_export_fim = 'ZZZZZZZZZZZ'
tt_param_api_con_liquid_Acr.ttv_log_mostra_liquidac_pagto = yes
tt_param_api_con_liquid_Acr.ttv_log_mostra_liquidac_antecip = yes
tt_param_api_con_liquid_Acr.ttv_log_mostra_liquidac_estorn = no
tt_param_api_con_liquid_Acr.ttv_cod_finalid_econ = 'Corrente'
tt_param_api_con_liquid_Acr.ttv_dat_cotac_indic_econ = 08/26/2016
tt_param_api_con_liquid_Acr.ttv_log_mostra_normal = yes
tt_param_api_con_liquid_Acr.ttv_log_mostra_antecip = yes
tt_param_api_con_liquid_Acr.ttv_log_mostra_prev = no
tt_param_api_con_liquid_Acr.ttv_log_mostra_ndebito = no
tt_param_api_con_liquid_Acr.ttv_log_mostra_cheq = yes
tt_param_api_con_liquid_Acr.ttv_log_mostra_aviso_db = no
tt_param_api_con_liquid_Acr.ttv_log_mostra_docto_vendor = no
tt_param_api_con_liquid_Acr.ttv_log_mostra_liquidac = yes
tt_param_api_con_liquid_Acr.ttv_log_mostra_liquidac_renegoc = yes
tt_param_api_con_liquid_Acr.ttv_log_mostra_liq_enctro_cta = no
tt_param_api_con_liquid_Acr.ttv_log_mostra_perda_dedut = no
tt_param_api_con_liquid_Acr.ttv_log_mostra_transf_estab = yes
tt_param_api_con_liquid_Acr.ttv_log_mostra_acerto_val_cr = no
tt_param_api_con_liquid_Acr.ttv_log_mostra_acerto_val_menor = no
tt_param_api_con_liquid_Acr.ttv_log_mostra_devol = no
tt_param_api_con_liquid_Acr.ttv_log_mostra_cta_ctbl = yes
tt_param_api_con_liquid_Acr.ttv_ind_visualiz_tit_acr_vert = ''
tt_param_api_con_liquid_Acr.ttv_ind_classif_tit_acr = ''
tt_param_api_con_liquid_Acr.ttv_cod_finalid_econ_apres = 'corrente'
tt_param_api_con_liquid_Acr.ttv_log_mostra_tit_relac = no
tt_param_api_con_liquid_Acr.ttv_log_mostra_ctbzdo = no /*mostra apenas os movimentos cntabilizados */.
run prgfin/acr/acr262za.r persistent set v_handle_acr262za /* prg_fnc_recuperar_variaveis_globais*/.
if valid-handle(v_handle_acr262za) then do:
run pi_main_con_movtos_liquid_period_2 in v_handle_acr262za (Input 1,
Input table tt_param_api_con_liquid_Acr,
output table tt_tit_acr_liquid_un,
output table tt_param_relacto_tit_acr,
output table tt_aprop_ctbl_acr,
output table tt_erro_msg) /*pi_main_con_movtos_pagto_period_1*/.
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas