Histórico da Página
...
Produto: | Datasul |
Ocorrência: | Documentação de API |
| Nome Físico | prgfin/fas/fas735zh |
Objetivo
Criar bens patrimoniais no módulo de Ativo Fixo do EMS 5.
...
def var v_hdl_program AS HANDLE NO-UNDO.
def var p_cod_return as char.
def var p_des_mensagem as char format "x(50)".
...
INPUT TABLE tt_criacao_bem_pat_val_resid,
INPUT TABLE tt_criacao_bem_pat_img,
INPUT TABLE tt_criacao_bem_pat_api_7
...
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_cod_matriz_trad_org_ext | Deve ser informada a matriz de tradução de unidade organizacional |
P_cod_matriz_Trad_ccusto_ext | Deve ser informada a matriz de tradução de centros de custo |
P_cod_matriz_trad_finalid_Ext | Deve ser informada a matriz de tradução de finalidade econômica |
P_log_ctbz | Deve ser YES para que o movimento de implantação seja contabilizado. Deve ser NO para que o movimento de implantação NÃO seja contabilizado |
tt_criacao_bem_pat_item_api | Esta temp-table conterá os registros dos itens das notas fiscais vinculadas ao bem. Deverá ser definida conforme os atributos mencionados a seguir, na seção Tabelas Temporárias. |
tt_criacao_bem_pat_val_resid | Esta temp-table conterá os registros sobre os valores residuais do bem patrimonial. Deverá ser definida conforme os atributos mencionados a seguir, na seção Tabelas Temporárias. |
tt_criacao_bem_pat_img | Esta temp-table conterá os registros sobre as imagens do bem patrimonial. Deverá ser definida conforme os atributos mencionados a seguir, na seção Tabelas Temporárias. |
| tt_criacao_bem_pat_api_7 | Esta temp-table contem os registros dos bens patrimoniais que serão criados. |
P_cod_return | Retorna string “OK” se não ocorreram erros. |
P_des_mensagem | Caso tenha ocorrido erro, retorna a mensagem de erro que provocou erro na criação dos bens patrimoniais. Normalmente erros da matriz de tradução são apresentados nesta mensagem. Erros deste tipo inviabilizam a criação de todos os bens patrimoniais na temp-table. |
Observações:
- Devem ser geradas algumas temp-tables no programa que chamará a API. Estas temp-tables conterão as informações sobre os bens patrimoniais que serão implantados no Ativo Fixo.
...
Quando ocorrer algum erro antes da criação dos bens patrimoniais este será retornado na variável p_des_mensagem.
...
Tabela Temporária | Descrição | Entrada/Saída |
tt_criacao_bem_pat_api_7 | Conterá as informações dos bens patrimoniais a serem implantados. | local |
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
tta_cod_unid_organ_ext | character | x(3) | Código da unidade organizacional externa (organizacional externa, ou seja, a empresa a ser traduzida pela matriz de tradução de unidade organizacional). | Sim | |
tta_cod_cta_pat | character | x(18) | Conta Código da conta patrimonial. | Sim | |
tta_num_bem_pat | integer | >>>>>>>>9 | Número do bem patrimonial. Caso seja informado 0 (zero) será atribuído automaticamente o número do próximo bem patrimonial de acordo com parâmetros do ativo fixo. | Não | |
tta_num_seq_bem_pat | integer | >>>>9 | Seqüência Número da sequência do bem patrimonial. (idem Idem observação acima). | Não | |
tta_des_bem_pat | character | x(40) | Descrição do bem patrimonial. | Sim | |
tta_dat_aquis_bem_pat | date | 99/99/9999 | Data de aquisição do bem patrimonial. | Sim | |
tta_cod_plano_ccusto | character | x(8) | Código do plano de centros de custo. | Sim | |
tta_cod_ccusto_ext | character | x(8) | Código do centro de custo externo ( a ser traduzido pela matriz de tradução de centros de custo). | Sim | |
tta_cod_estab_ext | character | x(8) | Código do estabelecimento externo ( a ser traduzido pela matriz de tradução de unidade organizacional). | Sim | |
tta_cod_unid_negoc_ext | character | x(8) | Código da Unidade unidade de negócio responsável pelo bem patrimonial. | Sim | |
tta_cod_finalid_econ_ext | character | x(8) | Código da finalidade externa . (/ moeda do bem patrimonial a ser traduzida pela matriz de tradução de finalidade). | Sim | |
ttv_val_aquis_bem_pat | decimal | ->>,>>>,>>>,>>9.99 | Valor de aquisição do bem patrimonial. Importante: O (o valor do bem patrimonial pode ser positivo no caso de bens patrimoniais do Ativo imobilizado ou negativo se o bem patrimonial referir-se a item do patrimônio líquido). | Sim | |
ttv_log_erro | logical | Sim/Não | Indicador de erro no bem patrimonial. Deve ser criado como “Não” | Sim | |
tta_qtd_bem_pat_represen | decimal | >>>>>>>>9 | Quantidade de bens patrimoniais | Não | |
tta_cdn_fornecedor | Integer | >>>,>>>,>>9 | Código numérico do fornecedor do bem patrimonial | Não | |
tta_cod_docto_entr | character | x(8) | Número da nota fiscal | Não | |
tta_cod_ser_nota | character | x(3) | Série da Nota fiscal | Não | |
tta_num_item_docto_entr | Integer | >>>,>>9 | Número do item da nota fiscal | Não | |
tta_num_id_bem_pat | Integer | >>,>>>,>>9 | Este atributo retorna o número interno do bem patrimonial. Não precisa ter o seu valor informado. Serve apenas como uma referência para localizar o bem patrimonial criado na base de dados. Deve ser criado como 0 (zero) | Sim | |
tta_des_narrat_Bem_pat | character | x(2000) | Narrativa do bem patrimonial | Não | |
tta_log_bem_imptdo | logical | Sim/Não | Este atributo indica se o bem patrimonial foi importado ou não. | Sim | |
tta_log_cr_pis | logical | Sim/Não | Este atributo indica se o bem patrimonial credita ou não PIS. Obs.: Este atributo será utilizado somente no Brasil | Sim | |
tta_log_cr_cofins | logical | Sim/Não | Este atributo indica se o bem patrimonial credita ou não COFINS. Obs.: Este atributo será utilizado somente no Brasil | Sim | |
tta_num_parc_pis_cofins | integer | 99 | Este atributo indica se o credito de PIS e COFINS é parcelado. Obs.: Depende que o Bem bem patrimonial credite PIS ou COFINS. O valor passado deverá ser 00 para não credita e 12 ou 48 vezes. | Sim | |
tta_val_cr_pis | decimal | >>>,>>>,>>9.99 | Valor do PIS que a empresa poderá creditar | Sim | |
tta_val_cr_cofins | decimal | >>>,>>>,>>9.99 | Valor do COFINS que a empresa poderá creditar | Sim | |
ttv_log_cr_csll | logical | Sim/Não | Credita CSLL | Sim | X |
ttv_num_exerc_cr_csll | integer | 99 | Exerc. Crédito CSLL | Sim | X |
| tta_dat_calc_pat | date | 99/99/9999 | Data de início de cálulo do bem patrimonial | Não | |
| tta_cb3_ident_visual | char | x(20) | Número da plaqueta | Não | |
| tta_cod_estado_fisic_bem_pat | char | x(8) | Estado físico do bem patrimonial | Não | |
| tta_cod_espec_bem | char | x(6) | Espécie do bem patrimonial | Não | |
| tta_cod_marca | char | x(6) | Marca do bem patrimonial | Não | |
| tta_cod_modelo | char | x(8) | Modelo do bem patrimonial | Não | |
| tta_dat_avaliac_apol_seguro | date | 99/99/9999 | Data de avaliação da apólice de seguro | Não | |
| tta_val_avaliac_apol_seguro | decimal | ->>,>>>,>>>,>>9.99 | Valor de avaliação da apólice de seguro | Não | |
| tta_cod_licenc_uso | char | x(8) | Licença de uso | Não | |
| tta_cod_especif_tec | char | x(8) | Especificação técnica | Não | |
| tta_cod_arrendador | char | x(6) | Arrendador | Não | |
| tta_cod_contrat_leas | char | x(12) | Contrato de Leasing | Não | |
| tta_cod_localiz | char | x(12) | Localização do bem patrimonial | Não | |
| tta_cod_imagem | char | x(30) | Imagem do bem patrimonial | Não | |
| ttv_rec_id | recid | >>>>>>9 | Recid do registro do bem patrimonial criado na temp-table | Sim |
...
2) Tabela de erros
Tabela Temporária | Descrição | Entrada/Saída |
tt_erros_criacao_bem_pat_api_1 | Conterá as informações dos movimentos que não foram importados com a respectiva mensagem de erro. | New Shared |
...
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
tta_cod_unid_organ_ext | character | x(3)Unid Organ Externa | Código da unidade organizacional externa, ou seja, a empresa a ser traduzida pela matriz de tradução de unidade organizacional. | ||
tta_cod_cta_pat | character | x(18) | Conta Patrimonial | ||
tta_num_bem_pat | integer | >>>>>>>>9 | Bem Patrimonial | ||
tta_num_seq_bem_pat | integer | >>>>9 | Sequência Bembem patrimonial | ||
tta_des_bem_pat | character | x(40) | Descrição Bem Patrimonial | ||
tta_dat_aquis_bem_pat | date | 99/99/9999 | Data Aquisição | ||
tta_cod_finalid_econ_ext | character | x(8) | Finalid Econ Finalidade Econônica Externa | ||
ttv_des_mensagem | character | x(50) | Mensagem de erro para o bem patrimonial com a chave formada pelos atributos acima nesta temp table. |
...
3) Itens de Documento de Entrada vinculados ao Bembem patrimonial
Tabela Temporária | Descrição | Entrada/Saída |
tt_criacao_bem_pat_item_api | Conterá os registros dos itens das notas fiscais que serão vinculados ao bem patrimonial. | Entrada |
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
ttv_rec_bem | recid | RECID do registro da temp-table tt_criacao_bem_pat_api_5, referente ao bem patrimonial ao qual o item será vinculado | Sim | ||
tta_cdn_fornecedor | integer | >>>,>>>,>>9 | Código do fornecedor | Sim | |
tta_cod_docto_entr | character | x(8) | Código da nota fiscal | Sim | |
tta_cod_ser_nota | character | X(3) | Série da nota fiscal | Não | |
tta_num_item_docto_entr | integer | >>>,>>9 | Número do item da nota fiscal | Sim | |
tta_qtd_item_docto_entr | Decimal | >>>>>>>>9 | Quantidade do item vinculado ao bem patrimonial | Sim |
4) Valores Residuais do Bembem patrimonial
Tabela Temporária | Descrição | Entrada/Saída |
tt_criacao_bem_pat_val_resid | Conterá os registros dos valores residuais do bem patrimonial. | Entrada |
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
ttv_rec_bem | recid | RECID do registro da temp-table tt_criacao_bem_pat_api_5, referente ao bem patrimonial ao qual o item será vinculado | Sim | ||
tta_cod_tip_calc | character | x(7) | Código do tipo de cálculo | Simtta_cod_cenar_ctbl | |
tta_cod_cenar_ctbl | character | x(8) | Código do cenário contábil | Sim | |
tta_cod_finalid_econ | character | X(10) | Código da finalidade econômica | Sim | |
tta_val_resid_min | decimal | >>>>,>>>,>>>,>>9.99 | Valor residual mínimo do bem patrimonial. Exemplo: Um determinado bem patrimonial, por exemplo, um microcomputador, já registrou toda a devida depreciação, não apresentando nenhum valor a depreciar. Para o objetivo de depreciação, esse bem não expressa mais valor, mas para a finalidade de venda, será vendido por um preço/valor. Este valor é o Residual Mínimo. | Sim |
5) Imagens do bem patrimonial
Tabela Temporária | Descrição | Entrada/Saída |
tt_criacao_bem_pat_img | Conterá os registros das imagens do bem patrimonial. | Entrada |
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
ttv_rec_bem | recid | RECID do registro da temp-table tt_criacao_bem_pat_api_5, referente ao bem patrimonial ao qual o item será vinculado | Sim | ||
tta_num_seq_img | integer | >>>>>>>>9 | Número de sequência da imagem a ser incluída, o qual define o seu posicionamento na tabela. Nota: O número de sequência é gerado automaticamente, no momento em que a imagem é incluída no sistema, não podendo ser alterada. | Sim | |
tta_des_imagem | character | x(40) | Descrição ou um detalhe a especificar a respeito da imagem do bem patrimonial com até 40 caracteres alfanuméricos. | Sim | |
tta_dat_img | date | 99/99/9999 | Data da imagem do bem patrimonial. | Sim | |
| tta_log_princ | logical | Sim/Não | Indica que a imagem em questão é a principal relacionada ao bem patrimonial. Importante: É possível incluir 1 ou várias imagens associadas ao bem patrimonial, porém somente umas delas pode ser definida com a principal imagem - Campo Principal igual a assinalado. | Sim | |
| tta_cod_usuar | character | x(12) | Código do usuário responsável pela inclusão da imagem do bem patrimonial. | ||
| tta_nom_arq | character | x( |
| 100) |
Nome do arquivo da imagem relacionada ao bem patrimonial. | Sim | |
| tta_ |
| des_ |
| observ | character |
| x( |
| 200) |
Código da finalidade econômica
Sim
tta_val_resid_min
decimal
>>>>,>>>,>>>,>>9.99
Valor residual mínimo
| Espaço disponível para anotações ou observações a respeito da imagem do bem patrimonial que está sendo implementada. |
Execução
Na execução da API ocorrem as seguintes validações:
- Versão de integração
- API verificará se o programa chamador está integro com a API. Isto ocorre através da verificação da versão de integração passada como parâmetro
- Estabelecimento
- Será verificado se o estabelecimento é válido
- Unidade de Negócio
- Será verificado se a unidade de negócio é válida e se está vinculada ao estabelecimento
- Centro de Custo
- Valida o centro de custo informado e verifica se o usuário tem permissão para acessá-lo
- Conta patrimonial
- Verifica se a conta patrimonial informada é válida
- Finalidade Econômica
- Verifica se a finalidade econômica existe na matriz de tradução de finalidade informada
- Fornecedor
- Verifica, caso informado, se o fornecedor é válido
- Documento de entrada (nota fiscal)
- Verifica, caso informado, se o documento existem no sistema
- Itens documento de entrada
- Verifica, caso informado, se os itens de documento de entrada existem no sistema
- Verifica se a quantidade dos itens de documento de entrada está disponível para vinculação
- Número e sequência do bem patrimonial
- Verifica, caso informado, se já não existe um bem patrimonial com o mesmo número no sistema. (levando em conta que a chave completa do bem patrimonial é empresa, conta patrimonial, número do bem patrimonial e sequência)
- Data de cálculo
- Quando informada será utilizada como data de início de cálculo do bem patrimonial. Caso não seja informada a data de início de cálculos será a data de aquisição
- Indicador econômico da apólice seguros
- Caso não seja informado, será utilizado o indicador econômico informado para o bem patrimonial
- Data de avaliação da apólice de seguros
- Caso não seja informado, será utilizado o valor original informado para o bem patrimonial
- Estado físico do bem patrimonial
- Valida se o estado físico informado existe no sistema
- Espécie do bem patrimonial
- Valida se a espécie informada existe no sistema
- Marca do bem patrimonial
- Valida se a marca informada existe no sistema
- Modelo do bem patrimonial
- Valida se o modelo informado existe no sistema
- Licença de uso
- Valida se a licença de uso informada existe no sistema
- Especificação técnica do bem patrimonial
- Valida se a especificação técnica informada existe para o bem patrimonial
- Arrendador
- Valida se o arrendador informado existe no sistema
- Contrato de leasing
- Valida se o contrato de leasing informado existe no sistema
- Localização do bem patrimonial
- Valida se a localização informada existe no sistema
...
Exemplo do programa para criação dos registros nas temp-tables com os bens patrimoniais a serem implantados:
/* Esta temp-table (tt_criacao_bem_pat_api_5) somente precisa estar declarada no programa chamador como NEW SHARED, mas não precisa ser alimentada. Ela se faz necessário devido a questões técnicas */
...
/* Esta temp-table (tt_criacao_bem_pat_api_7) conterá os registros dos bens patrimoniais a serem criados no sistema */
...
/* Esta temp-table (tt_criacao_bem_pat_item_api) conterá os itens do documento de entrada a serem vinculados aos bens patrimoniais. Não é obrigatório criar registros nesta temp-table */
...
/* esta temp-table (tt_criacao_bem_pat_val_resid) conterá os valores residuais dos bens patrimoniais a serem criados no sistema. Não é obrigatório criar registros nesta temp-table */
...
/* Esta temp-table (tt_erros_criacao_bem_pat_api_1) será criada pela API e conterá os erros ocorridos durante a criação dos bens patrimoniais */
DEF NEW shared temp-table tt_erros_criacao_bem_pat_api_1 no-undo
field tta_cod_unid_organ_ext as character format "x(5)" label "Unid Organ Externa" column-label "Unid Organ Externa"
field tta_cod_cta_pat as character format "x(18)" label "Conta Patrimonial" column-label "Conta Patrimonial"
field tta_num_bem_pat as integer format ">>>>>>>>9" initial 0 label "Bem Patrimonial" column-label "Bem"
field tta_num_seq_bem_pat as integer format ">>>>9" initial 0 label "Sequência Bem" column-label "Sequência"
field tta_des_bem_pat as character format "x(40)" label "Descrição Bem Pat" column-label "Descrição Bem Pat"
field tta_dat_aquis_bem_pat as date format "99/99/9999" initial today label "Data Aquisição" column-label "Dat Aquis"
field tta_cod_finalid_econ_ext as character format "x(8)" label "Finalid Econ Externa" column-label "Finalidade Externa"
field ttv_des_mensagem as character format "x(50)" label "Mensagem" column-label "Mensagem"
.
...
CREATE tt_criacao_bem_pat_val_resid.
ASSIGN tt_criacao_bem_pat_val_resid.ttv_rec_bem = RECID(tt_criacao_bem_pat_api_7)
tt_criacao_bem_pat_val_resid.tta_cod_tip_calc = "DP"
tt_criacao_bem_pat_val_resid.tta_cod_cenar_ctbl = "Fiscal"
tt_criacao_bem_pat_val_resid.tta_cod_finalid_econ = "Fiscal"
tt_criacao_bem_pat_val_resid.tta_val_resid_min = 400.
run prgfin\fas\fas735zh.py PERSISTENT SET v_hdl_program.
...
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas