Linha Datasul

Árvore de páginas

Documento de API

 

Produto:

Datasul

Ocorrência:

Documentação de API

Nome FísicoPrgfin/apl/apl007zz

 

Objetivo

Efetuar o cancelamento ou estorno de um empréstimo 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/apl007zz.py        (1,

                                 input p_ind_tip_operac,

                                  input p_ind_tip_cancel_estorn,

                                  input p_num_id_operac_financ,

                                  input p_num_id_movto_operac_financ,

                                  input p_dat_estorno,

                                  output table tt_log_erro,

                                 input p_cod_acao).

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_ind_tip_operac

É o identificador do tipo de operação que irá realizar: ‘Cancelamento’ ou ‘Estorno’

p_ind_tip_cancel_estorn

Indica se será cancelado/estornado o ‘empréstimo‘ ou um ’movimento’ do empréstimo.

p_num_id_operac_financ

É o identificador da operação financeira.

[ p_num_id_movto_operac_financ]

É o identificador do movimento relacionado a operação financeira. Não é obrigatório o seu preenchimento caso o p_ind_tip_cancel_estorn seja igual a ‘empréstimo’.

[ p_dat_estorno ]

É a data em que será gerado o estorno. Deverá ser informado se o p_ind_tip_operac for igual a ‘estorno’.

tt_log_erro

Os retornos de erros encontrados durante o processo de cancelamento/estorno serão gravados nesta tabela.

p_cod_acao

É utilizado para identificar a ação a ser tomada pelo sistema. Pode ser “Validar”, “Efetivar” ou “Ambos”.

 

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 cancelamento/estorno do empréstimo no 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_erros_atualiz

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