Documento de API
Produto: | Datasul |
Ocorrência: | Documentação de API |
Nome Físico | prgfin/cmg/cmg700zi |
Objetivo
Eliminar os movimentos de Conta Corrente com origem CMG.
Funcionamento
Na forma padrão, realiza-se a chamada através de um comando RUN normal.
A sintaxe para a chamada da API é:
run prgfin/cmg/cmg700zi.py(input 1).
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 (deverão estar definidas como new shared): tt_rec_elimina_movto_cta_corren e tt_log_erros_elimina_movto_cta, que são definidas logo abaixo.
Tabelas Temporárias
Nos atributos das tabelas temporárias de entrada e saída:
Tabela Temporária | Descrição | Entrada/Saída |
tt_rec_elimina_movto_cta_corren | Conterá os recid`s dos movimentos de conta corrente para eliminação. | New Shared |
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
ttv_rec_movto_cta_corren | recid | >>>>>>9 | Recid’s dos movimentos de contas corrente. | Sim |
|
def new shared temp-table tt_rec_elimina_movto_cta_corren
field ttv_rec_movto_cta_corren as recid format ">>>>>>9" initial ? .
Tabela Temporária | Descrição | Entrada/Saída |
tt_log_erros_elimina_movto_cta | Conterá as informações dos erros apresentados na eliminação. | New Shared |
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
ttv_rec_movto_cta_corren | recid | >>>>>>9 | Código do movimento da conta corrente | Sim |
|
ttv_cod_msg_erro | character | x(50) | Código Mensagem | Sim |
|
ttv_des_mensagem | character | x(50) | Mensagem | Sim |
|
ttv_des_help | character | x(40) | Ajuda | Sim |
|
def new shared temp-table tt_log_erros_elimina_movto_cta
field ttv_rec_movto_cta_corren as recid format ">>>>>>9" initial ?
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_rec_elimina_movto_cta_corren:
O atributo tt_rec_elimina_movto_cta_corren.ttv_rec_movto_cta_corren deverá receber o recid da tabela movto_cta_corren que deverá ser eliminada;
Para a tt_log_erros_elimina_movto_cta:
Na tabela temporária tt_log_erros_elimina_movto_cta 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.