Documento de API

Produto:	Datasul
Ocorrência:	Documentação de API
Nome Físico	prgfin/cmg/

cmg719zf

...

cmg719zg

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 new shared stream s_1.

Def var log_print_imported_nok as logical initial yes.

Def var log_print_imported as logical initial yes.

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_3 in v_hdl_program (input 1,

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

2,

input log_print_imported_nok,

input log_print_imported,

input-output table tt_movto_cta_corren_import_3,

Input table tt_aprop_ctbl_cmg_imp_3,

input table tt_val_aprop_ctbl_cmg_import_3,

input table tt_val_aprop_cmg_cambial_3,

Input table tt_rat_financ_cmg_import_3,

output table tt_import_movto_valid_cmg_3).

output close.

delete procedure v_hdl_program.

Parâmetros

Parâmetro	Descrição
p_num_vers_integr_api	Será utilizado

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_3	Esta temp-table conterá todos os movimentos que devam ser importados para o Caixa e Bancos.
tt_aprop_ctbl_cmg_imp_3	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_3	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_3	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_3	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_3	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_3 todos os erros encontrados ou mensagens de alerta gerados durante o processo de validação dos movimentos.

...

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_3	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

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_3, onde a leitura deverá ser feita pelo atributo ttv_cod_

rec

id_movto_cta_corren.

Exemplo:

For each tt_movto_cta_corren_import_3 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 =

_3.ttv_ind_erro_valid = “Sim”: For each tt_import_movto_valid_cmg_3 no-lock Where tt_import_movto_valid_cmg_3.ttv_cod_id_movto_cta_corren = tt_movto_cta_corren_import_3.ttv_cod_id_movto_cta_corren: Disp tt_import_movto_valid_cmg_3. 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_cod_id_movto_cta_corren	character	x(80)	Deverá conter a string do rowid da temp-table tt_movto_cta_corren_import_3. Exemplo: assign tt_movto_cta_corren_import_3.ttv_cod_id_movto_cta_corren = STRING(ROWID(tt_movto_cta_corren_import_3)).	Sim
tta_ind_tip_docto_livro_cx	character	x(20)	Tipo de Documento para o Livro Caixa do Produtor Rural. Valores permitidos: 1 - Nota Fiscal 2 - Fatura 3 - Recibo 4 - Contrato 5 - Folha de Pagamento 6 - Outros.	Não
tta_ind_tip_lancto_livro_cx	character	x(45)	Tipo de Lançamento para o Livro Caixa do Produtor Rural. Valores permitidos: 1 - Receita Atividade Rural 2 - Despesas de Custeio e Investimentos 3 - Prod Entreg Ref Adiant Recursos Fin.	Não
tta_cod_id_participan	character	x(14)	ID do Participante para o Livro Caixa do Produtor Rural. É o CPF/CNPJ do comprador ou do vendedor (apenas números).	Não

*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 “”.

OBS: Os campos tta_ind_tip_docto_livro_cx, tta_ind_tip_lancto_livro_cx e tta_cod_id_participan são referentes a legislação LCDPR (Livro Caixa do Produtor Rural). Esses campos devem ser preenchidos apenas para os movimentos da conta corrente do módulo Caixa e Bancos (CMG). Para os módulos Contas a Receber e Contas a Pagar essas informações são buscadas diretamente dos módulos para realizar a extração para o módulo MLF - Módulo de Layout Fiscal.

Definição:

def temp-table tt_movto_cta_corren_import

...

Disp tt_import_movto_valid_cmg.

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

...

_3 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 "999999999" initial 0 label "ID Movto Conta" column-label "ID Movto Conta"

field ttv_cod_id_movto_cta_corren as character format "x(80)"

field tta_ind_tip_docto_livro_cx as character format "x(20)" initial "Outros" label "Tipo Documento Livro" column-label "Tipo Documento Livro"

field tta_ind_tip_lancto_livro_cx as character format "x(45)" label "Tipo Lancamento Livr" column-label "Tipo Lancamento Livr"

field tta_cod_id_participan as character format "x(14)" label "ID Participante" column-label "ID Participante"

index tt_erro

ttv_ind_erro_valid ascending

*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