Documento de API

Ocorrência:

Documentação de API

Erros ocorridos no processo.

Saída

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.

-

-

Contas Contábeis.

Saída

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

x(40)

Finalidades da Conta.

-

-

Requisito

Não possui.

Sintaxe

pi_retorna_formato_cta_ctbl (input p_cod_empres_ems_2,

                                                       input p_cod_plano_cta_ctbl,

                                                       input p_dat_trans,

                                                       output p_cod_format_cta_ctbl,

                                                       output table tt_log_erro)

Descrição

Retorna o Formato da Conta Contábil.

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_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_dat_trans [input]

Data da Transação.

p_cod_format_cta_ctbl [output]

Formato da Conta Contábil do Plano de Contas 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....

Requisito

Não possui.

Sintaxe

pi_zoom_plano_cta_ctbl (output p_cod_plano_cta_ctbl,

                                               output p_des_titulo,

                                               output table tt_log_erro)

Descrição

Abre o Zoom de Plano de Contas.

p_cod_plano_cta_ctbl [output]

Código do Plano de Contas selecionado no Zoom.

p_des_titulo [output]

Descrição do Plano de Contas 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 forma 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....

Requisito

Não possui.

Sintaxe

pi_zoom_cta_ctbl_integr (input p_cod_empres_ems_2 ,

                                               input  p_cod_modul_dtsul,

                                               input p_cod_plano_cta_ctbl,

                                               input p_ind_finalid_integr,

                                               input p_dat_trans,

                                               output  p_cod_cta_ctbl,

                                               output p_des_titulo,

                                               output p_ind_finalid_ctbl_cta,

                                               output table tt_log_erro)

Descrição

Abre o Zoom de Conta Contábil Integração (Conta de Sistema).

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_modul_dtsul [input]

Código do Módulo.

(*) Deve ser o modulo que contabiliza o movimento gerado e não o módulo do programa que está gerando o movimento.

Os módulos possíveis são:

FAS - Ativo Fixo.

APB - Contas a Pagar.

ACR - Contas a Receber.

CMG - Caixa e Bancos.

IVC - Controle de Inadimplência.

APL - Aplicações e Empréstimos.

EEC - Prestação de Contas.

SCO - Cobranças Especiais.

INP – Investimentos.

FTP – Faturamento.

OFP - Obrigações Fiscais.

CEP – Estoque.

RHP - Recursos Humanos

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_ind_finalid_integr [input]

Finalidade Contábil da Conta.

A Finalidade varia conforme o módulo, por exemplo, para o módulo “CEP” podemos ter as Finalidades: Mão de Obra, Consumo, entre outras. E para “ACR”, podemos ter “Saldo”, “Desp Financeira”, entre outras.

Este parâmetro pode ser informado de três formas:

– Uma Finalidade específica: Serão consideradas somente as Contas pertencentes à Finalidade informada. Exemplo: “Mão de Obra”.

– Várias Finalidades (separadas por vírgula): Serão consideradas todas as Contas pertencentes às Finalidades informadas. Exemplo: “Mão de Obra, Consumo, Transferência”.

– Nenhuma Finalidade: Serão consideras todas as Contas, independe de Finalidade. Informar: “(nenhum)”.

p_dat_trans [input]

Data de Transação.

p_cod_cta_ctbl [output]

Código da Conta selecionada no Zoom.

p_des_titulo [output]

Descrição da Conta selecionada no Zoom.

p_ind_finalid_ctbl_cta [output]

Finalidade da Conta selecionada 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....

Requisito

Não possui.

Sintaxe

pi_valida_conta_contabil (input p_cod_empres_ems_2 ,

                                                input  p_cod_estab_ext,

                                                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 table tt_log_erro)

Descrição

Faz todas as validações necessárias para a Conta Contábil.

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_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.

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

Requisito

Não possui.

Sintaxe

pi_valida_cta_ctbl_integr (input p_cod_empres_ems_2 ,

                                                input  p_cod_modul_dtsul,

                                                input p_cod_plano_cta_ctbl,

                                                input p_cod_cta_ctbl,

                                                input p_ind_finalid_ctbl,

                                                input p_dat_trans,

                                                output table tt_log_erro)

Descrição

Verifica se Conta Contábil de Integração é válida (Conta de Sistema).

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_modul_dtsul [input]

Código do Módulo.

(*) Deve ser o modulo que contabiliza o movimento gerado e não o módulo do programa que está gerando o movimento.

Os módulos possíveis são:

FAS - Ativo Fixo.

APB - Contas a Pagar.

ACR - Contas a Receber.

CMG - Caixa e Bancos.

IVC - Controle de Inadimplência.

APL - Aplicações e Empréstimos.

EEC - Prestação de Contas.

SCO - Cobranças Especiais.

INP – Investimentos.

FTP – Faturamento.

OFP - Obrigações Fiscais.

CEP – Estoque.

RHP - Recursos Humanos.

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_ind_finalid_ctbl [input]

Finalidade Contábil da Conta.

A Finalidade varia conforme o módulo, por exemplo, para o módulo “CEP” podemos ter as Finalidades: Mão de Obra, Consumo, entre outras. E para “ACR”, podemos ter “Saldo”, “Desp Financeira”, entre outras.

Este parâmetro pode ser informado de três formas:

– Uma Finalidade específica: Serão consideradas somente as Contas pertencentes à Finalidade informada. Exemplo: “Mão de Obra”.

– Várias Finalidades (separadas por vírgula): Serão consideradas todas as Contas pertencentes às Finalidades informadas. Exemplo: “Mão de Obra, Consumo, Transferência”.

– Nenhuma Finalidade: Serão consideras todas as Contas, independente de Finalidade. Informar: “(nenhum)”.

p_dat_trans [input]

Data da 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....

Requisito

Não possui.

Sintaxe

pi_busca_dados_plano_cta_ctbl (input p_cod_empres_ems_2 ,

                                                            input  p_cod_plano_cta_ctbl,

                                                            input p_dat_trans,

                                                            output p_des_titulo,

                                                            output p_dat_inic_valid,

                                                            output p_dat_fim_valid,

                                                            output table tt_log_erro)

Descrição

Retorna dados do Plano de Contas.

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_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_dat_trans [input]

Data da Transação.

p_des_titulo [output]

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

p_dat_inic_valid [output]

Data Inicial de Validade do Plano Vinculado à Empresa

p_dat_fim_valid [output]

Data Final de Validade do Plano Vinculado à Empresa

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

Requisito

Não possui.

Sintaxe

pi_busca_dados_cta_ctbl (input p_cod_empres_ems_2 ,

                                                input  p_cod_plano_cta_ctbl,

                                                input-output p_cod_cta_ctbl,

                                                input p_dat_trans,

                                                output p_des_titulo,

                                                output p_num_tip_cta_ctbl,

                                                output p_num_sit_cta_ctbl, 

                                                output p_ind_finalid_ctbl_cta 

                                                output table tt_log_erro)

Descrição

Busca Dados da Conta.

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_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-output]

Conta (Código ou Chave Alternativa).

(*) Se for a Chave Alternativa, ela será trocada pelo Código e devolvido para o programa que chamou esta PI.

p_dat_trans [input]

Data da Transação.

p_des_titulo [output]

Descrição da Contas.

p_num_tip_cta_ctbl [output]

Tipo da Conta. Onde:

0 = Nenhum, 1 = Despesa, 2 = Receita, 3 = Vendas, 4 = Passivo, 5 = Ativo,

6 = Título.

p_num_sit_cta_ctbl [output]

Situação da Conta. Onde:

1 = Ativada, 2 = Desativada, 3 = Sistema.

p_ind_finalid_ctbl_cta [output]

Finalidade da Conta.

(*) Se a Conta tiver mais de uma Finalidade, elas serão devolvidas em uma lista separada por vírgula. Exemplo: “Mão de obra, Consumo, Transferência”.

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

Requisito

Não possui.

Sintaxe

pi_busca_dados_cta_ctbl_integr (input p_cod_empres_ems_2 ,

                                                             input p_cod_modul_dtsul,

                                                             input p_cod_plano_cta_ctbl,

                                                             input p_cod_cta_ctbl,

                                                             input p_dat_trans,

                                                             input p_ind_finalid_ctbl_cta,

                                                             output table tt_log_erro)

Descrição

Retorna Dados da Conta Contábil Integraçã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_modul_dtsul [input]

Código do Módulo.

(*) Pode ser deixado em branco, se for informado, serão consideradas somente as finalidades do módulo informado.

Deve ser o módulo que contabiliza o movimento gerado e não o módulo do programa que está gerando o movimento.

Os módulos possíveis são:

FAS - Ativo Fixo.

APB - Contas a Pagar.

ACR - Contas a Receber.

CMG - Caixa e Bancos.

IVC - Controle de Inadimplência.

APL - Aplicações e Empréstimos.

EEC - Prestação de Contas.

SCO - Cobranças Especiais.

INP – Investimentos.

FTP – Faturamento.

OFP - Obrigações Fiscais.

CEP – Estoque.

RHP - Recursos Humanos.

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_ind_finalid_ctbl_cta [output]

Finalidade da Conta.

(*) Se a Conta tiver mais de uma Finalidade, elas serão devolvidas em uma lista separada por vírgula. Exemplo: “Mão de obra, Consumo, Transferência”.

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

Requisito

Não possui.

Sintaxe

pi_busca_ctas_integr (input p_cod_empres_ems_2 ,

                                        input p_cod_modul_dtsul,

                                        input p_cod_plano_cta_ctbl,

                                        input p_ind_finalid_integr,

                                        input p_dat_trans,

                                        output table tt_cta_integr,

                                        output table tt_log_erro)

Descrição

Retorna as Contas conforme os parâmetros informados.

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_modul_dtsul [input]

Código do Módulo.

(*) Deve ser o módulo que contabiliza o movimento gerado e não o módulo do programa que está gerando o movimento.

Os módulos possíveis são:

FAS - Ativo Fixo.

APB - Contas a Pagar.

ACR - Contas a Receber.

CMG - Caixa e Bancos.

IVC - Controle de Inadimplência.

APL - Aplicações e Empréstimos.

EEC - Prestação de Contas.

SCO - Cobranças Especiais.

INP – Investimentos.

FTP – Faturamento.

OFP - Obrigações Fiscais.

CEP – Estoque.

RHP - Recursos Humanos.

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_ind_finalid_integr [input]

Finalidade Contábil da Conta.

A Finalidade varia conforme o módulo, por exemplo, para o módulo “CEP” podemos ter as Finalidades: Mão de Obra, Consumo, entre outras. E para “ACR”, podemos ter “Saldo”, “Desp Financeira”, entre outras.

Este parâmetro pode ser informado de três formas:

– Uma Finalidade específica: Serão consideradas somente as Contas pertencentes a Finalidade informada. Exemplo: “Mão de Obra”.

– Várias Finalidades (separadas por vírgula): Serão consideradas todas as Contas pertencentes as Finalidades informadas. Exemplo: “Mão de Obra, Consumo, Transferência”.

– Nenhuma Finalidade: Serão consideras todas as Contas, independente de Finalidade. Informar: “(nenhum)”.

p_dat_trans [input]

Data de Transação.

tt_cta_integr [output]

Todas as Contas Contábeis conforme a parametrizaçã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....

Requisito

Não possui.

Sintaxe

pi_busca_plano_cta_ctbl_empresa (input p_cod_empres_ems_2 ,

                                                                 input p_dat_trans,

                                                                 input p_cod_plano_cta_ctbl

                                                                 output table tt_log_erro)

Descrição

Retornar o Plano de Contas válido para a Empresa informada.

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_cta_ctbl [output]

Código do Plano de Contas 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....

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

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

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.

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

Requisito

Não possui.

Sintaxe

pi_retorna_nivel_cta_ctbl (input p_cod_empres_ems_2,

                                                 input p_cod_plano_cta_ctbl,

                                                 input p_cod_cta_ctbl,

                                                 input p_dat_trans,

                                                 output p_num_niv,

                                                 output p_cod_cta_ctbl_pai,

                                                 output table tt_log_erro)

Descrição

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

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_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_num_niv [output]

Nível da Conta.

p_cod_cta_ctbl_pai [output]

Código da Conta Contábil Pai.

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