Documento de API

Produto:

Datasul

Ocorrência:

Documentação de API

Nome Físicoprgfin/apb/apb773za

 

Objetivo

Atualmente existe a possibilidade de Integração entre Recebimento x APB onde, ao criar e atualizar um Documento, é possível informar as Duplicatas que serão geradas no APB. O objetivo da Integração dos Módulos Faturamento x APB é justamente movimentar esses títulos que foram gerados quando ocorrer uma Devolução de Mercadoria, através de um Acerto de Valor a Crédito, uma alteração da Situação do Título para Devolvido ou a geração de uma Antecipação. A API tem como objetivo receber os títulos (duplicatas) que serão movimentados a partir da(s) Nota(s) de Crédito(s) gerada(s).

 

Funcionamento

Na forma padrão, realiza-se a chamada através de um comando RUN normal, passando-se as temp-tables carregadas com as informações necessárias.

A sintaxe para a chamada da API/BO é:

run prgfin/apb/apb773zb.py persistent set v_hdl_api_integr_faturam_apb (Input 1).

 

run pi_main_code_api_integracao_faturamento_apb_2 in v_hdl_api_integr_faturam_apb

                                              (Input table tt-tot-tit,         

                                                     Input table tt-titulo,        

                                                     Output table tt_log_erros_atualiz).

 

Parâmetros API Integração Faturamento x APB:

 

tt-tot-tit: tabela temporária que contém as duplicatas a serem devolvidas.

tt-titulo: tabela temporária que contém as várias parcelas envolvidas da(s) duplicata(s).

tt-log-erros-atualiz: retorna os erros que aconteceram ao integrar Faturamento x APB.

 

Tabelas Temporárias

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

 

Tabela Temporária

Descrição

Entrada/Saída

tt-tot-tit

Contém as duplicatas a serem devolvidas.

Entrada

 

(*) No EMS 2.06B a empresa é inteira no Datasul 11 a empresa é caracter.

(**) A partir da 5.07A o estabelecimento passa a ter cinco dígitos.

Atributo

Tipo

Formato

Descrição

Obrig.

Evol.

referencia

character

x(10)

Referência.

 

 

ep-codigo

integer/ character*

>>9/x(3)*

Empresa Externa.

 

 

cod-empresa

character

x(3)

Empresa.

 

 

cod-estabel

character

x(3) / x(5)**

Estabelecimento Externo.

 

 

cod-estab-ems5

character

x(3) / x(5)**

Estabelecimento.

 

 

cod-fornec

integer

>>>>>9

Fornecedor.

 

 

cod-esp

character

!!

Espécie.

 

 

serie

character

x(5)

Série.

 

 

nr-docto

character

x(16)

Título.

 

 

tot-saldo

decimal

>>>>>>>,>>9.99

Valor Total de Saldo.

 

 

tot-baixa

decimal

>>>>>>>,>>9.99

Valor Total da Baixa.

 

 

mo-codigo

integer

>9

Moeda.

 

 

cotacao-dia

decimal

>>>,>9.99999999

Cotação.

 

 

dt-trans

date

99/99/9999

Data de Transação.

 

 

nr-docto-cr

character

x(16)

Documento CR.

 

 

serie-cr

character

x(5)

Série CR.

 

 

cod-esp-cr

character

!!

Espécie CR.

 

 

tp-codigo

integer

>>9

tp-codigo

 

 

conta-debito

character

x(17)

Conta de Débito.

 

 

sequencia

integer

 

Sequência.

 

 

erro

logical

Sim/Não

Gerou Erro.

 

 

serie-nota

character

x(5)

Série da Nota.

 

 

nr-docto-nota

character

x(16)

Número do Documento da Nota.

 

 

cod-plano-ccusto

character

x(8)

Plano de Centro de Custo.

 

 

cod-ccusto        

character

x(20)

Centro de Custo.

 

 

cod-plano-cta-ctbl

character

x(8)

Plano de Conta Contábil.

 

 

 

def temp-table tt-tot-tit no-undo

    field referencia         as character format "x(10)"

    &IF '{&emsfin_version}' < '5.07A' &THEN

    field ep-codigo          as integer   format ">>9"

    &ELSE

    field ep-codigo          as char   format "x(3)"

    &ENDIF

    field cod-empresa        as character format "x(3)"

    field cod-estabel        as character format "x(3)"

    field cod-estab-ems5     as character format "x(3)"

    field cod-fornec         as integer   format ">>>>>9"

    field cod-esp            as character format "!!"

    field serie              as character format "x(5)"

    field nr-docto           as character format "x(16)"

    field tot-saldo          as decimal   format ">>>>>>>,>>9.99"

    field tot-baixa          as decimal   format ">>>>>>>,>>9.99"

    field mo-codigo          as integer   format ">9"

    field cotacao-dia        as decimal   format ">>>,>9.99999999"

    field dt-trans           as date      format "99/99/9999"

    field nr-docto-cr        as character format "x(16)"

    field serie-cr           as character format "x(5)"

    field cod-esp-cr         as character format "!!"

    field tp-codigo          as integer   format ">>9"

    field conta-debito       as character format "x(17)"

    field sequencia          as   integer

    field erro               as logical   format "Sim/Não" /*l_sim_nao*/

    field serie-nota         as character format "x(5)"

    field nr-docto-nota      as character format "x(16)"

    field cod-plano-ccusto   as character format 'x(8)'

    field cod-ccusto         as character format 'x(20)'

    field cod-plano-cta-ctbl as character format 'x(8)'

    index seq            is primary unique

          sequencia

    index titulo

          serie

          nr-docto.

 

Tabela Temporária

Descrição

Entrada/Saída

tt-titulo

Contém as várias parcelas envolvidas da(s) duplicata(s).

Entrada

Atributo

Tipo

Formato

Descrição

Obrig.

Evol.

sequencia

integer

 

Sequência.

 

 

parcela

character

x(02)

Parcela.

 

 

vl-saldo

decimal

>>>>>>>,>>9.99

Valor de Saldo.

 

 

vl-baixa

decimal

>>>>>>>,>>9.99

Valor da Baixa.

 

 

ind-baixa

logical

 

 

 

 

 

def temp-table tt-titulo

    field sequencia     as  integer

    field parcela       as character format "x(02)"

    field vl-saldo      as decimal   format ">>>>>>>,>>9.99"

    field vl-baixa      as decimal   format ">>>>>>>,>>9.99"

    field ind-baixa     as logical

    index titulo        is primary

          sequencia

          ind-baixa.

 

 

Tabela Temporária

Descrição

Entrada/Saída

tt_log_erros_atualiz

Retorna os erros que aconteceram ao integrar Faturamento x APB.

Saída

 

(*) A partir da 5.07A o estabelecimento passa a ter cinco dígitos.

Atributo

Tipo

Formato

Descrição

Obrig.

Evol.

tta_cod_estab

character

x(3) / x(5)*

Estabelecimento

 

 

tta_cod_refer

character

x(10)

Referência

 

 

tta_num_seq_refer

integer

>>>9

Sequência

 

 

ttv_num_mensagem

integer

>>>>,>>9

Número

 

 

ttv_des_msg_erro

character

x(60)

Mensagem Erro

 

 

ttv_des_msg_ajuda

character

x(40)

Mensagem Ajuda

 

 

ttv_ind_tip_relacto

character

X(15)

Tipo Relacionamento

 

 

ttv_num_relacto

integer

>>>>,>>9

Relacionamento

 

 

 

def new shared temp-table tt_log_erros_atualiz no-undo

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

    field tta_cod_refer                    as character format "x(10)" label "Referˆncia" column-label "Referˆncia"

    field tta_num_seq_refer                as integer format ">>>9" initial 0 label "Sequˆncia" column-label "Seq"

    field ttv_num_mensagem                 as integer format ">>>>,>>9" label "N£mero" column-label "N£mero Mensagem"

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

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

    field ttv_ind_tip_relacto              as character format "X(15)" label "Tipo Relacionamento" column-label "Tipo Relac"

    field ttv_num_relacto                  as integer format ">>>>,>>9" label "Relacionamento" column-label "Relacionamento"

    .