Documento de API

Objetivo

Eliminar os movimentos de Conta Corrente com origem CMG.

Funcionamento

Na forma padrão, realiza-se a chamada do programa em modo persistente, sem a passagem de parâmetros, e em seguida, através de um comando RUN normal, executa-se seu método padrão passando-se os parâmetros com as informações necessárias.

A sintaxe para a chamada da API é:

 def var v_hdl_api as HANDLE  format ">>>>>>9":U .

 run prgfin/cmg/cmg700zj.py persistent set v_hdl_api.

 run pi_elimina_movto_cta_corren_2 in v_hdl_api ( input 2,
                                                                                input-output table tt_row_elimina_movto_cta_corr,
                                                                                input-output table tt_log_erros_elimina_movtocta).

  if valid-handle(v_hdl_api)  then do:
     delete object v_hdl_api.
  end.

Parâmetros Entrada

num_vers_integr_api...........: será utilizado para determinar se o programa que está chamando está íntegro com as definições correntes da API; 

O programa que irá executar a api_movto_cta_corren_elimina deverá conter e criar as seguintes tabelas temporárias: tt_row_elimina_movto_cta_corr e tt_log_erros_elimina_movtocta, que são definidas logo abaixo.

Tabelas Temporárias

Nos atributos das tabelas temporárias de entrada e saída:

def temp-table tt_row_elimina_movto_cta_corr no-undo

    field ttv_row_movto_cta_corren         as Rowid
    .

def temp-table tt_log_erros_elimina_movtocta no-undo

    field ttv_row_movto_cta_corren         as Rowid

    field ttv_cod_msg_erro                 as character format "x(50)" label "Código Mensagem" column-label "Código Mensagem"

    field ttv_des_mensagem                 as character format "x(50)" label "Mensagem" column-label "Mensagem"

    field ttv_des_help                     as character format "x(40)" label "Ajuda" column-label "Ajuda"
    .

Observações

Para a tt_row_elimina_movto_cta_corr:

O atributo tt_row_elimina_movto_cta_corr.ttv_row_movto_cta_corren deverá receber o rowid da tabela movto_cta_corren que deverá ser eliminada;

Exemplo: tt_row_elimina_movto_cta_corr.ttv_row_movto_cta_corren = ROWID(movto_cta_corren).

Para a tt_log_erros_elimina_movtocta:

Na tabela temporária tt_log_erros_elimina_movtocta será gerado todos os erros encontrados ou mensagens de alerta gerados durante o processo de eliminação do movimento de conta corrente.

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.

Para a correta visualização dos erros, todos os campos desta tabela devem ser impressos.

Os seguintes erros podem ocorrer neste processo de eliminação:

4049 – Movimento conciliado parcial ou totalmente;

5138 - Situação de movimentação do módulo CMG não está Habilitada;

9286 - Data movimento menor que data início dos parâmetros estabelecimento no CMG;

3771 - Movimento Conta Corrente já foi contabilizado;

9583 - Módulo de Origem não é CMG;

7167 - Movimento de Conta Corrente não encontrado.