Documento de API
Produto: | Datasul |
Ocorrência: | Documentação de API |
Nome Físico | prgfin/cmg/cmg719zf |
Objetivo
Importar movimentos de contas correntes para o Caixa e Bancos.
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.
Observações:
- 66.”
A sintaxe para a chamada da API é:
def var v_hdl_program as Handle format ">>>>>>9":U no-undo.
def new shared stream s_1.
run prgfin/cmg/cmg719zg.py persistent set v_hdl_program.
output stream s_1 to value(session:temp-directory + "\cmg719zg.txt") paged page-size 66.
run pi_main_cmg719zg in v_hdl_program (input 1,
input yes,
input yes,
input-output table tt_movto_cta_corren_import,
Input table tt_aprop_ctbl_cmg_imp,
input table tt_val_aprop_ctbl_cmg_import,
input table tt_val_aprop_cmg_cambial,
Input table tt_rat_financ_cmg_import,
output table tt_import_movto_valid_cmg).
output close.
delete procedure v_hdl_program.
Parâmetros
Parâmetro | Descrição |
p_num_vers_integr_api | Será utilizado para determinar se o programa que está chamando está íntegro com as definições correntes da API. |
p_log_print_imported_nok | Será utilizado para indicar se será impresso no arquivo de log os registros não importados, isto é, aqueles em que ocorreram erros. |
p_log_print_imported | Será utilizado para indicar se será impresso no arquivo de log os registros importados, isto é, aqueles em que não ocorreram erros. |
tt_movto_cta_corren_import | Esta temp-table conterá todos os movimentos que devam ser importados para o Caixa e Bancos. |
tt_aprop_ctbl_cmg_imp | Esta temp-table conterá as apropriações dos movimentos que serão importados. Obs: Somente poderão ser informados as apropriações quando o módulo informado no movimento for “CMG”. |
tt_val_aprop_ctbl_cmg_import | Esta temp-table conterá os valores das apropriações dos movimentos que serão importados. Importante: Não é necessário gerar dados para esta temp-table, caso a mesma esteja vazia os valores das apropriações serão criados normalmente com base nas moedas (finalidades) que armazenam valores no módulo e com base nas cotações cadastradas no sistema. |
tt_val_aprop_cmg_cambial | Esta temp-table conterá as variáveis utilizadas para o cálculo dos valores de movimentos de variação cambial. Ela resultará em uma tabela que servirá apenas para conferência do valor gerado. Importante: esta temp-table é de uso interno dos sistemas Datasul. |
tt_rat_financ_cmg_import | Esta temp-table conterá os rateios dos movimentos que serão importados. Obs1: Somente poderão ser informados os rateios quando o módulo informado no movimento for “CMG”. Obs2: Os rateios que não forem informados para movimentos com o módulo “CMG”, serão criados automaticamente. |
tt_import_movto_valid_cmg | Esta temp-table conterá os erros que ocorreram nos movimentos que não puderam ser importados. |
Retorno
A API retornará na tabela temporária tt_import_movto_valid_cmg 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.
Tabelas Temporárias
O programa que irá executar a api_movto_cta_corren_import_recebto deverá conter e criar as seguintes tabelas temporárias:
Tabela Temporária | Descrição | Entrada/Saída |
tt_movto_cta_corren_import | Conterá as informações dos movimentos a serem importados. | Entrada e Saída |
Atributo | Tipo | Formato | Descrição | Obrig. | Evolução |
tta_cod_cta_corren | character | x(10) | Código da Conta Corrente. | Sim | |
tta_dat_movto_cta_corren | date | 99/99/9999 | Data do Movimento. | Sim | |
tta_num_seq_movto_cta_corren | integer | >>>>9 | Seqüência em que o movimento será gerado. | Sim | |
tta_ind_tip_movto_cta_corren | character | X(2) | Indicador do Tipo de Movimento. Valores permitidos: RE e NR. Onde: RE = Realizado NR = Não Realizado. | Sim | |
tta_cod_tip_trans_cx | character | x(8) | Código do Tipo de Transação de Caixa. | Sim | |
tta_ind_fluxo_movto_cta_corren | character | X(3) | Indicador do Fluxo do Movimento. Valores permitidos: ENT e SAI. Onde: ENT = Entrada SAI = Saída. | Sim | |
tta_cod_cenar_ctbl | character | x(8) | Código do Cenário Contábil. | Sim * | |
tta_cod_histor_padr | character | x(8) | Código do Histórico Padrão. | Não | |
tta_val_movto_cta_corren | decimal | >>>>,>>>,>>9.99 | Valor do Movimento. | Sim | |
tta_cod_docto_movto_cta_bco | character | x(20) | Documento do Banco que possa ser utilizado como referência para o movimento a ser criado. | Sim | |
tta_cod_modul_dtsul | character | x(3) | Código do Módulo. Normalmente utilizado “CMG” para movimentos do Caixa e Bancos. | Sim | |
ttv_ind_erro_valid | character | X(8) | Inicialmente este atributo deverá receber o valor “Não”. Após a execução da API, caso ocorra algum erro de importação, este terá o valor “Sim” e terá as respectivas mensagens de erro na tt_import_movto_valid_cmg, onde a leitura deverá ser feita pelo atributo ttv_rec_movto_cta_corren. Exemplo: For each tt_movto_cta_corren_import no-lock Where tt_movto_cta_corren_import.ttv_ind_erro_valid = “Sim”: For each tt_import_movto_valid_cmg no-lock Where tt_import_movto_valid_cmg.ttv_rec_movto_cta_corren = tt_movto_cta_corren_import.ttv_rec_movto_cta_corren: Disp tt_import_movto_valid_cmg. End. End. | Sim | |
tta_des_histor_padr | character | x(40) | Descrição do Histórico Padrão. | Sim | |
tta_num_id_movto_cta_corren | integer | 9999999999 | No retorno da execução da API, este atributo conterá o Número do Movimento de conta corrente que foi criado. Se este número for igual a 0 (zero), é por que ocorreu algum erro durante o processo de importação e o movimento não foi importado. | Sim | |
ttv_rec_movto_cta_corren | recid | >>>>>>9 | Deverá conter o número do recid da temp-table tt_movto_cta_corren_import. Exemplo: assign tt_movto_cta_corren_import.ttv_rec_movto_cta_corren = recid(tt_movto_cta_corren_import). | Sim | |
*Somente deve ser informado cenário para as contas correntes de mútuo e que tenham o controle por cenário, para todas as demais enviar a informação em branco “”.
Definição:
def temp-table tt_movto_cta_corren_import no-undo
field tta_cod_cta_corren as character format "x(10)" label "Conta Corrente" column-label "Cta Corrente"
field tta_dat_movto_cta_corren as date format "99/99/9999" initial today label "Data Movimento" column-label "Data Movimento"
field tta_num_seq_movto_cta_corren as integer format ">>>>9" initial 0 label "Sequência" column-label "Sequência"
field tta_ind_tip_movto_cta_corren as character format "X(2)" initial "RE" label "Tipo Movimento" column-label "Tipo Movto"
field tta_cod_tip_trans_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 as character format "x(8)" label "Cenário Contábil" column-label "Cenário Contábil"
field tta_cod_histor_padr as character format "x(8)" label "Histórico Padrão" column-label "Histórico Padrão"
field tta_val_movto_cta_corren as decimal format ">>>>,>>>,>>9.99" decimals 2 initial 0 label "Valor Movimento" column-label "Valor Movimento"
field tta_cod_docto_movto_cta_bco as character format "x(20)" label "Documento Banco" column-label "Documento Banco"
field tta_cod_modul_dtsul as character format "x(3)" label "Módulo" column-label "Módulo"
field ttv_ind_erro_valid as character format "X(08)" initial "Não"
field tta_des_histor_padr as character format "x(40)" label "Descrição" column-label "Descrição Histórico Padrão"
field tta_num_id_movto_cta_corren as integer format "9999999999" initial 0 label "ID Movto Conta" column-label "ID Movto Conta"
field ttv_rec_movto_cta_corren as recid format ">>>>>>9" initial ?
index tt_erro
ttv_ind_erro_valid ascending
index tt_import_movto_cta_corren is primary unique
tta_cod_cta_corren ascending
tta_dat_movto_cta_corren ascending
tta_num_seq_movto_cta_corren ascending
index tt_rec_movto
ttv_rec_movto_cta_corren ascending
.
Tabela Temporária | Descrição | Entrada/Saída |
tt_aprop_ctbl_cmg_imp | Conterá as informações das apropriações contábeis dos movimentos a serem importados. | Entrada |
(*) A partir da 5.07A o estabelecimento passa a ter cinco dígitos.
(**) Liberado o centro de custo com 20 posições, a partir de maio/2011.
Atributo | Tipo | Formato | Descrição | Obrig. | Evolução |
tta_num_id_movto_cta_corren | integer | 9999999999 | Não informar nada – uso interno. | Não | |
tta_num_seq_aprop_ctbl_cmg | integer | >>9 | Não informar nada – uso interno. | Não | |
tta_ind_finalid_aprop_ctbl_cmg | character | X(2) | Não informar nada – uso interno. | Não | |
tta_ind_natur_lancto_ctbl | character | X(2) | Natureza do lançamento contábil. Valores permitidos: DB e CR. Onde: DB = Débito CR = Crédito. | Sim | |
tta_ind_orig_aprop_ctbl_cmg | character | X(3) | Não informar nada – uso interno. | Não | |
tta_cod_empresa | character | X(3) | Não informar nada – uso interno. | Não | |
tta_cod_estab | character | X(3) / x(5)* | Código do Estabelecimento. | Sim | |
tta_cod_cenar_ctbl | character | x(8) | Não informar nada – uso interno. | Não | |
tta_cod_plano_cta_ctbl | character | x(8) | Código do Plano Contas | Sim | |
tta_cod_cta_ctbl | character | x(20) | Código da Conta Contábil | Sim | |
tta_cod_unid_negoc | character | x(3) | Código da Unidade de Negócio | Sim | |
tta_cod_plano_ccusto (*) | character | x(8) | Código do Plano do Centro de Custo | Não | |
tta_cod_ccusto (*) | character | x(11)/x(20)** | Código do Centro de Custo | Não | |
tta_cod_cta_corren | character | x(10) | Não informar nada – uso interno. | Não | |
ttv_rec_aprop_ctbl_cmg | recid | >>>>>>9 | Deverá conter o número do recid da temp-table tt_aprop_ctbl_cmg_imp. Exemplo: assign tt_aprop_ctbl_cmg_imp.ttv_rec_aprop_ctbl_cmg = recid(tt_aprop_ctbl_cmg_imp). | Sim | |
Observação: Somente poderão ser informados apropriações contábeis para os movimentos que possuem como módulo de origem “CMG”.
Definição:
def temp-table tt_aprop_ctbl_cmg_imp no-undo
field tta_num_id_movto_cta_corren as integer format "9999999999" initial 0 label "ID Movto Conta" column-label "ID Movto Conta"
field tta_num_seq_aprop_ctbl_cmg as integer format ">>9" initial 0 label "Sequência" column-label "Seq Aprop"
field tta_ind_finalid_aprop_ctbl_cmg as character format "X(2)" initial "PR" label "Finalidade" column-label "Finalidade"
field tta_ind_natur_lancto_ctbl as character format "X(02)" initial "DB" label "Natureza" column-label "Natureza"
field tta_ind_orig_aprop_ctbl_cmg as character format "X(3)" label "Origem Apropriação" column-label "Origem Aprop"
field tta_cod_empresa as character format "x(3)" label "Empresa" column-label "Empresa"
field tta_cod_estab as character format "x(5)" label "Estabelecimento" column-label "Estab"
field tta_cod_cenar_ctbl as character format "x(8)" label "Cenário Contábil" column-label "Cenário Contábil"
field tta_cod_plano_cta_ctbl as character format "x(8)" label "Plano Contas" column-label "Plano Contas"
field tta_cod_cta_ctbl as character format "x(20)" label "Conta Contábil" column-label "Conta Contábil"
field tta_cod_unid_negoc as character format "x(3)" label "Unid Negócio" column-label "Un Neg"
field tta_cod_plano_ccusto as character format "x(8)" label "Plano Centros Custo" column-label "Plano Centros Custo"
field tta_cod_ccusto as Character format "x(11)" label "Centro Custo" column-label "Centro Custo"
field tta_cod_cta_corren as character format "x(10)" label "Conta Corrente" column-label "Cta Corrente"
field tta_cod_indic_econ as character format "x(8)" label "Moeda" column-label "Moeda"
field tta_val_movto_cta_corren as decimal format ">>>>,>>>,>>9.99" decimals 2 initial 0 label "Valor Movimento" column-label "Valor Movimento"
field tta_log_ctbz_movto_cta_corren as logical format "Sim/Não" initial no label "Contabilizado" column-label "Contabilizado"
field tta_log_mutuo_pagto as logical format "Sim/Não" initial no label "Mútuo Pagamento" column-label "Mútuo Pagamento"
field tta_dat_transacao as date format "99/99/9999" initial today label "Data Transação" column-label "Dat Transac"
field ttv_rec_movto_cta_corren as recid format ">>>>>>9" initial ?
field ttv_rec_aprop_ctbl_cmg as recid format ">>>>>>9" initial ?
index tt_id is primary
ttv_rec_movto_cta_corren ascending
index tt_id_aprop
ttv_rec_aprop_ctbl_cmg ascending
.
Tabela Temporária | Descrição | Entrada/Saída |
tt_val_aprop_ctbl_cmg_import | Conterá as informações dos rateios financeiros dos movimentos a serem importados. | Entrada |
Atributo | Tipo | Formato | Descrição | Obrig. | Evolução |
tta_cod_finalid_econ | character | x(10) | Código da finalidade econômica. | Sim | |
tta_dat_cotac_indic_econ | date | 99/99/9999 | Data da Cotação. | Sim | |
tta_val_cotac_indic_econ | decimal | >>>>,>>9.9999999999 | Valor da cotação. | Sim | |
tta_val_movto_cta_corren | decimal | >>>>,>>>,>>9.99 | Valor na moeda da finalidade econômica. | Sim | |
ttv_rec_movto_cta_corren | recid | >>>>>>9 | Deverá conter o número do recid da temp-table tt_movto_cta_corren_import que será utilizado como chave de ligação entre o movimento e os seus respectivos valores em outras moedas (finalidades). Exemplo: assign tt_val_aprop_ctbl_cmg_import..ttv_rec_movto_cta_corren = recid(tt_movto_cta_corren_import). | Sim | |
ttv_rec_aprop_ctbl_cmg | recid | >>>>>>9 | Deverá conter o número do recid da temp-table tt_aprop_ctbl_cmg_imp que será utilizado como chave de ligação entre a aproprição e os seus respectivos valores em outras moedas(finalidades). Exemplo: assign tt_val_aprop_ctbl_cmg_import.ttv_rec_aprop_ctbl_cmg = recid(tt_aprop_ctbl_cmg_imp). | Sim | |
ttv_rec_val_aprop_ctbl_cmg | recid | >>>>>>9 | Deverá conter o número do recid da temp-table tt_val_aprop_ctbl_cmg_import. Exemplo: Assign tt_val_aprop_ctbl_cmg_import.ttv_rec_val_aprop_ctbl_cmg = recid(tt_val_aprop_ctbl_cmg_import). | Sim | |
Observação: Não é necessário gerar dados para esta temp-table, caso a mesma esteja vazia os valores das apropriações serão criados normalmente com base nas moedas(finalidades) que armazenam valores no módulo e com base nas cotações cadastradas no sistema.
Definição:
def temp-table tt_val_aprop_ctbl_cmg_import no-undo
field tta_cod_finalid_econ as character format "x(10)" label "Finalidade" column-label "Finalidade"
field tta_dat_cotac_indic_econ as date format "99/99/9999" initial ? label "Data Cotação" column-label "Data Cotação"
field tta_val_cotac_indic_econ as decimal format ">>>>,>>9.9999999999" decimals 10 initial 0 label "Cotação" column-label "Cotação"
field tta_val_movto_cta_corren as decimal format ">>>>,>>>,>>9.99" decimals 2 initial 0 label "Valor Movimento" column-label "Valor Movimento"
field ttv_rec_movto_cta_corren as recid format ">>>>>>9" initial ?
field ttv_rec_aprop_ctbl_cmg as recid format ">>>>>>9" initial ?
field ttv_rec_val_aprop_ctbl_cmg as recid format ">>>>>>9" initial ?
index tt_finalid
ttv_rec_movto_cta_corren ascending
tta_cod_finalid_econ ascending
index tt_id is primary
ttv_rec_movto_cta_corren ascending
ttv_rec_aprop_ctbl_cmg ascending
ttv_rec_val_aprop_ctbl_cmg ascending
.
Tabela Temporária | Descrição | Entrada/Saída |
tt_val_aprop_cmg_cambial | Esta temp-table conterá as variáveis utilizadas para o cálculo dos valores de movimentos de variação cambial. Ela resultará em uma tabela que servirá apenas para conferencia do valor gerado. | Entrada |
Observação: Esta temp-table é de uso interno dos sitemas Datasul. Portanto o seu envio não afetará o seu funcionamento.
Atributo | Tipo | Formato | Descrição | Obrig. | Evolução |
ttv_rec_val_aprop_ctbl_cmg | Recid | >>>>>>9 | Recid da tt_val_aprop_ctbl_cmg_import. | Sim | |
ttv_rec_val_aprop_cmg_cambial | Recid | >>>>>>9 | Recid identificador dessa temp-table. | Sim | |
tta_cod_finalid_econ | Char | x(10) | Código da Finalidade Econômica. | Sim | |
tta_dat_inic_calc | Date | 99/99/9999 | Data inicial variação cambial. | Sim | |
tta_dat_fim_calc | Date | 99/99/9999 | Data final variação cambial. | Sim | |
tta_dat_cotac_sdo_inic | Date | 99/99/9999 | Data da cotação do saldo inicial. | Sim | |
tta_dat_cotac_sdo_fim | Date | 99/99/9999 | Data da cotação do saldo final. | Sim | |
tta_val_cotac_sdo_inic | Decimal | >>>>,>>9.9999999999 | Valor da cotação do saldo inicial. | Sim | |
tta_val_cotac_sdo_fim | Decimal | >>>>,>>9.9999999999 | Valor da cotação do saldo final. | Sim | |
tta_val_sdo_inic_orig | Decimal | ->>>,>>>>,>>>,>>9.9999999999 | Valor do saldo inicial. | Sim | |
tta_val_sdo_fim_orig | Decimal | ->>>,>>>>,>>>,>>9.9999999999 | Valor do saldo final. | Sim | |
tta_val_sdo_inic_conver | Decimal | ->>>,>>>>,>>>,>>9.9999999999 | Valor do saldo inicial convertido para a cotação. | Sim | |
tta_val_sdo_fim_conver | Decimal | ->>>,>>>>,>>>,>>9.9999999999 | Valor do saldo final convertido papa a cotação. | Sim | |
tta_val_movto_finalid_econ | Decimal | ->>>,>>>>,>>>,>>9.9999999999 | Valor da movimentação da conta corrente no intervalo calculado. | Sim | |
tta_val_sdo_fim_calc | Decimal | ->>>,>>>>,>>>,>>9.9999999999 | Saldo final calculado. | Sim | |
tta_dat_inic_period_ctbl | Date | 99/99/9999 | Data de cálculo inicial. | Sim | |
tta_dat_fim_period_ctbl | Date | 99/99/9999 | Data de cálculo final. | Sim | |
Definição:
def temp-table tt_val_aprop_cmg_cambial no-undo
field ttv_rec_val_aprop_ctbl_cmg as recid format ">>>>>>9" initial ?
field ttv_rec_val_aprop_cmg_cambial as recid format ">>>>>>9"
field tta_cod_finalid_econ as character format "x(10)" label "Finalidade"
field tta_dat_inic_calc as date format "99/99/9999" label "Início Cálculo"
field tta_dat_fim_calc as date format "99/99/9999" label "Data Fim Cálculo"
field tta_dat_cotac_sdo_inic as date format "99/99/9999" label "Dt Cotac Sdo Inicial"
field tta_dat_cotac_sdo_fim as date format "99/99/9999" label "Dt Cotação Saldo Fim"
field tta_val_cotac_sdo_inic as decimal format ">>>>,>>9.9999999999" decimals 10 label "Vl Cotac Sdo Inicial"
field tta_val_cotac_sdo_fim as decimal format ">>>>,>>9.9999999999" decimals 10 label "Vl Cotac Sdo Final"
field tta_val_sdo_inic_orig as decimal format "->>>,>>>>,>>>,>>9.9999999999" decimals 10 label "Sdo Inicial Original"
field tta_val_sdo_fim_orig as decimal format "->>>,>>>>,>>>,>>9.9999999999" decimals 10 label "Sdo Final Original"
field tta_val_sdo_inic_conver as decimal format "->>>,>>>>,>>>,>>9.9999999999" decimals 10 label "Sdo Ini Convertido"
field tta_val_sdo_fim_conver as decimal format "->>>,>>>>,>>>,>>9.9999999999" decimals 10 label "Sdo Fim Convertido"
field tta_val_movto_finalid_econ as decimal format "->>>,>>>>,>>>,>>9.9999999999" decimals 10 label "Val Movto Finalidade"
field tta_val_sdo_fim_calc as decimal format "->>>,>>>>,>>>,>>9.9999999999" decimals 10 label "Saldo Fim Calculado"
field tta_dat_inic_period_ctbl as date format "99/99/9999" label "Início Período"
field tta_dat_fim_period_ctbl as date format "99/99/9999" label "Fim Período"
index tt_val_aprop_ctbl_cmg
ttv_rec_val_aprop_ctbl_cmg ascending.
Tabela Temporária | Descrição | Entrada/Saída |
tt_rat_financ_cmg_import | Conterá as informações dos rateios financeiros dos movimentos a serem importados. | Entrada |
(*) A partir da 5.07A o estabelecimento passa a ter cinco dígitos.
Atributo | Tipo | Formato | Descrição | Obrig. | Evolução |
ttv_rec_movto_cta_corren | recid | >>>>>>9 | Deverá conter o número do recid da temp-table tt_movto_cta_corren_import que será utilizado como chave de ligação entre o movimento e os seus respectivos rateios financeiros. Exemplo: assign tt_rat_financ_cmg_import.ttv_rec_movto_cta_corren = tt_movto_cta_corren_import.ttv_rec_movto_cta_corren. | Sim | |
tta_cod_estab | character | x(3) / x(5)* | Código do Estabelecimento. | Sim | |
tta_cod_unid_negoc | character | x(3) | Código da Unidade de Negócio. | Sim | |
tta_cod_tip_fluxo_financ | character | x(12) | Código do Tipo de Fluxo Financeiro. | Sim | |
tta_val_movto_cta_corren | decimal | >>>>,>>>,>>9.99 | Neste atributo deverá ser informado o valor do rateio financeiro. | Sim | |
Obs1: Somente poderão ser informados rateios financeiros para os movimentos que possuem como módulo de origem “CMG”.
Obs2: Caso o rateio financeiro não seja informado, o mesmo será criado automaticamente para movimentos que tiverem como módulo de origem “CMG”.
Definição:
def temp-table tt_rat_financ_cmg_import no-undo
field ttv_rec_movto_cta_corren as recid format ">>>>>>9" initial ?
field tta_cod_estab as character format "x(5)" label "Estabelecimento" column-label "Estab"
field tta_cod_unid_negoc as character format "x(3)" label "Unid Negócio" column-label "Un Neg"
field tta_cod_tip_fluxo_financ as character format "x(12)" label "Tipo Fluxo Financ" column-label "Tipo Fluxo Financ"
field tta_val_movto_cta_corren as decimal format ">>>>,>>>,>>9.99" decimals 2 initial 0 label "Valor Movimento" column-label "Valor Movimento"
index tt_codigo is primary
ttv_rec_movto_cta_corren ascending
.
Tabela Temporária | Descrição | Entrada/Saída |
tt_import_movto_valid_cmg | Conterá as informações dos movimentos que não foram importados com a respectiva mensagem de erro. | Saída |
Atributo | Tipo | Formato | Descrição | Obrig. | Evolução |
ttv_rec_movto_cta_corren | recid | >>>>>>9 | O recid do movimento da tt_movto_cta_corren_import que apresentou o erro. | Sim | |
ttv_num_mensagem | integer | >>>>,>>9 | Número da mensagem de erro. | Sim | |
ttv_des_mensagem | character | x(50) | Descrição da mensagem do erro. | Sim | |
ttv_des_msg_erro | character | x(60) | Descrição da ajuda do erro. | Sim | |
ttv_cod_parameters | character | x(256) | Parâmetros contidos na mensagem de erro. | Sim | |
Definição:
def temp-table tt_import_movto_valid_cmg no-undo
field ttv_rec_movto_cta_corren as recid format ">>>>>>9" initial ?
field ttv_num_mensagem as integer format ">>>>,>>9" label "Número" column-label "Número Mensagem"
field ttv_des_mensagem as character format "x(50)" label "Mensagem" column-label "Mensagem"
field ttv_des_msg_erro as character format "x(60)" label "Mensagem Erro" column-label "Inconsistência"
field ttv_cod_parameters as character format "x(256)"
.
Execução
Na execução da API ocorrem as seguintes validações:
- 1. Versão de integração
Programa verificará se o programa chamador está integro com a API, e isto ocorre através da verificação da versão de integração passada como parâmetro;
- 2. Existência do Movimento
Será verificado se já existe um movimento igual ao que deverá ser importado;
- 3. Conta Corrente
Será verificado se a conta corrente informada é válida e se o usuário possui permissão para acessá-la;
- 4. Tipo de Movimento
Valida se o Tipo de Movimento informado é RE ou NR;
- 5. Tipo de Transação de Caixa
Valida o tipo de transação de caixa informado e se o usuário possui permissão para acessá-lo;
- 6. Fluxo do Movimento
Valida se o Fluxo do Movimento informado é ENT ou SAI;
- 7. Rateios Financeiros (caso seja informado)
Será validado o Tipo de Fluxo Financeiro, Estabelecimento, Unidade de Negócio e se o total rateado confere com o valor especificado no movimento;
- 8. Cenário Contábil
Se a conta corrente informada controlar cenário, será verificado se o cenário contábil informado para a conta corrente em questão é valido;
- 9. Histórico Padrão
Verifica se o Histórico Padrão é válido;
- 10. Módulo
Valida se o módulo informado existe, se é diferente de Caixa e Bancos e se está habilitado para o período contábil;
- 11. Imposto
Verifica se incide imposto na conta corrente informada. Caso incida imposto, também será validado se existe um imposto para o país e a unidade de federação da conta corrente e do estabelecimento em questão e se existe uma classificação para o imposto informado;
- 12. Indicador Econômico
Serão validados os seguintes itens referentes ao indicador econômico:
- A existência do indicador econômico;
- Se a finalidade econômica da conta corrente está relacionada ao indicador econômico em questão;
- Se o indicador econômico armazena valores para os módulos;
- Se existe cotação entre os indicadores econômicos base e índice;
- Se existe algum parâmetro de conversão entre a moeda base e a moeda índice;
- Se o indicador econômico está habilitado para a data de transação utilizada;
- 13. Finalidade Econômica
Será validado se a finalidade econômica associada ao indicador econômico está habilitada para a Unidade Organizacional e também se existem finalidades disponíveis para a Unidade Organizacional;
- 14. Apropriações Contábeis
Será validado a Conta Contábil, Indicador da Natureza de Lançamento Contábil, Plano de Contas, Estabelecimento, Unidade de Negócio, Plano de Centro de Custo e Centro de Custo (caso a conta contábil utilize centros de custo).
Leitura e Criação dos Registros
Na execução da API, serão lidos os registros da tabela temporária na seguinte ordem:
- Movimento de Conta Corrente;
- Apropriações Contábeis;
- Rateios Financeiros.
Definição das variáveis utilizadas na chamada do programa cmg719zf:
Def var log_print_imported_nok as logical initial yes.
Def var log_print_imported as logical initial yes.
Exemplo de criação de movimentos de conta corrente com apropriações e rateios financeiros:
/** Movimento 1 **/
create tt_movto_cta_corren_import.
assign tt_movto_cta_corren_import.tta_cod_cta_corren = "001-9"
tt_movto_cta_corren_import.tta_dat_movto_cta_corren = 01/02/2004
tt_movto_cta_corren_import.tta_num_seq_movto_cta_corren = 10
tt_movto_cta_corren_import.tta_ind_tip_movto_cta_corren = "RE"
tt_movto_cta_corren_import.tta_cod_tip_trans_cx = "COBRBANC"
tt_movto_cta_corren_import.tta_ind_fluxo_movto_cta_corren = "ENT"
tt_movto_cta_corren_import.tta_cod_cenar_ctbl = ""
tt_movto_cta_corren_import.tta_cod_histor_padr = "Padrao"
tt_movto_cta_corren_import.tta_val_movto_cta_corren = 100.00
tt_movto_cta_corren_import.tta_cod_docto_movto_cta_bco = "doc1"
tt_movto_cta_corren_import.tta_cod_modul_dtsul = "CMG"
tt_movto_cta_corren_import.ttv_ind_erro_valid = "Não"
tt_movto_cta_corren_import.tta_des_histor_padr = "zzzzz"
tt_movto_cta_corren_import.ttv_rec_movto_cta_corren = recid(tt_movto_cta_corren_import).
/* 1ª apropriação do movimento 1 */
CREATE tt_aprop_ctbl_cmg_imp.
ASSIGN tt_aprop_ctbl_cmg_imp.ttv_rec_movto_cta_corren = RECID(tt_movto_cta_corren_import)
tt_aprop_ctbl_cmg_imp.tta_ind_natur_lancto_ctbl = "CR"
tt_aprop_ctbl_cmg_imp.tta_cod_plano_cta_ctbl = "Geral"
tt_aprop_ctbl_cmg_imp.tta_cod_cta_ctbl = "121001"
tt_aprop_ctbl_cmg_imp.tta_cod_estab = "JLE"
tt_aprop_ctbl_cmg_imp.tta_cod_unid_negoc = "ADM"
tt_aprop_ctbl_cmg_imp.tta_cod_plano_ccusto = ""
tt_aprop_ctbl_cmg_imp.tta_cod_ccusto = ""
tt_aprop_ctbl_cmg_imp.tta_val_movto_cta_corren = 30.00
tt_aprop_ctbl_cmg_imp.ttv_rec_aprop_ctbl_cmg = RECID(tt_aprop_ctbl_cmg_imp).
/*Valore em outras moedas(finalidades) referente a 1ª Apropriação*/
CREATE tt_val_aprop_ctbl_cmg_import.
ASSIGN tt_val_aprop_ctbl_cmg_import.tta_cod_finalid_econ = "Geren"
tt_val_aprop_ctbl_cmg_import.tta_dat_cotac_indic_econ =01/02/2004
tt_val_aprop_ctbl_cmg_import.tta_val_cotac_indic_econ = 2.5
tt_val_aprop_ctbl_cmg_import.tta_val_movto_cta_corren = 12.00
tt_val_aprop_ctbl_cmg_import.ttv_rec_movto_cta_corren = RECID(tt_movto_cta_corren_import)
tt_val_aprop_ctbl_cmg_import.ttv_rec_aprop_ctbl_cmg = RECID(tt_aprop_ctbl_cmg_imp)
tt_val_aprop_ctbl_cmg_import.ttv_rec_val_aprop_ctbl_cmg = RECID(tt_val_aprop_ctbl_cmg_import).
/* 2ª apropriação do movimento 1 */
CREATE tt_aprop_ctbl_cmg_imp.
ASSIGN tt_aprop_ctbl_cmg_imp.ttv_rec_movto_cta_corren = RECID(tt_movto_cta_corren_import)
tt_aprop_ctbl_cmg_imp.tta_ind_natur_lancto_ctbl = "CR"
tt_aprop_ctbl_cmg_imp.tta_cod_plano_cta_ctbl = "Geral"
tt_aprop_ctbl_cmg_imp.tta_cod_cta_ctbl = "121001"
tt_aprop_ctbl_cmg_imp.tta_cod_estab = "JLE"
tt_aprop_ctbl_cmg_imp.tta_cod_unid_negoc = "ESC"
tt_aprop_ctbl_cmg_imp.tta_cod_plano_ccusto = ""
tt_aprop_ctbl_cmg_imp.tta_cod_ccusto = ""
tt_aprop_ctbl_cmg_imp.tta_val_movto_cta_corren = 70.00
tt_aprop_ctbl_cmg_imp.ttv_rec_aprop_ctbl_cmg = RECID(tt_aprop_ctbl_cmg_imp).
/*Valore em outras moedas(finalidades) referente a 1ª Apropriação*/
CREATE tt_val_aprop_ctbl_cmg_import.
ASSIGN tt_val_aprop_ctbl_cmg_import.tta_cod_finalid_econ = "Geren"
tt_val_aprop_ctbl_cmg_import.tta_dat_cotac_indic_econ =01/02/2004
tt_val_aprop_ctbl_cmg_import.tta_val_cotac_indic_econ = 2.5
tt_val_aprop_ctbl_cmg_import.tta_val_movto_cta_corren = 28.00
tt_val_aprop_ctbl_cmg_import.ttv_rec_movto_cta_corren = RECID(tt_movto_cta_corren_import)
tt_val_aprop_ctbl_cmg_import.ttv_rec_aprop_ctbl_cmg = RECID(tt_aprop_ctbl_cmg_imp)
tt_val_aprop_ctbl_cmg_import.ttv_rec_val_aprop_ctbl_cmg = RECID(tt_val_aprop_ctbl_cmg_import).
/* 1º rateio financeiro do movimento 1 */
create tt_rat_financ_cmg_import.
assign tt_rat_financ_cmg_import.ttv_rec_movto_cta_corren = recid(tt_movto_cta_corren_import).
tt_rat_financ_cmg_import.tta_cod_estab = "JLE"
tt_rat_financ_cmg_import.tta_cod_unid_negoc = "100"
tt_rat_financ_cmg_import.tta_cod_tip_fluxo_financ = "1.1.4"
tt_rat_financ_cmg_import.ttv_val_movto_cta_corren = 35.00.
/* 2º rateio financeiro do movimento 1 */
create tt_rat_financ_cmg_import.
assign tt_rat_financ_cmg_import.ttv_rec_movto_cta_corren = recid(tt_movto_cta_corren_import).
tt_rat_financ_cmg_import.tta_cod_estab = "JLE"
tt_rat_financ_cmg_import.tta_cod_unid_negoc = "999"
tt_rat_financ_cmg_import.tta_cod_tip_fluxo_financ = "1.5.1"
tt_rat_financ_cmg_import.ttv_val_movto_cta_corren = 40.00.
/* 3º rateio financeiro do movimento 1 */
create tt_rat_financ_cmg_import.
assign tt_rat_financ_cmg_import.ttv_rec_movto_cta_corren = recid(tt_movto_cta_corren_import).
tt_rat_financ_cmg_import.tta_cod_estab = "JLE"
tt_rat_financ_cmg_import.tta_cod_unid_negoc = "200"
tt_rat_financ_cmg_import.tta_cod_tip_fluxo_financ = "1.8.2"
tt_rat_financ_cmg_import.ttv_val_movto_cta_corren = 25.00.
/** Movimento 2 **/
create tt_movto_cta_corren_import.
assign tt_movto_cta_corren_import.tta_cod_cta_corren = "002-4"
tt_movto_cta_corren_import.tta_dat_movto_cta_corren = 01/02/2004
tt_movto_cta_corren_import.tta_num_seq_movto_cta_corren = 20
tt_movto_cta_corren_import.tta_ind_tip_movto_cta_corren = "RE"
tt_movto_cta_corren_import.tta_cod_tip_trans_cx = "COBRBANC"
tt_movto_cta_corren_import.tta_ind_fluxo_movto_cta_corren = "SAI"
tt_movto_cta_corren_import.tta_cod_cenar_ctbl = ""
tt_movto_cta_corren_import.tta_cod_histor_padr = "Padrao"
tt_movto_cta_corren_import.tta_val_movto_cta_corren = 300.00
tt_movto_cta_corren_import.tta_cod_docto_movto_cta_bco = "doc2"
tt_movto_cta_corren_import.tta_cod_modul_dtsul = "CMG"
tt_movto_cta_corren_import.ttv_ind_erro_valid = "Não"
tt_movto_cta_corren_import.tta_des_histor_padr = "zzzzz"
tt_movto_cta_corren_import.ttv_rec_movto_cta_corren = recid(tt_movto_cta_corren_import).
/* 1ª apropriação do movimento 2 */
CREATE tt_aprop_ctbl_cmg_imp.
ASSIGN tt_aprop_ctbl_cmg_imp.ttv_rec_movto_cta_corren = RECID(tt_movto_cta_corren_import)
tt_aprop_ctbl_cmg_imp.tta_ind_natur_lancto_ctbl = "DB"
tt_aprop_ctbl_cmg_imp.tta_cod_plano_cta_ctbl = "Geral"
tt_aprop_ctbl_cmg_imp.tta_cod_cta_ctbl = "121001"
tt_aprop_ctbl_cmg_imp.tta_cod_estab = "JLE"
tt_aprop_ctbl_cmg_imp.tta_cod_unid_negoc = "ADM"
tt_aprop_ctbl_cmg_imp.tta_cod_plano_ccusto = ""
tt_aprop_ctbl_cmg_imp.tta_cod_ccusto = ""
tt_aprop_ctbl_cmg_imp.tta_val_movto_cta_corren = 300.00
tt_aprop_ctbl_cmg_imp.ttv_rec_aprop_ctbl_cmg = RECID(tt_aprop_ctbl_cmg_imp).
/*Valore em outras moedas(finalidades) referente a 1ª Apropriação*/
CREATE tt_val_aprop_ctbl_cmg_import.
ASSIGN tt_val_aprop_ctbl_cmg_import.tta_cod_finalid_econ = "Geren"
tt_val_aprop_ctbl_cmg_import.tta_dat_cotac_indic_econ =01/02/2004
tt_val_aprop_ctbl_cmg_import.tta_val_cotac_indic_econ = 3
tt_val_aprop_ctbl_cmg_import.tta_val_movto_cta_corren = 100.00
tt_val_aprop_ctbl_cmg_import.ttv_rec_movto_cta_corren = RECID(tt_movto_cta_corren_import)
tt_val_aprop_ctbl_cmg_import.ttv_rec_aprop_ctbl_cmg = RECID(tt_aprop_ctbl_cmg_imp)
tt_val_aprop_ctbl_cmg_import.ttv_rec_val_aprop_ctbl_cmg = RECID(tt_val_aprop_ctbl_cmg_import).
/* Os rateios financeiros do movimento 2 não foram informados,
pois eles serão gerados automaticamente pela API */
/** Movimento 3 **/
create tt_movto_cta_corren_import.
assign tt_movto_cta_corren_import.tta_cod_cta_corren = "002-4"
tt_movto_cta_corren_import.tta_dat_movto_cta_corren = 01/02/2004
tt_movto_cta_corren_import.tta_num_seq_movto_cta_corren = 30
tt_movto_cta_corren_import.tta_ind_tip_movto_cta_corren = "RE"
tt_movto_cta_corren_import.tta_cod_tip_trans_cx = "COBRBANC"
tt_movto_cta_corren_import.tta_ind_fluxo_movto_cta_corren = "ENT"
tt_movto_cta_corren_import.tta_cod_cenar_ctbl = ""
tt_movto_cta_corren_import.tta_cod_histor_padr = "Padrao"
tt_movto_cta_corren_import.tta_val_movto_cta_corren = 500.00
tt_movto_cta_corren_import.tta_cod_docto_movto_cta_bco = "doc2"
tt_movto_cta_corren_import.tta_cod_modul_dtsul = "CMG"
tt_movto_cta_corren_import.ttv_ind_erro_valid = "Não"
tt_movto_cta_corren_import.tta_des_histor_padr = "zzzzz"
tt_movto_cta_corren_import.ttv_rec_movto_cta_corren = recid(tt_movto_cta_corren_import).
/* 1ª apropriação do movimento 2 */
CREATE tt_aprop_ctbl_cmg_imp.
ASSIGN tt_aprop_ctbl_cmg_imp.ttv_rec_movto_cta_corren = RECID(tt_movto_cta_corren_import)
tt_aprop_ctbl_cmg_imp.tta_ind_natur_lancto_ctbl = "CR"
tt_aprop_ctbl_cmg_imp.tta_cod_plano_cta_ctbl = "Geral"
tt_aprop_ctbl_cmg_imp.tta_cod_cta_ctbl = "121001"
tt_aprop_ctbl_cmg_imp.tta_cod_estab = "JLE"
tt_aprop_ctbl_cmg_imp.tta_cod_unid_negoc = "ADM"
tt_aprop_ctbl_cmg_imp.tta_cod_plano_ccusto = ""
tt_aprop_ctbl_cmg_imp.tta_cod_ccusto = ""
tt_aprop_ctbl_cmg_imp.tta_val_movto_cta_corren = 300.00
tt_aprop_ctbl_cmg_imp.ttv_rec_aprop_ctbl_cmg = RECID(tt_aprop_ctbl_cmg_imp).
/* Os rateios financeiros e os valores do movimento 3 não foram informados,
pois eles serão gerados automaticamente pela API */
output stream s_1 to c:\tmp\errosimp.txt paged page-size 66.
run prgfin/cmg/cmg719zg.py persistent set v_hdl_program.
run pi_main_cmg719zg in v_hdl_program (input 1,
input yes,
input yes,
input-output table tt_movto_cta_corren_import,
Input table tt_aprop_ctbl_cmg_imp,
input table tt_val_aprop_ctbl_cmg_import,
input table tt_val_aprop_cmg_cambial,
Input table tt_rat_financ_cmg_import,
output table tt_import_movto_valid_cmg).
delete procedure v_hdl_program.
output stream s_1 close.
/* fim */
#trackbackRdf ($trackbackUtils.getContentIdentifier($page) $page.title $trackbackUtils.getPingUrl($page))