...
Produto: | Datasul |
Ocorrência: | Documentação de API |
Nome Físico | Prgfin/fgl/fgl905zb |
Objetivo
Retornar os valores dos saldos realizado e empenhado da tabela sdo_ctbl, utilizada a partir da release 5.05.
Funcionamento
Na forma padrão, realiza-se a chamada através de um comando RUN normal, passando-se os parâmetros com as informações necessárias.
...
run Prgfin/fgl/fgl905zb.py (Input 1, Input table tt_input_leitura_sdo, output table tt_retorna_sdo_ctbl, output table tt_log_erros). |
Parâmetros
Parâmetro | Descrição |
num_vers_integr_api | Versão de Integração da API; |
tt_input_leitura_sdo | Tabela temporária que contém todas as faixas de dados para que seja realizada a leitura na tabela de saldos; |
tt_retorna_sdo_ctbl | Retorna os dados referentes ao saldo de acordo com as faixas passadas na temp-table anterior; |
tt_log_erros | Retorna para o usuário, as informações de erros ocorridos durante o processo de leitura de saldo; |
Retorno
A API retornará informações nas tabelas temporárias tt_log_erros e tt_retorna_sdo_ctbl.
Tabelas Temporárias
O programa que irá executar a API de leitura de saldos deverá conter e criar as seguintes tabelas temporárias:
Nos atributos das tabelas temporárias de entrada e saída:
1) Tabela leitura saldo
Tabela Temporária | Descrição | Entrada/Saída |
tt_input_leitura_sdo | | Entrada |
Atributo | Tipo | Formato | Descrição | Obrigatório | EvoluçãoEvoluçã |
ttv_cod_label | character | x(8) | Nome do atributo que será atribuído para ttv_des_conteudo. É possível criar as seguintes informações para busca de saldo: "Empresa" , "Cenário", "Finalidade Econômica" , "Plano Contas", "Plano Centro Custo" , "Considera apenas Ccusto Sintético" , "Conta e Ccusto", Faixas de Leitura de Saldos : "Data Inicial", "Data Final", "Conta Contabil Inicial" , "Conta Contabil Final" , "Projeto Inicial" , "Projeto Final" , "Estabelecimento Inicial" , "Estabelecimento Final" , "UN Inicial" , "UN Final, "Centro Custo Inicial" , "Centro Custo Final" , Faixas de PARTE FIXA E EXCEÇÃO : "Parte Fixa Conta Contábil", "Parte Fixa Centro Custo", "Parte Fixa Projeto", "Exceção Conta Contábil", "Exceção Centro Custo", "Exceção Projeto", Parâmetros Execução Orçamentária: "Unidade Orçamentária", "Valores Empenhados", "Cenário Orctário", "Unidade Orçamentária2", "Sequencia Orcto Contábil", "Versão Orçamento Contábil". Além das faixas, é necessário criar os seguintes registros na temp-table: "Apuração de Resultados", "Leitura", "Condição". | | |
ttv_des_conteudo | character | x(40) | Valor do atributo: - Considera apuração de resultado – (SIM/NÃO);
- Considera apenas Ccusto Sintético – (SIM/NÃO);
- Leitura – (FOR EACH, FIND FIRST, FIND LAST);
- Condição – (IGUAL, MENOR, MENOR OU IGUAL, MAIOR OU IGUAL E MENOR OU IGUAL).
- Conta e Ccusto = “”
- Valores Empenhados – yes
Observações: - A condição de leitura MAIOR OU IGUAL E MENOR OU IGUAL utilizar somente com a forma de leitura FOR EACH e informar atributos “Data Final” e “Data Inicial”.
- Não informando a forma e condição de leitura, assume Leitura = “FOR EACH” e Condição = “ IGUAL”.
As condições de leitura (IGUAL, MENOR, MENOR OU IGUAL) são utilizadas para validação do atributo “Data Final” informado no arquivo. | | |
ttv_num_seq_1 | integer | >>>,>>9 | Número seqüencial que identifica o conjunto a que pertence o atributo | | |
ttv_num_seq_2 | integer | >>>>,>>9 | Segundo número seqüencial que identifica o conjunto do atributo | | |
...
ttv_num_seq_1 ascending .
2) Tabela retorna saldo contábil
Tabela Temporária | Descrição | Entrada/Saída |
tt_retorna_sdo_ctbl | | Saída |
(*) A partir da 5.07A o estabelecimento passa a ter cinco dígitos.
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
tta_num_seq | integer | >>>,>>9 | Número de seqüência do Registro | | |
tta_cod_empresa | character | x(3) | Código da Empresa | | |
tta_cod_finalid_econ | character | x(10) | Código da Finalidade Econômica | | |
tta_cod_plano_cta_ctbl | character | x(8) | Código do Plano de Contas | | |
tta_cod_cta_ctbl | character | x(20) | Código da Conta Contábil | | |
tta_cod_plano_ccusto | character | x(8) | Código do Plano Centros Custo | | |
tta_cod_ccusto | character | x(11) | Código do Centro de Custo | | |
tta_cod_proj_financ | character | x(20) | Código do Projeto | | |
tta_cod_cenar_ctbl | character | x(8) | Código Cenário Contábil | | |
tta_cod_estab | character | x(3) / x(5)* | Código Estabelecimento | | |
tta_cod_unid_negoc | character | x(3) | Código Unidade Negócio | | |
tta_dat_sdo_ctbl | date | 99/99/9999 | Data do Saldo Contábil | | |
tta_val_sdo_ctbl_db | decimal | ->>,>>>,>>>,>>9.99 | Valor do Movimento de Débito | | |
tta_val_sdo_ctbl_cr | decimal | ->>,>>>,>>>,>>9.99 | Valor do Movimento de Crédito | | |
val_sdo_ctbl_fim fim | decimal | ->>,>>>,>>>,>>9.99 | Valor do Saldo Contábil Final | | |
tta_val_apurac_restdo | decimal | ->>,>>>,>>>,>>9.99 | Valor Apuração de Resultado | | |
tta_val_apurac_restdo_db | decimal | ->>,>>>,>>>,>>9.99 | Valor Apuração Resultado Débito | | |
tta_val_apurac_restdo_cr | decimal | ->>,>>>,>>>,>>9.99 | Valor Apuração Resultado Crédito | | |
tta_val_apurac_restdo_acum | decimal | ->>>,>>>,>>>,>>9.99 | Valor Apuração Resultado Final | | |
tta_val_sdo_ctbl_db_sint | decimal | ->>,>>>,>>>,>>9.99 | Valor Movimento Débito Sintético | | |
tta_val_sdo_ctbl_cr_sint | decimal | ->>,>>>,>>>,>>9.99 | Valor Movimento Crédito Sintético | | |
tta_val_sdo_ctbl_fim_sint | decimal | ->>>,>>>,>>>,>>9.99 | Valor Saldo Sintético | | |
tta_val_apurac_restdo_sint | decimal | ->>,>>>,>>>,>>9.99 | Valor Apuração de Resultado Sintético | | |
tta_val_apurac_restdo_sint_db | decimal | ->>,>>>,>>>,>>9.99 | Valor Apuração de Resultado Sintético Débito | | |
tta_val_apurac_restdo_sint_cr | decimal | ->>,>>>,>>>,>>9.99 | Valor Apuração de Resultado Sintético Crédito | | |
tta_val_apurac_restdo_sint_acum | decimal | ->>>,>>>,>>>,>>9.99 | Valor Apuração Resultado Final Sintético | | |
tta_val_movto_empenh | decimal | ->>,>>>,>>>,>>9.99 | Valor Movimento Empenhado | | |
tta_qtd_sdo_ctbl_db | decimal | >>>,>>>,>>9.99 | Quantidade Débito | | |
tta_qtd_sdo_ctbl_cr | decimal | >>>,>>>,>>9.99 | Quantidade Crédito | | |
tta_qtd_sdo_ctbl_fim | decimal | ->>>,>>>,>>9.99 | Quantidade Final | | |
ttv_val_movto_ctbl | decimal | >>>,>>>,>>>,>>9.99 | Valor movimento contábil | | |
tta_qtd_movto_empenh | decimal | ->>>>,>>9.9999 | Quantidade Movimento Empenhado | | |
def temp-table tt_retorna_sdo_ctbl no-undo
...
field tta_cod_estab as character format "x(35)" label "Estabelecimento" column-label "Estab"
...
field tta_qtd_sdo_ctbl_db as db as decimal format ">>>,>>>,>>9.99" decimals 2 initial 0 label "Quantidade DB" column-label "Quantidade DB"
...
tta_cod_cenar_ctbl ascending
tta_cod_estab ascendingestab ascending
tta_cod_unid_negoc ascending
...
index tt_id2
tta_cod_empresa ascendingempresa ascending
tta_cod_finalid_econ ascending
...
index tt_seq
tta_num_seq ascendingseq ascending.
.
3) Tabela de erros
Tabela Temporária | Descrição | Entrada/Saída |
tt_log_erros | Retorna os erros do processo. | Saída |
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
ttv_num_seq | integer | >>>,>>9 | Seqüência | | |
ttv_num_cod_erro | integer | >>>>,>>9 | Número | | |
ttv_des_erro | character | x(50) | Inconsistência | | |
ttv_des_ajuda | character | x(50) | Ajuda | | |
def temp-table tt_log_erros no-undo
field ttv_num_seq as seq as integer format ">>>,>>9" label "Seqüência" column-label "Seq"
...
field ttv_des_ajuda as character format "x(50)" label "Ajuda" column-label "Ajuda".
.
Exemplo de utilizacão da API de Leitura de Saldos
...
field tta_num_seq as int format ">>>,>>9" init 0 label "Sequência" column-label "NumSeq"
field tta_cod_empresa as empresa as char format "x(3)" label "Empresa" column-label "Empresa"
...
field tta_cod_plano_cta_ctbl as char format "x(8)" label "Plano Contas" column-label "Plano Contas"
field tta_cod_cta_ctbl as ctbl as char format "x(20)" label "Conta Contábil" column-label "Conta Contábil"
field tta_cod_plano_ccusto as char format "x(8)" label "Plano Centros Custo" column-label "Plano Centros Custo"
field tta_cod_ccusto as ccusto as char format "x(11)" label "Centro Custo" column-label "Centro Custo"
...
field tta_cod_cenar_ctbl as char format "x(8)" label "Cenário Contábil" column-label "Cenário Contábil"
field tta_cod_estab as estab as char format "x(35)" label "Estabelecimento" column-label "Estab"
...
field tta_val_apurac_restdo_sint_db as dec format "->>,>>>,>>>,>>9.99" decimals 2 init 0 label "Apur Restdo Sint DB" column-label "Apur Restdo Sint DB"
field field tta_val_apurac_restdo_sint_cr as dec format "->>,>>>,>>>,>>9.99" decimals 2 init 0 label "Apur Restdo Sint CR" column-label "Apur Restdo Sint CR"
field tta_val_apurac_restdo_sint_acum as dec format "->>>>,>>>,>>>,>>9.99" decimals 2 init 0 label "Apur Result Sint" column-label "Apur Result Sint"
field field tta_val_movto_empenh as dec format "->>,>>>,>>>,>>9.99" decimals 9 init 0 label "Movto Empenhado" column-label "Movto Empenhado"
...
tta_cod_finalid_econ ascendingecon ascending
tta_cod_plano_cta_ctbl ascendingctbl ascending
tta_cod_cta_ctbl ascending
...
tta_cod_proj_financ ascending
tta_cod_cenar_ctbl ascendingctbl ascending
tta_cod_estab ascending
...
tta_dat_sdo_ctbl ascending
index tt_seq
tta tta_num_seq ascending.
...
Para Busca de saldo de mais de um período e definindo finalidade, acrescentar os registros abaixo:
CREATE tt_input_leitura_sdo.
...
ttv_num_seq_2 = 6.
CREATE tt_input_leitura_sdo.
ASSIGN ttv_cod_label = "Finalidade Econômica"
ttv ttv_des_conteudo = "corrente"
...