Documento de API

Objetivo

Realizar transferência e mútuo.

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 executar a chamada da API em modo persistente é:

 def var v_hdl_program as Handle format ">>>>>>9":U no-undo.

run prgfin/cmg/cmg742zb.py persistent set h-handlev_hdl_program.

run pi_main_code_api_movto_cta_corren_transf_mutuo_2 in h-handle4 in v_hdl_program

        (input 12,

         input         input-output table tt_movto_cta_corren_transf_mut_3,

         input-output table tt_import_movto_valid_cmg_3,

        input-output table tt_params_generic_api_3).

delete procedure v_hdl_program.

Parâmetros

Retorno

A API retornará na tabela temporária tt_import_movto_valid_cmg_3 todos os erros encontrados ou mensagens de alerta gerados durante o processo de validação dos movimentos.

O parâmetro de saída é através do comando return-value, sendo que o valor do seu retorno será 2782. Este código significa que a versão de integração incorreta.

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, caso o usuário não tenha ligado os parâmetros para impressão dos movimentos importados e com erros. E para a correta visualização dos erros, todos os campos desta tabela devem ser impressos.A variável denominada h-handle irá receber o “handle” do programa, permitindo o acesso aos “métodos” internos da API.

Tabelas Temporárias

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

...

def temp-table tt_movto_cta_corren_transf_mut_3 no-undo

    field ttv_cod_cta_corren_orig              as orig          as character format "x(10)" label "Cta Corren Origem" column-label "Cta Corren Origem"

    field ttv_cod_cta_corren_dest             dest          as character format "x(10)" label "Cta Corren Destino" column-label "Cta Corren Destino"

    field tta_dat_movto_cta_corren           corren         as date format "99/99/9999" initial today label "Data Movimento" column-label "Data Movimento"

    field tta_num_seq_movto_cta_corren   corren     as integer format ">>>>9" initial 0 label "Sequência" column-label "Sequência"

    field tta_ind_tip_movto_cta_corren      as corren     as character format "X(2)" initial "RE" label "Tipo Movimento" column-label "Tipo Movto"

    field tta_cod_tip_trans_cx                   cx             as character format "x(8)" label "Tipo Transação Caixa" column-label "Tipo Transação Caixa"

    field tta_ind_fluxo_movto_cta_corren   as character format "X(3)" initial "ENT" label "Fluxo Movimento" column-label "Fluxo Movto"

    field tta_cod_cenar_ctbl                     ctbl               as character format "x(8)" label "Cenário Contábil" column-label "Cenário Contábil"

    field tta_val_movto_cta_corren            as corren         as decimal format ">>>>,>>>,>>9.99" decimals 2 initial 0 label "Valor Movimento" column-label "Valor Movimento"

    field tta_cod_docto_movto_cta_bco     bco      as character format "x(20)" label "Documento Banco" column-label "Documento Banco"

    field tta_cod_modul_dtsul                   dtsul              as character format "x(3)" label "Módulo" column-label "Módulo"

    field tta_cod_histor_padr                    as padr              as character format "x(8)" label "Histórico Padrão" column-label "Histórico Padrão"

    field tta_des_histor_padr                    as padr              as character format "x(40)" label "Descrição" column-label "Descrição Histórico Padrão"

    field tta_num_id_movto_cta_corren     corren      as integer format "9999999999" initial 0 label "ID Movto Conta" column-label "ID Movto Conta"

    field ttv_reccod_id_movto_cta_corren           as recid character format ">>>>>>9" initial ?x(20)"

    field ttv_ind_erro_valid                      as               as character format "X(08)" initial "Não"

    field tta_val_cotac_indic_econ            as econ         as decimal format ">>>>,>>9.9999999999" decimals 10 initial 0 label "Cotação" column-label "Cotação"

    . 

def temp-table tt_import_movto_valid_cmg_3 no-undo

    field ttv_reccod_id_movto_cta_corren          as recid as character format ">>>>>>9" initial ?x(20)"

    field ttv_num_mensagem                as mensagem                 as integer format ">>>>,>>9" label "Número" column-label "Número Mensagem"

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

    field ttv_des_msg_erro                   erro                 as character format "x(60)" label "Mensagem Erro" column-label "Inconsistência"

    field ttv_cod_parameters                as parameters               as character format "x(256)"

    .

Métodos

Quando a API/BO for executada em modo persistente, os seguintes métodos estarão disponíveis para execução:

Método Básico

pi_main_code_api_movto_cta_corren_transf_mutuo_2

...

Sintaxe

...

run pi_main_code_api_movto_cta_corren_transf_mutuo_2 in h-handle

        (input 1,

         input-output table tt_movto_cta_corren_transf_mut,

         input-output table tt_import_movto_valid_cmg).

...

Descrição

...

Realiza Transferência e Mútuo

...

...

Parâmetros

...

Descrição

...

...

p_num_vers_integr_api

...

Versão de integração

def temp-table tt_params_generic_api_3 no-undo

    field ttv_cod_id_param                       as character format "x(20)"

    field ttv_cod_tabela                   as character format "x(28)" label "Tabela" column-label "Tabela"

    field ttv_cod_campo                    as character format "x(25)" label "Campo" column-label "Campo"

    field ttv_cod_valor                    as character format "x(8)" label "Valor" column-label "Valor"

    index tt_idx_param_generic             is primary unique

          ttv_cod_tabela                   ascending

          ttv_cod_id_param                       ascending

          ttv_cod_campo                    ascending

    .

Exemplo Criação temp-table tt_params_generic_api_3:

CREATE tt_params_generic_api_3.
ASSIGN tt_params_generic_api_3.ttv_cod_id_param =

...

tt_movto_cta_corren_transf_mut

...

Movimentos de conta corrente parar transferência ou mútuo

...

...

tt_import_movto_valid_cmg

...

Tabela de erro

...

Retorno

...

Os valores possíveis para o return-value são “2782”caso a versão de integração seja diferente de 1 e “NOK” caso ocorra algum erro no processamento. Caso não ocorram erros retorna vazio.

 _3.ttv_cod_id_movto_cta_corren 
tt_params_generic_api_3.ttv_cod_tabela = "tt_movto_cta_corren_transf_mut_3"
tt_params_generic_api_3.ttv_cod_campo = "ttv_cod_cta_mutuo"
tt_params_generic_api_3.ttv_cod_valor = (Valor da Conta Mútuo)
.