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

A API/BO...

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/apb773za.py (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

 

Entrada

Atributo

Tipo

Formato

Descrição

Obrig.

Evol.

referencia

character

x(10)

referencia

 

 

ep-codigo

integer

>>9

ep-codigo

 

 

cod-empresa

character

x(3)

cod-empresa

 

 

cod-estabel

character

x(3)

cod-estabel

 

 

cod-estab-ems5

character

x(3)

cod-estab-ems5

 

 

cod-fornec

integer

>>>>>9

cod-fornec

 

 

cod-esp

character

!!

cod-esp

 

 

serie

character

x(5)

serie

 

 

nr-docto

character

x(16)

nr-docto

 

 

tot-saldo

decimal

>>>>>>>,>>9.99

tot-saldo

 

 

tot-baixa

decimal

>>>>>>>,>>9.99

tot-baixa

 

 

mo-codigo

integer

>9

mo-codigo

 

 

cotacao-dia

decimal

>>>,>9.99999999

cotacao-dia

 

 

dt-trans

date

99/99/9999

dt-trans

 

 

nr-docto-cr

character

x(16)

nr-docto-cr

 

 

serie-cr

character

x(5)

serie-cr

 

 

cod-esp-cr

character

!!

cod-esp-cr

 

 

tp-codigo

integer

>>9

tp-codigo

 

 

conta-debito

character

x(17)

conta-debito

 

 

sequencia

integer

 

sequencia

 

 

erro

logical

Sim/Não

erro

 

 

 

def temp-table tt-tot-tit

    field referencia     as character format "x(10)"

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

    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*/

    index seq            is primary unique

          sequencia

    index titulo

          serie

          nr-docto.

 

Tabela Temporária

Descrição

Entrada/Saída

tt-titulo

 

Entrada

Atributo

Tipo

Formato

Descrição

Obrig.

Evol.

sequencia

integer

 

 

 

 

parcela

character

x(02)

 

 

 

vl-saldo

decimal

>>>>>>>,>>9.99

 

 

 

vl-baixa

decimal

>>>>>>>,>>9.99

 

 

 

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

 

Entrada

Atributo

Tipo

Formato

Descrição

Obrig.

Evol.

tta_cod_estab

character

x(3)

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(3)" 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"

    .