Documento de API
Produto: | Datasul |
Ocorrência: | Documentação de API |
| Nome Físico | Prgfin/apl/apl029zb |
Objetivo
Efetuar a correção de empréstimos no Sistema de Aplicações e Empréstimos.
Funcionamento
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 é:
run prgfin/apl/apl029zb.py (1,
input p_num_id_operac_financ,
input p_cod_banco,
input p_cod_produt_financ,
input p_cod_operac_financ,
input p_dat_fim_correc,
output table tt_log_erro,
output table tt_correcoes_efetuadas,
input p_log_correc_parcial ,
input p_ind_tip_tax_pos_fix,
input p_dat_movto).
Parâmetros
Parâmetro | Descrição |
Num_vers_integr_api | Será utilizado para determinar se o programa que está chamando está íntegro com as definições correntes da API. |
[ p_num_id_operac_financ ] | É o identificador da operação financeira. Caso sejam informados os campos: p_cod_banco, p_cod_produt_financ e p_cod_operac_financ, o mesmo poderá ser passado como zero. |
[ p_cod_banco ] | É o código do banco. Não será necessário informá-lo caso tenha sido informado o p_num_id_operac_financ. |
[ p_cod_produt_financ ] | É o código do produto financeiro. Não será necessário informá-lo caso tenha sido informado o p_num_id_operac_financ. |
[ p_cod_operac_financ ] | É o código da operação financeira. Não será necessário informá-lo caso tenha sido informado o p_num_id_operac_financ. |
p_dat_fim_correc | É data até a qual deverá ser efetuada a correção do empréstimo. |
tt_log_erro | Os retornos de erros encontrados durante o processo de criação serão gravados nesta tabela. |
tt_correcoes_efetuadas | Conterá as informações de erros na integração, é a temp-table que retorna os possíveis problemas na integração dos registros. |
p_log_correc_parcial | Indica se realiza correção parcial. Pode ser informado 'yes/no'. |
[p_ind_tip_tax_pos_fix] | Indica a data utilizada para correção, podendo ser informado: "Data Última Correção", "Projetado Data Próximo Aniversário" ou "Data Fim Correção" |
p_dat_movto | Permitir que operações com origem MEC e data fim de correção diferente da data de movimento calculem juros na liquidação dos contratos de câmbio ACC/ACE, respeitando a data de cálculo de juros informada, apropriando os juros na data de liquidação (data do movimento) dos títulos vinculados ao contrato. Caso não seja Origem MEC deverá ser passado para p_dat_movto a mesma data de fim de correção (p_dat_fim_correc). |
Retorno
A API retornará na tabela temporária tt_log_erro contendo todos os erros encontrados ou mensagens de alerta gerados durante o processo de correção do empréstimo no sistema de Aplicações e Empréstimos.
Observações: Quando a API for executada por um programa externo, logo após a chamada da API, deverá ser criado um tratamento para impressão dos erros. E para a correta visualização dos erros, todos os campos desta tabela devem ser impressos.
Atributos
Nos atributos das tabelas temporárias de entrada e saída, o nome de um atributo opcional aparece cercado por colchetes, como, por exemplo, [Atributo-op].
Tabela Temporária | Descrição | Entrada/Saída |
tt_log_erro | Conterá as informações de erros na integração, é a temp-table que retorna os possíveis problemas na integração dos registros. | Saída |
Atributo | Tipo | Formato | Descrição | Obrig. | Evolução |
Ttv_num_cod_erro | integer | >>>>,>>9 | Número da Mensagem |
|
|
Ttv_des_msg_ajuda | character | x(40) | Descrição da Mensagem de Ajuda |
|
|
Ttv_des_msg_erro | character | x(60) | Descrição da Mensagem de Erro. |
|
|
Definição:
def temp-table tt_log_erro no-undo
field ttv_num_cod_erro as integer format ">>>>,>>9" label "Número" column-label "Número"
field ttv_des_msg_ajuda as character format "x(40)" label "Mensagem Ajuda" column-label "Mensagem Ajuda"
field ttv_des_msg_erro as character format "x(60)" label "Mensagem Erro" column-label "Inconsistência" .
Tabela Temporária | Descrição | Entrada/Saída |
tt_correcoes_efetuadas | Conterá as informações de erros na integração, é a temp-table que retorna os possíveis problemas na integração dos registros. | Saída |
Atributo | Tipo | Formato | Descrição | Obrig. | Evolução |
tta_cod_banco | character | x(8) |
|
|
|
tta_cod_produt_financ | character | x(8) |
|
|
|
tta_cod_operac_financ | character | x(10) |
|
|
|
ttv_dat_correc | date | 99/99/9999 |
|
|
|
ttv_val_tax_pre_novo | decimal | ->>,>>>,>>>,>>9.9999999999 |
|
|
|
tta_cod_indic_econ_juros | character | x(8) |
|
|
|
ttv_val_tax_pos_novo | decimal | ->>,>>>,>>>,>>9.9999999999 |
|
|
|
ttv_val_cota_tax_pos | decimal | ->>,>>>,>>>,>>9.9999999999 |
|
|
|
ttv_val_correc_apl | decimal | ->>,>>>,>>>,>>9.99 |
|
|
|
tta_dat_prox_aniver_aplic | date | 99/99/9999 |
|
|
|
ttv_val_comis_delcred | decimal | ->>,>>>,>>>,>>9.99 |
|
|
|
ttv_val_cota_inic_novo | decimal | ->>,>>>,>>>,>>9.9999999999 |
|
|
|
ttv_val_cota_fim_novo | decimal | ->>,>>>,>>>,>>9.9999999999 |
|
|
|
ttv_val_juros_apl_1 | decimal | ->>>,>>>,>>9.99 |
|
|
|
ttv_cb3_ident_visual | character | X(20) |
|
|
|
Definição:
def temp-table tt_correcoes_efetuadas no-undo
field tta_cod_banco as character format "x(8)" label "Banco" column-label "Banco"
field tta_cod_produt_financ as character format "x(8)" label "Produto Financeiro" column-label "Produto Financeiro"
field tta_cod_operac_financ as character format "x(10)" label "Operação Financeira" column-label "Operação Financeira"
field ttv_dat_correc as date format "99/99/9999" initial today label "Data Correção" column-label "Data Correção"
field ttv_val_tax_pre_novo as decimal format "->>,>>>,>>>,>>9.9999999999" decimals 10 label "Val.Tax.Pre" column-label "Val.Tax.Pre"
field tta_cod_indic_econ_juros as character format "x(8)" label "Indic Econ Juros" column-label "Indic Econ Juros"
field ttv_val_tax_pos_novo as decimal format "->>>,>>9.9999999999" decimals 10 label "Val.Tax.Pos" column-label "Val.Tax.Pos"
field ttv_val_cota_tax_pos as decimal format "->>>,>>9.999999999" decimals 9 column-label "Val.Cota Tax.Pos"
&IF "{&emsfin_version}" >= "" AND "{&emsfin_version}" <= "5.05" &THEN
field ttv_val_correc_apl as decimal format "->>,>>>,>>>,>>9.99" decimals 2 initial 0 label "Valor Correção" column-label "Valor Correção"
&ENDIF
&IF "{&emsfin_version}" >= "5.06" AND "{&emsfin_version}" <= "9.99" &THEN
field ttv_val_correc_apl as decimal format "->>,>>>,>>>,>>9.9999999999" decimals 10 initial 0 label "Valor Correção" column-label "Valor Correção"
&ENDIF
field tta_dat_prox_aniver_aplic as date format "99/99/9999" initial &IF "{&ems_dbtype}":U = "MSS":U &THEN 01/01/1800 &ELSE 01/01/0001 &ENDIF label "Próximo Aniversário" column-label "Próximo Aniversário"
field ttv_val_comis_delcred as decimal format "->>,>>>,>>>,>>9.99" decimals 2 label "Val Del Credere" column-label "Val Del Credere"
field ttv_val_cota_inic_novo as decimal format "->>,>>>,>>>,>>9.9999999999" decimals 10 label "Cotação Inic" column-label "Cotação Inic"
field ttv_val_cota_fim_novo as decimal format "->>,>>>,>>>,>>9.9999999999" decimals 10 label "Cotação Fim" column-label "Cotação Fim"
&IF "{&emsfin_version}" >= "" AND "{&emsfin_version}" <= "5.05" &THEN
field ttv_val_juros_apl_1 as decimal format "->>>,>>>,>>9.99" decimals 2 initial 0 label "Valor Juros" column-label "Valor Juros"
&ENDIF
&IF "{&emsfin_version}" >= "5.06" AND "{&emsfin_version}" <= "9.99" &THEN
field ttv_val_juros_apl_1 as decimal format "->>>,>>>,>>9.9999999999" decimals 10 initial 0 label "Valor Juros" column-label "Valor Juros"
&ENDIF
field ttv_cb3_ident_visual as Character format "x(20)" initial ? label "Número Plaqueta" column-label "Número Plaqueta"
.
Import HTML Content
Visão Geral
Conteúdo das Ferramentas