Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

Documento de API

Produto:

Datasul

Ocorrência:

Documentação de API

Nome Físicoprgfin/acr/
acr741za
acr741zb

 


Objetivo

Efetuar a importação de ocorrência bancária para títulos do Contas a Receber .

 

Funcionamento

que já tiveram entrada confirmada no banco. A API aceita as ocorrências bancárias de "Pedido de Baixa", "Baixa cobrança sem título", "Protestar imediatamente", "Cancelar protesto", "Não cobrar juros mora" e "Pedido de Devolução".


Funcionamento

Na forma padrão, realiza-se a chamada do programa em modo persistente, sem a passagem de parâmetros, e em seguida, através de um comando RUN normal, executa-se seu método padrão passando-se os parâmetros com as informações necessárias.

def var v_hdl_program as Handle format ">>>>>>9":U no-undo.Executar o programa API(utilizar o nome externo), da seguinte forma:

run prgfin/acr/

...

acr741zb.py persistent set v_hdl_program.
run pi_main_api_integr_ocor_bcia_2 in v_hdl_program (input

...

2,
                                                   input table tt_integr_ocor_bcia,

...

                                                   input table tt_integr_item_ocor_bcia,

...

                                                   output table tt_log_erros_ocor_bcia).

if valid-handle(v_hdl_program) then
    delete procedure v_hdl_program.

 

Parâmetro Entrada API Alteração Títulos/Contas a Receber:

num_vers_integr_api: será utilizado para determinar se o programa que está chamando está íntegro com as definições correntes da API;

...

tt_log_erros_estorn_cancel_apb: conterá os dados dos erros ocorridos durante a execução do programa. 


Tabelas Temporárias

...


Tabela Temporária

Descrição

Entrada/Saída

tt_integr_item_ocor_bcia

Conterá as informações do título.

Entrada


(*) 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_num_id_tit_acr

integer

9999999999

Token Cta Receber

 

 



ttv_cod_

rec

id_ocor_bcia

recid

>>>>>>9

 

 

character

x(80)

string(rowid(tt_integr_item_ocor_bcia))

 



tta_cod_portador

character

x(5)

Portador

 

 



tta_cod_cart_bcia

character

x(3)

Carteira

 

 

...



def

...

temp-table

...

tt_integr_item_ocor_bcia

...

no-undo

...

    field

...

tta_cod_

...

estab                    as character format "x(3)"

...

label

...

"Estabelecimento"

...

column-label

...

"Estab"

...

    field

...

tta_num_id_tit_

...

acr               as integer format "9999999999"

...

initial

...

0

...

label

...

"Token

...

Cta

...

Receber"

...

column-label

...

"Token

...

Cta

...

Receber"

...

    field

...

ttv_cod_

...

id_ocor_

...

bcia             as character format "x(80)"

    field tta_cod_portador                 as character format

...

"x(5)"

...

label

...

"Portador"

...

column-label

...

"Portador"

...

    field

...

tta_cod_cart_

...

bcia                as character format "x(3)"

...

label

...

"Carteira"

...

column-label

...

"Carteira"

...

    index

...

tt_id_

...

item                       is primary unique

          tta_cod_estab                    ascending

         

          tta_cod_estab                    ascending

...

tta_num_id_tit_

...

acr               ascending

...

    .

 


Tabela Temporária

Descrição

Entrada/Saída

tt_integr_ocor_bcia

Conterá as informações da ocorrência bancária em geral.

Entrada

Atributo

Tipo

Formato

Descrição

Obrig.

Evol.

ttv_cod_tip_ocor_bcia

character

x(8)

 

 

 




ttv_dat_movto

date

99/99/9999

Data Movimento

 

 



ttv_log_tit_sdo

logical

Sim/NÆo

Títulos com Saldo

 

 



ttv_cod_

rec

id_ocor_

bcia

bcia 

recid

>>>>>>9

 

 

character

x(80)

Mesmo conteúdo da tt_integr_item_ocor_bcia.ttv_cod_id_ocor_bcia 

 



ttv_log_bloq_tit_envdo_bcia

logical

Sim/Não

 

 

 

...





def

...

temp-table

...

tt_integr_ocor_bcia

...

no-undo

...

 field ttv_cod_tip_ocor_

...

bcia            as character format "x(8)"

...

 field ttv_dat_

...

movto                    as date format "99/99/9999"

...

label

...

"Data

...

Movimento"

...

column-label

...

"Data

...

Movimento"

...

 field ttv_log_tit_

...

sdo                  as logical format "Sim/

...

Não"

...

initial

...

no

...

label

...

"

...

Títulos com

...

Saldo"

...

 field ttv_cod_id_ocor_

...

bcia             as character format "x(80)"

 field ttv_log_bloq_tit_envdo_

...

bcia      as logical format "Sim/

...

Não"

...

initial

...

yes

...

 index tt_id_ocor_

...

bcia                  is primary unique

         

...

ttv_cod_tip_ocor_

...

bcia            ascending

          ttv_cod_id_ocor_bcia             ascending
    .

          ttv_rec_ocor_bcia                ascending
    .

 


Tabela Temporária

Descrição

Entrada/Saída

tt_log_erros_ocor_bcia

Conterá as informações de erro que poderão ocorrer na execução do programa

Entrada


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

(**) Liberado o número de documento com 16 posições e série com 5, a partir de maio/2011.

Atributo

Tipo

Formato

Descrição

Obrig.

Evol.

ttv_cod_ocor_bcia

character

x(30)

Ocorrência Bcia

 

 



tta_cod_estab

character

x(3) / x(5)*

Estabelecimento

 

 



tta_cod_espec_docto

character

x(3)

Espécie Documento

 

 



tta_cod_ser_docto

character

x(3)/x(5)**

Série Documento

 

 



tta_cod_tit_acr

character

x(10)/x(16)**

Título

 

 



tta_cod_parcela

character

x(02)

Parcela

 

 



tta_num_mensagem

integer

>>,>>>,>>9

Mensagem

 

 



ttv_des_msg

character

x(40)

 

 

 




ttv_des_ajuda

character

x(50)

Ajuda

 

 

 




def

...

temp-table

...

tt_log_erros_ocor_bcia

...

no-undo

   

...

field

...

ttv_cod_ocor_bcia               

...

as

...

character

...

format

...

"x(30)"

...

label

...

"

...

Ocorrência Bcia"

...

column-label

...

"

...

Ocorrência Bcia"

   

...

field

...

tta_cod_

...

estab                    as character format "x(

...

5)"

...

label

...

"Estabelecimento"

...

column-label

...

"Estab"

   

...

field

...

tta_cod_espec_docto             

...

as

...

character

...

format

...

"x(3)"

...

label

...

"

...

Espécie Documento"

...

column-label

...

"

...

Espécie"

   

...

field

...

tta_cod_ser_docto               

...

as

...

character

...

format

...

"x(3)"

...

label

...

"

...

Série Documento"

...

column-label

...

"

...

Série"

   

...

field

...

tta_cod_tit_acr                 

...

as

...

character

...

format

...

"x(10)"

...

label

...

"

...

Título"

...

column-label

...

"

...

Título"

   

...

field

...

tta_cod_parcela                 

...

as

...

character

...

format

...

"x(02)"

...

label

...

"Parcela"

...

column-label

...

"Parc"

   

...

field

...

tta_num_mensagem                

...

as

...

integer

...

format

...

">>,>>>,>>9"

...

initial

...

0

...

label

...

"Mensagem"

...

column-label

...

"Mensagem"

   

...

field

...

ttv_des_msg                     

...

as

...

character

...

format

...

"x(40)"

   

...

field

...

ttv_des_

...

ajuda                    as character format "x(50)"

...

label

...

"Ajuda"

...

column-label

...

"Ajuda"

...

.

...