Árvore de páginas

Documento de API

Produto:

Datasul

Ocorrência:

Documentação de API

Nome FísicoPrgint/utb/utb742za

 

Considerações Gerais

 

Objetivo

Disponibilizar todos os métodos necessários para que seja possível interagir com o Centro de Custo do EMS5 como, por exemplo, fazer uma validação, buscar uma determinada informação ou acessar um Zoom.

 

Funcionamento


1. Executar o programa API da seguinte forma:

 

def var h_api_ccusto as handle no-undo.

 

run prgint\utb\utb742za.py persistent set h_api_ccusto.

 

run <MÉTODO> in h_api_ccusto (<PARÂMETROS>,

                              output table tt_log_erro).

 

delete object h_api_ccusto.

 

2. Após a execução do método, deve ser testada a temp-table de erro (tt_log_erro), afim de verificar se ocorreu algum erro. Também pode ser verificado o return-value que irá conter “OK” se tudo estiver correto ou “NOK” se ocorreu algum erro.

 

Tabelas Temporárias

 

Nos atributos das tabelas temporárias de entrada e saída: 

tt_log_erro

Entrada/Saída

Erros ocorridos no processo.

Saída

Atributo

Tipo

Formato

Descrição

Obrigatório

Evolução

ttv_num_cod_erro

Int

>>>,>>9

Código do erro.

-

-

ttv_des_msg_ajuda

char

x(50)

Ajuda do erro.

-

-

ttv_des_msg_erro

char

x(50)

Mensagem de erro.

-

-

 

Definição:

 

def temp-table tt_log_erro no-undo

   field ttv_num_cod_erro  as int  format ">>>>,>>9" label "Número"         column-label "Número"

   field ttv_des_msg_ajuda as char format "x(40)"    label "Mensagem Ajuda" column-label "Mensagem Ajuda"

   field ttv_des_msg_erro  as char format "x(60)"    label "Mensagem Erro"  column-label "Inconsistência"

.

 

tt_ccusto_integr

Entrada/Saída

Centros de Custos.

Saída

Atributo

Tipo

Formato

Descrição

Obrigatório

Evolução

ttv_cod_empresa

char

x(3)

Empresa.

-

-

ttv_cod_plano_ccusto

char

x(8)

Plano de Centro
de Custo.

-

-

ttv_cod_ccusto

char

x(20)

Centro de Custo.

-

-

ttv_des_titulo

char

x(40)

Descrição do Custo
de Custo.

-

-

 

Definição:

 

def temp-table tt_ccusto_integr no-undo

   field ttv_cod_empresa      as character format "x(3)" label "Empresa" column-label "Empresa"

   field ttv_cod_plano_ccusto as character format "x(8)" label "Plano CCusto" column-label "Plano CCusto"

   field ttv_cod_ccusto      as Character format "x(20)" label "Centro Custo" column-label "Centro Custo"

   field ttv_des_titulo       as character format "x(40)"

   index tt_id                          

   ttv_cod_empresa                  ascending

   ttv_cod_plano_ccusto             ascending

   ttv_cod_ccusto                   ascending

.

 

tt_cta_integr

Entrada/Saída

Contas Contábeis.

Entrada

Atributo

Tipo

Formato

Descrição

Obrigatório

Evolução

ttv_cod_plano_cta_ctbl

char

x(8)

Plano de Contas.

-

-

ttv_cod_cta_ctbl

char

x(20)

Conta Contábil.

-

-

ttv_des_titulo

char

x(40)

Descrição da Conta.

-

-

ttv_num_tip_cta_ctbl

int

>9

Tipo da Conta.

-

-

ttv_num_sit_cta_ctbl

Int

>9

Situação da Conta.

-

-

ttv_ind_finalid_ctbl_cta

char

x(40)

Finalidades da Conta.

-

-

 

Definição:

 

   def temp-table tt_cta_integr no-undo

      field ttv_cod_plano_cta_ctbl as character format "x(8)" label "Plano Contas" column-label "Plano Contas"

field ttv_cod_cta_ctbl as character format "x(20)" label "Conta Contábil" column-label "Conta Contábil"

field ttv_des_titulo as character format "x(40)"

field ttv_num_tip_cta_ctbl as integer format ">9" label "Tipo Conta" column-label "Tipo Conta"

field ttv_num_sit_cta_ctbl as integer format ">9" label "Situação Conta" column-label "Situação Cta"

field ttv_ind_finalid_ctbl_cta as character format "X(40)" label "Finalidade Contábil"

index tt_id                          

      ttv_cod_plano_cta_ctbl           ascending

      ttv_cod_cta_ctbl                 ascending

.

 

tt_ccusto_cta_integr

Entrada/Saída

Centros de Custo disponíveis para as Contas Contábeis.

Saída

Atributo

Tipo

Formato

Descrição

Obrigatório

Evolução

ttv_cod_empresa

char

x(3)

Empresa.

-

-

ttv_cod_plano_cta_ctbl

char

x(8)

Plano de Contas.

-

-

ttv_cod_cta_ctbl

char

x(20)

Conta Contábil.

-

-

ttv_cod_plano_ccusto

char

x(8)

Plano de Centro de Custo.

-

-

ttv_cod_ccusto

char

x(20)

Centro de Custo.

-

-

ttv_des_ccusto

char

x(40)

Descrição do Custo de Custo.

-

-

 

Definição:

 

   def temp-table tt_ccusto_cta_integr no-undo

      field ttv_cod_empresa as character format "x(3)" label "Empresa" column-label "Empresa"

field ttv_cod_plano_cta_ctbl as character format "x(8)" label "Plano Contas" column-label "Plano Contas"

field ttv_cod_cta_ctbl as character format "x(20)" label "Conta Contábil" column-label "Conta Contábil"

field ttv_cod_plano_ccusto as character format "x(8)" label "Plano CCusto" column-label "Plano CCusto"

field ttv_cod_ccusto as Character format "x(20)" label "Centro Custo" column-label "Centro Custo"

field ttv_des_ccusto as character format "x(40)" label "Des Ccusto" column-label "Des Ccusto"

index tt_id                          

      ttv_cod_empresa                  ascending

      ttv_cod_plano_cta_ctbl           ascending

      ttv_cod_cta_ctbl                 ascending

      ttv_cod_plano_ccusto             ascending

      ttv_cod_ccusto                   ascending

.

 

tt_restric_estab_ccusto

Entrada/Saída

Restrições Estab CCusto.

Saída

Atributo

Tipo

Formato

Descrição

Obrigatório

Evolução

tta_cod_empresa

char

x(3)

Empresa.

-

-

tta_cod_empres_2

char

x(3)

Empresa do EMS2.

-

-

tta_cod_plano_ccusto

char

x(8)

Plano de Centro de Custo.

-

-

tta_cod_ccusto

char

x(20)

Centro de Custo.

-

-

tta_cod_estab

char

x(5)

Estabelecimento.

-

-

ttv_cod_estab_ems2

char

x(5)

Estabelecimento do EMS2.

-

-

 

Definição:

 

def temp-table tt_restric_estab_ccusto no-undo

   field tta_cod_empresa as character format "x(3)" label "Empresa" column-label "Empresa"

   field tta_cod_empres_ems2 as character format "x(3)" label "Empresa Ems2" column-label "Empresa Ems2"

   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(20)" label "Centro Custo" column-label "Centro Custo"

   field tta_cod_estab as character format "x(5)" label "Estabelecimento" column-label "Estab"

   field ttv_cod_estab_ems2               as character format "x(5)"

.

 

tt_segur_relacto_ccusto

Entrada/Saída

Segurança Relacto CCusto.

Saída

Atributo

Tipo

Formato

Descrição

Obrigatório

Evolução

tta_cod_empresa

char

x(3)

Empresa.

-

-

tta_cod_empres_2

char

x(3)

Empresa do EMS2.

-

-

tta_cod_plano_ccusto

char

x(8)

Plano de Centro de Custo.

-

-

tta_cod_ccusto

char

x(20)

Centro de Custo.

-

-

tta_cod_grp_usuar

char

x(3)

Grupo Usuários.

-

-

 

Definição:

 

   def temp-table tt_segur_relacto_ccusto no-undo

       field tta_cod_empresa as character format "x(3)" label "Empresa" column-label "Empresa"

       field tta_cod_empres_ems2 as character format "x(3)" label "Empresa Ems2" column-label "Empresa Ems2"

       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(20)" label "Centro Custo" column-label "Centro Custo"

       field tta_cod_grp_usuar as character format "x(3)" label "Grupo Usuários" column-label "Grupo"

.

 

tt_unid_negoc_ccusto

Entrada/Saída

Unidade de Negócio CCusto.

Saída

Atributo

Tipo

Formato

Descrição

Obrigatório

Evolução

tta_cod_empresa

char

x(3)

Empresa.

-

-

tta_cod_empres_2

char

x(3)

Empresa do EMS2.

-

-

tta_cod_plano_ccusto

char

x(8)

Plano de Centro de Custo.

-

-

tta_cod_ccusto

char

x(20)

Centro de Custo.

-

-

tta_cod_unid_negoc

char

x(3)

Unidade de Negócio.

-

-

 

Definição:

 

def temp-table tt_unid_negoc_ccusto no-undo

   field tta_cod_empresa as character format "x(3)" label "Empresa" column-label "Empresa"

   field tta_cod_empres_ems2 as character format "x(3)" label "Empresa Ems2" column-label "Empresa Ems2"

   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(20)" label "Centro Custo" column-label "Centro Custo"

   field tta_cod_unid_negoc as character format "x(3)" label "Unid Negócio" column-label "Un Neg"

.

Método Negócio

 

pi_retorna_formato_ccusto

Requisito

Não possui.

Sintaxe

pi_retorna_formato_ccusto (input p_cod_empres_ems_2,

                                                    input p_cod_plano_ccusto,

                                                    input p_dat_trans,

                                                    output p_cod_format_ccusto,

                                                    output table tt_log_erro)

Descrição

Retorna o Formato do Centro de Custo.

Parâmetros

Descrição

p_cod_empres_ems_2 [input]

Código da Empresa do EMS2.

(*) Pode ser deixado em branco, se for, será considerada a empresa corrente do EMS5.

 

p_cod_plano_ccusto [input]

Código do Plano de Centro de Custo.

(*) Pode ser deixado em branco, se for, será considerado o Plano válido na data de transação.

 

p_dat_trans [input]

Data da Transação.

 

p_cod_format_ccusto [output]

Formato do Centro de Custo do Plano do informado.

 

tt_log_erro [output]

Erros ocorridos durante a execução do método.

Se estiver tudo OK, ela estará vazia.

Retorno

A API irá setar o return-value de maneira a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas). Os motivos para a rejeição do movimento de reporte são especificados na temp-table tt-erro....

pi_zoom_plano_ccusto

Requisito

Não possui.

Sintaxe

pi_zoom_plano_ccusto (output p_cod_plano_ccusto,

                                            output p_des_titulo,

                                            output table tt_log_erro)

Descrição

Abre o Zoom de Plano de Centro de Custo.

Parâmetros

Descrição

p_cod_plano_ccusto [output]

Código do Plano de Centro de Custo selecionado no Zoom.

 

p_des_titulo [output]

Descrição do Plano de Centro de Custo selecionado no Zoom.

 

tt_log_erro [output]

Erros ocorridos durante a execução do método.

Se estiver tudo OK, ela estará vazia.

Retorno

A API irá setar o return-value de maneira a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas). Os motivos para a rejeição do movimento de reporte são especificados na temp-table tt-erro....

pi_zoom_ccusto

Requisito

Não possui.

Sintaxe

pi_zoom_ccusto (input p_cod_empres_ems_2 ,

                                input  p_cod_plano_ccusto,

                                input p_cod_unid_negoc,

                                input p_dat_trans,

                                output p_cod_ccusto,

                                output p_des_titulo,

                                output table tt_log_erro)

Descrição

Abre o Zoom de Centro de Custo.

Parâmetros

Descrição

p_cod_empres_ems_2 [input]

Código da Empresa do EMS2.

(*) Pode ser deixado em branco, se for, será considerada a empresa corrente do EMS5.

 

p_cod_plano_ccusto [input]

Código do Plano de Centro de Custo.

(*) Pode ser deixado em branco, se for, será considerado o Plano válido na data de transação.

 

p_cod_unid_negoc [input]

Código da Unidade de Negócio.

(*) Pode ser deixado em branco, se for informado, serão considerados somente os Centros de Custos vinculados a Unidade informada.

 

p_dat_trans [input]

Data da Transação.

 

p_cod_ccusto [output]

Código do Centro de Custo selecionado no Zoom.

 

p_des_titulo [output]

Descrição do Centro de Custo selecionado no Zoom.

 

tt_log_erro [output]

Erros ocorridos durante a execução do método.

Se estiver tudo OK, ela estará vazia.

Retorno

A API irá setar o return-value de maneira a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas). Os motivos para a rejeição do movimento de reporte são especificados na temp-table tt-erro....

pi_zoom_ccusto_x_cta_ctbl

Requisito

Não possui.

Sintaxe

pi_zoom_ccusto_x_cta_ctbl (input p_cod_empres_ems_2 ,

                                                    input  p_cod_estab_ext,

                                                    input p_log_todos_estab,

                                                    input p_cod_unid_negoc,

                                                    input p_cod_plano_cta_ctbl,

                                                    input p_cod_cta_ctbl,

                                                    input p_cod_plano_ccusto,

                                                    input p_dat_trans,

                                                    output p_cod_ccusto,

                                                    output p_des_titulo,

                                                    output table tt_log_erro)

Descrição

Abre o Zoom de Centros de Custo válidos para a Conta informada.

Parâmetros

Descrição

p_cod_empres_ems_2 [input]

Código da Empresa do EMS2.

(*) Pode ser deixado em branco, se for, será considerada a empresa corrente do EMS5.

 

p_cod_estab_ext [input]

Código do Estabelecimento do EMS2.

(*) Pode ser deixado em branco, se for, será utilizado o estabelecimento corrente do EMS5. Se o estabelecimento corrente estiver em branco, será utilizado o estabelecimento principal da empresa informada.

 

p_log_todos_estab [input]

Considera Todos os Estabelecimentos?

(*) Se igual a “não”, serão considerados somente os Centros de Custos válidos para o Estabelecimento informado.

 

p_cod_unid_negoc [input]

Código da Unidade de Negócio.

(*) Pode ser deixado em branco, se for informado, serão considerados somente os Centros de Custos vinculados a Unidade informada.

 

p_cod_plano_cta_ctbl [input]

Código do Plano de Contas.

(*) Pode ser deixado em branco, se for, será considerado o Plano válido na data de transação para a empresa informada.

 

p_cod_cta_ctbl [input]

Código da Conta.

 

p_cod_plano_ccusto [input]

Código do Plano de Centro de Custo.

(*) Pode ser deixado em branco, se for, será considerado o Plano válido na data de transação.

 

p_dat_trans [input]

Data da Transação.

 

p_cod_ccusto [output]

Código do Centro de Custo selecionado no Zoom.

 

p_des_titulo [output]

Descrição do Centro de Custo selecionado no Zoom.

 

tt_log_erro [output]

Erros ocorridos durante a execução do método.

Se estiver tudo OK, ela estará vazia.

Retorno

A API irá setar o return-value de maneira a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas). Os motivos para a rejeição do movimento de reporte são especificados na temp-table tt-erro....

pi_verifica_utilizacao_ccusto

Requisito

Não possui.

Sintaxe

pi_verifica_utilizacao_ccusto (input p_cod_empres_ems_2 ,

                                                      input  p_cod_estab_ext,

                                                      input p_cod_plano_cta_ctbl,

                                                      input p_cod_cta_ctbl,

                                                      input p_dat_trans,

                                                      output p_log_ccusto,

                                                      output table tt_log_erro)

Descrição

Verifica se a Conta informada utiliza Centro de Custo.

Parâmetros

Descrição

p_cod_empres_ems_2 [input]

Código da Empresa do EMS2.

(*) Pode ser deixado em branco, se for, será considerada a empresa corrente do EMS5.

 

p_cod_estab_ext [input]

Código do Estabelecimento do EMS2.

(*) Pode ser deixado em branco, se for, será utilizado o estabelecimento corrente do EMS5. Se o estabelecimento corrente estiver em branco, será utilizado o estabelecimento principal da empresa informada.

 

p_cod_plano_cta_ctbl [input]

Código do Plano de Contas.

(*) Pode ser deixado em branco, se for, será considerado o Plano válido na data de transação para a empresa informada.

 

p_cod_cta_ctbl [input]

Código da Conta.

 

p_dat_trans [input]

Data da Transação.

 

p_log_ccusto [output]

Indicador da utilização do Centro de Custo. Onde:

yes = A Conta informada utiliza Centro de Custo.

no = A Conta informada não utiliza Centro de Custo.

 

tt_log_erro [output]

Erros ocorridos durante a execução do método.

Se estiver tudo OK, ela estará vazia.

Retorno

A API irá setar o return-value de maneira a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas). Os motivos para a rejeição do movimento de reporte são especificados na temp-table tt-erro....

pi_busca_dados_plano_ccusto

Requisito

Não possui.

Sintaxe

pi_busca_dados_plano_ccusto (input p_cod_empres_ems_2 ,

                                                         input  p_cod_plano_ccusto,

                                                         input p_dat_trans,

                                                         output p_des_titulo,

                                                         output table tt_log_erro)

Descrição

Retornar nos Dados do Plano de Centro de Custo informado.

Parâmetros

Descrição

p_cod_empres_ems_2 [input]

Código da Empresa do EMS2.

(*) Pode ser deixado em branco, se for, será considerada a empresa corrente do EMS5.

 

p_cod_plano_ccusto [input]

Código do Plano de Centro de Custo.

(*) Pode ser deixado em branco, se for, será considerado o Plano válido na data de transação.

 

p_dat_trans [input]

Data da Transação.

 

p_des_titulo [output]

Descrição do Plano de Centro de Custo informado.

 

tt_log_erro [output]

Erros ocorridos durante a execução do método.

Se estiver tudo OK, ela estará vazia.

Retorno

A API irá setar o return-value de maneira a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas). Os motivos para a rejeição do movimento de reporte são especificados na temp-table tt-erro....

pi_busca_dados_ccusto

Requisito

Não possui.

Sintaxe

pi_busca_dados_ccusto (input p_cod_empres_ems_2 ,

                                             input  p_cod_plano_ccusto,

                                             input p_cod_ccusto,

                                             input p_dat_trans,

                                             output p_des_titulo,

                                             output table tt_log_erro)

Descrição

Busca Dados do Centro de Custo informado.

Parâmetros

Descrição

p_cod_empres_ems_2 [input]

Código da Empresa do EMS2.

(*) Pode ser deixado em branco, se for, será considerada a empresa corrente do EMS5.

 

p_cod_plano_ccusto [input]

Código do Plano de Centro de Custo.

(*) Pode ser deixado em branco, se for, será considerado o Plano válido na data de transação.

 

p_cod_ccusto [input]

Código do Centro de Custo.

 

p_dat_trans [input]

Data da Transação.

 

p_des_titulo [output]

Descrição do Plano de Centro de Custo informado.

 

tt_log_erro [output]

Erros ocorridos durante a execução do método.

Se estiver tudo OK, ela estará vazia.

Retorno

A API irá setar o return-value de maneira a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas). Os motivos para a rejeição do movimento de reporte são especificados na temp-table tt-erro....

pi_busca_ccustos_integr

Requisito

Não possui.

Sintaxe

pi_busca_ccustos_integr (input p_cod_empres_ems_2 ,

                                              input  p_cod_plano_ccusto,

                                              input p_cod_unid_negoc,

                                              input p_dat_trans,

                                              output table tt_ccusto_integr,

                                              output table tt_log_erro)

Descrição

Retorna os Centros de Custo conforme a parametrização.

Parâmetros

Descrição

p_cod_empres_ems_2 [input]

Código da Empresa do EMS2.

(*) Pode ser deixado em branco, se for, será considerada a empresa corrente do EMS5.

 

p_cod_plano_ccusto [input]

Código do Plano de Centro de Custo.

(*) Pode ser deixado em branco, se for, será considerado o Plano válido na data de transação.

 

p_cod_unid_negoc [input]

Código da Unidade de Negócio.

 

 

p_dat_trans [input]

Data da Transação.

 

tt_ccusto_integr [output]

Todos os Centros de Custo conforme os parâmetros.

 

tt_log_erro [output]

Erros ocorridos durante a execução do método.

Se estiver tudo OK, ela estará vazia.

Retorno

A API irá setar o return-value de maneira a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas). Os motivos para a rejeição do movimento de reporte são especificados na temp-table tt-erro....

pi_busca_plano_ccusto_empresa

Requisito

Não possui.

Sintaxe

pi_busca_plano_ccusto_empresa (input p_cod_empres_ems_2 ,

                                                              input p_dat_trans,

                                                              output p_cod_plano_ccusto,

                                                              output table tt_log_erro)

Descrição

Retorna o Plano de Centro de Custo válido para a Empresa informada.

Parâmetros

Descrição

p_cod_empres_ems_2 [input]

Código da Empresa do EMS2.

(*) Pode ser deixado em branco, se for, será considerada a empresa corrente do EMS5.

 

p_dat_trans [input]

Data da Transação.

 

p_cod_plano_ccusto [output]

Código do Plano de Centro de Custo válido para a Empresa e data de transação.

 

tt_log_erro [output]

Erros ocorridos durante a execução do método.

Se estiver tudo OK, ela estará vazia.

Retorno

A API irá setar o return-value de maneira a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas). Os motivos para a rejeição do movimento de reporte são especificados na temp-table tt-erro....

pi_busca_ccustos_x_cta_ctbl

Requisito

Não possui.

Sintaxe

pi_busca_ccustos_x_ctbl (input p_cod_empres_ems_2 ,

                                               input  p_cod_estab_ext,

                                               input p_log_todos_estab,

                                               input p_cod_plano_ccusto,

                                               input p_cod_unid_negoc,

                                               input p_dat_trans,

                                               input table tt_cta_integr

                                               output table tt_ccusto_cta_integr,

                                               output table tt_log_erro)

Descrição

Retorna todos os Centros de Custo válidos para as Contas Contábeis informadas.

Parâmetros

Descrição

p_cod_empres_ems_2 [input]

Código da Empresa do EMS2.

(*) Pode ser deixado em branco, se for, será considerada a empresa corrente do EMS5.

 

p_cod_estab_ext [input]

Código do Estabelecimento do EMS2.

(*) Pode ser deixado em branco, se for, será utilizado o estabelecimento corrente do EMS5. Se o estabelecimento corrente estiver em branco, será utilizado o estabelecimento principal da empresa informada.

 

p_log_todos_estab [input]

Considera Todos os Estabelecimentos?

(*) Se igual a “não”, serão considerados somente os Centros de Custos válidos para o Estabelecimento informado.

 

p_cod_plano_ccusto [input]

Código do Plano de Centro de Custo.

(*) Pode ser deixado em branco, se for, será considerado o Plano válido na data de transação.

 

p_cod_unid_negoc [input]

Código da Unidade de Negócio.

(*) Pode ser deixado em branco, se for informado, serão considerados somente os Centros de Custos vinculados a Unidade informada.

 

p_dat_trans [input]

Data da Transação.

 

tt_cta_integr [input]

Contas Contábeis que serão consideradas para buscar os Centros de Custo.

 

tt_ccusto_cta_integr [output]

Relação de Contas Contábeis versus Centros de Custos válidos para as Contas.

 

tt_log_erro [output]

Erros ocorridos durante a execução do método.

Se estiver tudo OK, ela estará vazia.

Retorno

A API irá setar o return-value de maneira a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas). Os motivos para a rejeição do movimento de reporte são especificados na temp-table tt-erro....

pi_retorna_valor_inic_fim_formato

Requisito

Não possui.

Sintaxe

pi_retorna_valor_inic_fim_formato (input p_cod_format,

                                                                  output  p_cod_format_inic,

                                                                  output p_cod_format_fim,

                                                                  output table tt_log_erro)

Descrição

Retornar o Valor Inicial e Final para o Formato informado.

Exemplo: Para o Formato “9.9.9.9-XX” os valores serão:

Inicial: “0.0.0.0-AA” e Final: “9.9.9.9-ZZ”.

Parâmetros

Descrição

p_cod_format [input]

Formato da Conta ou Centro de Custo.

 

p_cod_format_inic [output]

Valor Inicial para o Formato informado.

 

p_cod_format_fim [output]

Valor Final para o Formato informado.

 

tt_log_erro [output]

Erros ocorridos durante a execução do método.

Se estiver tudo OK, ela estará vazia.

Retorno

A API irá setar o return-value de maneira a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas). Os motivos para a rejeição do movimento de reporte são especificados na temp-table tt-erro....

pi_retorna_empresa_ems5

Requisito

Não possui.

Sintaxe

pi_retorna_empresa_ems5 (input p_cod_empres_ems_2,

                                                   output  p_cod_empres_ems_5,

                                                   output table tt_log_erro)

Descrição

Retorna o Código da Empresa do EMS5.

Parâmetros

Descrição

p_cod_empres_ems_2 [input]

Código da Empresa do EMS2.

(*) Pode ser deixado em branco, se for, será considerada a empresa corrente do EMS5.

 

p_cod_empres_ems_5 [output]

Código da Empresa do EMS5.

 

tt_log_erro [output]

Erros ocorridos durante a execução do método.

Se estiver tudo OK, ela estará vazia.

Retorno

A API irá setar o return-value de maneira a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas). Os motivos para a rejeição do movimento de reporte são especificados na temp-table tt-erro....

pi_retorna_trad_ccusto

Requisito

Não possui.

Sintaxe

pi_retorna_trad_ccusto (input p_cod_empres_ems_2,

                                             input p_cod_ccusto_ext,

                                             output p_cod_plano_ccusto,

                                             output p_cod_ccusto,

                                             output table tt_log_erro)

Descrição

Retorna a tradução do Centro de Custo Externo informado e o Plano do mesmo.

Parâmetros

Descrição

p_cod_empres_ems_2 [input]

Código da Empresa do EMS2.

(*) Pode ser deixado em branco, se for, será considerada a empresa corrente do EMS5.

 

p_cod_ccusto_ext [input]

Código do Centro de Custo Externo.

 

p_cod_plano_ccusto [output]

Código do Plano de Centro de Custo.

 

p_cod_ccusto [output]

Código do Centro de Custo.

 

tt_log_erro [output]

Erros ocorridos durante a execução do método.

Se estiver tudo OK, ela estará vazia.

Retorno

A API irá setar o return-value de maneira a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas). Os motivos para a rejeição do movimento de reporte são especificados na temp-table tt-erro....

pi_busca_restricoes_ccusto

Requisito

Não possui.

Sintaxe

pi_busca_restricoes_ccusto (input p_cod_empres_ems_2,

                                                    input p_cod_plano_ccusto,

                                                    input p_cod_ccusto_inic,

                                                    input p_cod_ccusto_fim,

                                                    input p_dat_trans,

                                                    output table tt_restric_estab_ccusto,

                                                    output table tt_unid_negoc_ccusto,

                                                    output table tt_segur_relacto_ccusto,

                                                    output table tt_log_erro)

Descrição

Devolve as Restrições de Estabelecimento, Unidades de Negócio Utilizadas e os Grupos de Segurança do Centro de Custo.

Parâmetros

Descrição

p_cod_empres_ems_2 [input]

Código da Empresa do EMS2.

(*) Pode ser deixado em branco, se for, será considerada a empresa corrente do EMS5.

 

p_cod_plano_ccusto [input]

Código do Plano de Centro de Custo.

(*) Pode ser deixado em branco, se for, será considerado o Plano válido na data de transação.

 

p_cod_ccusto_inic [input]

Código do Centro de Custo Inicial.

 

p_cod_ccusto_fim [input]

Código do Centro de Custo Final.

 

p_dat_trans [input]

Data da Transação.

 

tt_restric_estab_ccusto [output]

Estabelecimentos que possuem restrição no Centro de Custo.

 

tt_unid_negoc_ccusto [output]

Unidades de Negócios utilizadas no Centro de Custo.

 

tt_segur_relacto_ccusto [output]

Grupos de Segurança do Centro de Custo.

 

tt_log_erro [output]

Erros ocorridos durante a execução do método.

Se estiver tudo OK, ela estará vazia.

Retorno

A API irá setar o return-value de maneira a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas). Os motivos para a rejeição do movimento de reporte são especificados na temp-table tt-erro....