Linha Datasul

Árvore de páginas

Documento de API

Produto:

Datasul

Ocorrência:

Documentação de API

Nome FísicoPrgfin/apl/apl007zq

 

Objetivo

Efetuar o pagamento de parcelas de empréstimo: Liberação ou Pagamento, 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/apl007zq.py        (1,

                                 input p_num_id_operac_financ,

                                  input p_cod_banco,

                                  input p_cod_produt_financ,

                                  input p_cod_operac_financ,

                                  input p_cod_cta_corren,

                                  input p_dat_pagto,

                                  input p_val_pagto,

                                  input p_val_princ_pagto,

                                  input p_ind_orig_cotac,

                                  input p_val_cotac_contrat,

                                  input p_val_multa_atraso,

                                  input p_val_juros_atraso,

                                  input p_val_desconto,

                                  input p_num_parc_emprest,

                                  input p_ind_tip_parc_emprest,

                                  output table tt_log_erro,

                          output p_num_id_movto_operac_financ,

                                 input p_cod_modul_orig_operac).

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_cod_cta_corren ]

É a conta corrente em que será efetuada a operação.

p_dat_pagto

É a data do pagamento.

p_val_pagto

É o valor do pagamento.

p_val_princ_pagto

É o valor do Principal do pagamento.

p_ind_orig_cotac

Indica se a cotação da moeda deverá ser buscada pelo sistema ou deverá usar o valor informado. Opções: ‘Sistema’ ou ‘Contratada’.

p_val_cotac_contrat

É o valor da cotação contratada. Caso o p_ind_orig_cotac for igual a contratada, este campo deverá ter sido informado.

 [ p_val_multa_atraso ]

Valor da multa do pagamento.

[ p_val_juros_atraso ]

Valor dos juros do pagamento.

[ p_val_desconto ]

Valor do desconto concedido.

p_num_parc_emprest

Número da parcela que está sendo paga.

p_ind_tip_parc_emprest

Indicador do tipo da parcela que está sendo paga: Liberação ou Pagamento.

tt_log_erro

Os retornos de erros encontrados durante o processo de criação serão gravados nesta tabela.

p_num_id_movto_operac_financ

É o identificador do movimento de pagamento criado da operação financeira.

p_cod_modul_orig_operac

Indicador do módulo Origem do resgate.

 

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 pagamento do empréstimo da operação financeira no Aplicações e Empréstimos e também o número identificador do movimento de pagamento criado nesta api.

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"    .