Histórico da Página
Documento de API
Produto: | Datasul |
Ocorrência: | Documentação de API |
Nome Físico | Prgfin/fgl/ |
fgl900zo |
Objetivo
Atualizar o módulo de Contabilidade com Lotes de outros módulos, tanto através de arquivos ASCII quanto diretamente do módulo.
Funcionamento
Na forma padrão, a API é persistida em memória e posteriormente chamada através de uma PI, passando-se as temp-tables carregadas com as informações necessárias.
...
def new shared stream s_1. /*USADO QUANDO EMITE RELATÓRIO É IHUAL A SIM*/
run prgfin/fgl/fgl900zo.py persistent set v_hdl_api.
run pi_main_api_lote_ctbl_recebto_1 2 in v_hdl_api
(input 3,
...
input-output table tt_integr_lote_ctbl_1new,
input-output table tt_integr_lancto_ctbl_1new,
input-output table tt_integr_item_lancto_ctbl_1new,
input-output table tt_integr_aprop_lancto_ctbl_1new,
input-output table tt_integr_ctbl_valid_1new,
input-output table tt_api_params_generic_api).
run pi_finalizar_fgl900zo in v_hdl_api.
delete procedure v_hdl_api.
Os parâmetros de entrada são:
Parâmetros:
- Número da versão de Integração (atualmente = 3)
- Tratamento do Erro
...
- Tabela Temporária com os dados do(s) Lote(s) à ser(em) gerado(s);
- Tabela Temporária com os dados do(s) Lançamento(s) à ser(em) gerado(s);
- Tabela Temporária com os dados do(s) Iten(s) à ser(em) gerado(s);
- Tabela Temporária com os dados da(s) Apropriaçõ(es) à ser(em) gerada(s);
- Tabela Temporária que conterá os possíveis erros da integração;
- Tabela Genérica contendo campos de entradas ou saídas que poderão estar relacionadas a qualquer uma das temp-tables acima citadas.
Tabelas Temporárias
Nos atributos das tabelas temporárias de entrada e saída:
1) Temp-table de Lotes Contábeis
Tabela Temporária | Descrição | Entrada/Saída |
tt_integr_lote_ctbl_ |
new | Conterá a capa do lote; Não é obrigatório o número do lote, pois o programa de recebimento atribuirá o número de lote correto. | Entrada e Saída |
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
tta_cod_modul_dtsul | character | x(3) | Módulo |
| |||
tta_num_lote_ctbl | Integer | >>>,>>>,>>9 | Lote Contábil |
tta_des_lote_ctbl | character | x(40) | Descrição Lote |
tta_cod_empresa | character | x(3) | Empresa |
tta_dat_lote_ctbl | date | 99/99/9999 | Data Lote Contábil |
ttv_ind_erro_valid | character | x(8) |
tta_log_integr_ctbl_online | logical | Sim/Não | Integração Online |
ttv_ |
row_integr_lote_ctbl |
recid
>>>>>>9
rowid |
def def temp-table tt_integr_lote_ctbl_1 no-undo
...
ttv_rec_integr_lote_ctbl ascending.
2) Temp-table de Lançamentos Contábeis
Tabela Temporária | Descrição | Entrada/Saída |
tt_integr_lancto_ctbl_1 | Nível que agrupa os itens de lançamento (DB e CR) para um mesmo cenário e data. | Entrada e Saída |
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
tta_cod_cenar_ctbl | character | x(8) | Cenário Contábil |
| |||
tta_log_lancto_conver | logical | Sim/Não | Lançamento Conversão |
tta_log_lancto_apurac_restdo | logical | Sim/Não | Lançamento Apuração |
tta_cod_rat_ctbl | character | x(8) | Rateio Contábil |
ttv_rec_integr_lote_ctbl | recid | >>>>>>9 |
tta_num_lancto_ctbl | integer | >>,>>>,>>9 | Lançamento Contábil |
ttv_ind_erro_valid | character | x(8) |
tta_dat_lancto_ctbl | date | 99/99/9999 | Data Lançamento |
ttv_rec_integr_lancto_ctbl | recid | >>>>>>9 |
...
def temp-table tt_integr_lancto_ctbl_1 no-undo
...
ttv_rec_integr_lancto_ctbl ascending.
3) Temp-table de Itens de Lançamento Contábeis
Tabela Temporária | Descrição | Entrada/Saída |
tt_integr_item_lancto_ctbl_1 | Devem conter os débitos e os créditos nas diversas contas contábeis, estabelecimento, centro de custo, unidade de negócio. | Entrada e Saída |
(*) A partir da 5.07A o estabelecimento passa a ter cinco dígitos.
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
ttv_rec_integr_lancto_ctbl | recid | >>>>>>9 |
| |||
tta_num_seq_lancto_ctbl | integer | >>>>9 | Sequência Lançto |
tta_ind_natur_lancto_ctbl | character | x(2) | Natureza |
tta_cod_plano_cta_ctbl | character | x(8) | PlanoContas |
tta_cod_cta_ctbl | character | x(20) | Conta Contábil |
tta_cod_plano_ccusto | character | x(8) | Plano Centros Custo |
tta_cod_estab | character | x(3) / x(5)* | Estabelecimento |
tta_cod_unid_negoc | character | x(3) | Unid Negócio |
tta_cod_histor_padr | character | x(8) | Histórico Padrão |
tta_des_histor_lancto_ctbl | character | x(2000) | Histórico Contábil |
tta_cod_espec_docto | character | x(3) | Espécie Documento |
tta_dat_docto | date | 99/99/9999 | Data Documento |
tta_des_docto | character | x(25) | Número Documento |
tta_cod_imagem | character | x(30) | Imagem |
tta_cod_indic_econ | character | x(8) | Moeda |
tta_dat_lancto_ctbl | date | 99/99/9999 | Data Lançamento |
tta_qtd_unid_lancto_ctbl | decimal | >>,>>>,>>9.99 |
Quantidade
Quantidade | |||
tta_val_lancto_ctbl | decimal | >>>>>,>>>,>>9.99 | Valor Lançamento |
tta_num_seq_lancto_ctbl_cpart | integer | >>>9 | Sequência CPartida |
ttv_ind_erro_valid | character | X(8) |
tta_cod_ccusto | character | x(11) | Centro Custo |
tta_cod_proj_financ | character | x(20) | Projeto |
ttv_rec_integr_item_lancto_ctbl | recid |
>>>>>>9 |
def temp-table tt_integr_item_lancto_ctbl_1 no-undo
...
ttv_rec_integr_item_lancto_ctbl ascending.
4) Temp-table de Apropriações Contábeis
Tabela Temporária | Descrição | Entrada/Saída |
tt_integr_aprop_lancto_ctbl_1 | Devem conter as aberturas dos créditos ou débitos por finalidades econômicas. | Entrada e Saída |
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
tta_cod_finalid_econ | character | x(10) | Finalidade |
tta_cod_unid_negoc | character | x(3) | Unid Negócio |
tta_cod_plano_ccusto | character | x(8) | Plano Centros Custo |
tta_qtd_unid_lancto_ctbl | decimal | >>,>>>,>>9.99 | Quantidade |
tta_val_lancto_ctbl | decimal | >>>>>,>>>,>>9.99 | Valor Lançamento |
tta_num_id_aprop_lancto_ctbl | integer | 9999999999 | Apropriacao Lançto |
ttv_rec_integr_item_lancto_ctbl | recid | >>>>>>9 |
tta_dat_cotac_indic_econ | date | 99/99/9999 | Data Cotação |
tta_val_cotac_indic_econ | decimal | >>>>,>>9.9999999999 | Cotação |
ttv_ind_erro_valid | character | X(8) |
tta_ind_orig_val_lancto_ctbl | character | X(10) | Origem Valor |
tta_cod_ccusto | character | X(11) | Centro Custo |
ttv_rec_integr_aprop_lancto_ctbl | recid | >>>>>>9 |
def temp-table tt_integr_aprop_lancto_ctbl_1 no-undo
...
5) Temp-table com os Erros da Integração
Tabela Temporária | Descrição | Entrada/Saída |
tt_integr_ctbl_valid_1 | Tabela com erros | Entrada e Saída |
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
ttv_rec_integr_ctbl | recid | >>>>>>9 |
ttv_num_mensagem | integer | >>>>,>>9 | Número Mensagem |
ttv_ind_pos_erro | character | X(8) | Posição |
def new shared temp-table tt_integr_ctbl_valid_1 no-undo
...
ttv_num_mensagem ascending.
6) Temp-table genérica para passagem de campos relacionadas a qualquer uma das temp-tables acima, utilizada para evitar que a API em questão tenha novas evoluções caso campos novos sejam necessários.
Tabela Temporária | Descrição | Entrada/Saída |
tt_params_generic_api | Tabela genérica de campos | Entrada e Saída |
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
ttv_rec_id | recid | >>>>>>9 | RecId de outro registro de temp-table que está relacionada |
ttv_cod_tabela | character | x(100) | Nome da tabela relacionada |
ttv_cod_campo | character | x(100) | Nome do campo a ser passado |
ttv_cod_valor | character | x(100) | Valor do campo, sempre deverá ser convertido para Character. |
def temp-table tt_params_generic_api no-undo
...
ttv_cod_campo ascending.
Lista de Campo(s) que a API fgl900zo processa e que podem ser passados como parâmetro através da tamp-table tt_params_generic_api:
Código do Participante: Relacionado a tabela Item Lançamento Contábil (tt_integr_item_lancto_ctbl_1). Na criação de cada registro da tabela tt_integr_item_lancto_ctbl_1, será adicionado um campo correspondente na tt_params_generic_api, somente caso seja necessário passar esta informação.
...
tt_params_generic_api.ttv_cod_valor = [Valor do Código do Participante em formato caracter].
Relacionamento entre as tabelas temporárias:
...
2 Armazenar no atributo ttv_rec_integr_aprop_lancto_ctbl o recid(TT_INTEGR_APROP_LANCTO_CTBL_1)
Observações:
- Se o atributo tt_integr_lote_ctbl.ttv_ind_erro_valid = “Não”, o lote está na contabilidade do EMS 5.0
...
- Para que se tenha o rastreamento das apropriações geradas, a temp-table de apropriação retorna o atributo tta_num_id_aprop_lancto_ctbl com o valor do “token” da apropriação gerada na contabilidade;