Documento de API

Produto:

Datasul

Ocorrência:

Documentação de API

Nome Físicoprgfin/apb/apb911za

Objetivo

Atualizar informações referentes a cheques administrativos no Contas a Pagar.

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/apb911za.py (Input 1,

                                         Input table tt_cheq_ap_adm

      Output table tt_log_erros_cheq_ap).

 

Os parâmetros de entrada são:

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

tt_cheq_ap_adm: conterá os dados do cheque administrativo a ser atualizado

tt_log_erros_cheq_ap: : conterá as informações do retorno dos erros ocorridos na atualização.

Tabelas Temporárias

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

 

Tabela Temporária

Descrição

Entrada/Saída

tt_cheq_ap_adm

Conterá as informações do cheque administrativo a ser atualizado.

Entrada

Atributo

Tipo

Formato

Descrição

Obrig.

Evol.

tta_num_cheque

integer

>>>>,>>>,>>9

Num Cheque

 

 

tta_cod_estab_cheq

character

x(3)

Estabelec Cheque

 

 

tta_num_id_cheq_ap

integer

9999999999

Token cheq_ap

 

 

tta_dat_emis_cheq_administ

date

99/99/9999

EmissÆo Cheque Admin

 

 

tta_ind_localiz_cheq_administ

character

x(16)

Localiza‡Æo

 

 

tta_dat_retir_cheq_administ

date

99/99/9999

Retirada Cheque Admi

 

 

tta_dat_cancel_cheq_administ

date

99/99/9999

Cancel Cheque Adm

 

 

tta_dat_termo_respde_cheq

date

99/99/9999

Termo Resp Cheq ADM

 

 

tta_nom_usuar_termo_respde

character

x(40)

Usu rio

 

 

 

def temp-table tt_cheq_ap_adm no-undo
    field tta_num_cheque                   as integer format ">>>>,>>>,>>9" initial ? label "Num Cheque" column-label "Num Cheque"
    field tta_cod_estab_cheq               as character format "x(3)" label "Estabelec Cheque" column-label "Estabelec Cheque"
    field tta_num_id_cheq_ap               as integer format "9999999999" initial 0 label "Token cheq_ap" column-label "Token cheq_ap"
    field tta_dat_emis_cheq_administ       as date format "99/99/9999" initial ? label "EmissÆo Cheque Admin" column-label "EmissÆo Cheque Admin"
    field tta_ind_localiz_cheq_administ    as character format "x(16)" initial "Nenhum" label "Localiza‡Æo" column-label "Localiza‡Æo"
    field tta_dat_retir_cheq_administ      as date format "99/99/9999" initial ? label "Retirada Cheque Admi" column-label "Retirada Cheque Admi"
    field tta_dat_cancel_cheq_administ     as date format "99/99/9999" initial ? label "Cancel Cheque Adm" column-label "Cancel Cheque Adm"
    field tta_dat_termo_respde_cheq        as date format "99/99/9999" initial ? label "Termo Resp Cheq ADM" column-label "Termo Resp Cheq ADM"
    field tta_nom_usuar_termo_respde       as character format "x(40)" label "Usu rio" column-label "Usu rio"
    .

 

Tabela Temporária

Descrição

Entrada/Saída

tt_log_erros_cheq_ap

Conterá as informações dos erros encontrados durante as validações para a atualização do número do cheque.

Entrada

Atributo

Tipo

Formato

Descrição

Obrig.

Evol.

tta_cod_estab_cheq

character

x(3)

Estabelec Cheque

 

 

tta_num_id_cheq_ap

integer

9999999999

Token cheq_ap

 

 

tta_num_cheque

integer

>>>>,>>>,>>9

Num Cheque

 

 

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

 

 

 

def temp-table tt_log_erros_cheq_ap no-undo
    field tta_cod_estab_cheq               as character format "x(3)" label "Estabelec Cheque" column-label "Estabelec Cheque"
    field tta_num_id_cheq_ap               as integer format "9999999999" initial 0 label "Token cheq_ap" column-label "Token cheq_ap"
    field tta_num_cheque                   as integer format ">>>>,>>>,>>9" initial ? label "Num Cheque" column-label "Num Cheque"
    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"
    index tt_erro                          is primary unique
          tta_cod_estab_cheq               ascending
          tta_num_id_cheq_ap               ascending
          ttv_num_mensagem                 ascending
    .