Documento de API

Produto:

Datasul

Ocorrência:

Documentação de API

Nome Físicoprgfin/apb/apb751za

 

Objetivo

Efetuar o estorno de um pagamento gerado pelo processo de Encontro de Contas. Esta API faz o mesmo processo que a tela “Estorno Encontro de Contas” (prgfin/apb/apb751ab.r) realiza hoje.

Parâmetros de Entrada

tt_estorno_enctro_cta: Lista de pagamentos via encontro de contas que devem ser estornados;

tt_erros_api: erros ocorridos no encontro de contas. Quando houver mais de um registro de encontro de contas, o sistema irá tentar estornar todos, só irá desfazer o estorno nos registros que apresentem alguma inconsistência.

 

Funcionamento

A sintaxe para executar a API/BO em modo persistente é:

Def var v_hdl_aux as handle no-undo.

 

run prgfin/apb/apb751za.py persistent set v_hdl_aux.

 

run pi_main_estorno_enctro_cta_1 in v_hdl_aux (input table tt_estorno_enctro_cta,

                                               output table tt_erros_api).

A variável denominada v_hdl_aux irá receber o “handle” do programa, permitindo o acesso aos “métodos” internos da API.

 

Tabelas Temporárias

 

Tabela Temporária

Descrição

Entrada/Saída

tt_estorno_enctro_cta

Lista de encontro de contas a serem estornados

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)

Estabelecimento

 

 

tta_cod_refer

character

x(10)

Referência Encontro de Contas

 

 

ttv_cod_refer_estorn            

character

x(10)

Referência do Estorno

 

 

tta_dat_transacao               

character

99/99/9999

Data Transação

 

 

tta_des_text_histor             

character

x(2000)

Descrição Histórico

 

 

 

def temp-table tt_estorno_enctro_cta 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 ttv_cod_refer_estorn             as character format "x(8)"

    field tta_dat_transacao                as date format "99/99/9999" initial today label "Data Transação" column-label "Dat Transac"

    field tta_des_text_histor              as character format "x(2000)" label "Histórico" column-label "Histórico"

    .

 

Tabela Temporária

Descrição

Entrada/Saída

tt_erros_api

Erros ocorridos na execução do estorno

Saída

Atributo

Tipo

Formato

Descrição

Obrig.

Evol.

ttv_num_erro

integer

>>>>>>9

 Número Erro

 

 

ttv_des_mensagem

character

x(50)

 Mensagem

 

 

ttv_des_ajuda

character

x(100)

Ajuda

 

 

ttv_row_id

rowid

x(3)

RowId da tabela tt_estorno_enctro_cta ao qual está relacionado o erro

 

 

def temp-table tt_erros_api no-undo

    field ttv_num_erro                     as integer format ">>>>,>>9"

    field ttv_des_mensagem                 as character format "x(50)" label "Mensagem" column-label "Mensagem"

    field ttv_des_ajuda                    as character format "x(50)" label "Ajuda" column-label "Ajuda"

    field ttv_row_id                       as Rowid

    .

#trackbackRdf ($trackbackUtils.getContentIdentifier($page) $page.title $trackbackUtils.getPingUrl($page))