Documento de API

Produto:

Datasul

Ocorrência:

Documentação de API

Nome Físicoprgfin/apb/apb553za


Objetivo: Efetuar pagamento online no módulos do Contas a Pagar


Parâmetros de Entrada

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

tt_integr_item_pagto_online: será utilizado para determinar as informações referente ao Item do borderô que será pago online.


Parâmetros de Saída

tt_integr_item_pagto_online: Retorna os erros que ocorreram durante o processo de Pagamento Online.

Funcionamento

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


run prgfin/apb/apb553za.py persistent set v_hdl_aux (input 2).

run pi_main_code_api_process_pagto_online in v_hdl_aux (input-output table tt_integr_item_pagto_online).

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_integr_item_pagto_online

Conterá as informações do Item do borderô.

Entrada/Saída

Atributo

Tipo

Formato

Descrição

Obrig.

Evol.

tta_cod_estab_bord

character

X(5)

Estabelecimento do Borderô

Sim


tta_cod_portador

character

X(5)

Portador

Sim


tta_num_bord_ap

integer

>>>>>9

Número Borderô

Sim


tta_num_seq_bord

integer

>>>9

Sequência

Não


tta_cod_sit_pagto_online

character

x(20)

Situação Pagamento Online (Retorna a situação do pagamento)

Não


tta_des_rej

Character

X(200)

Descrição Rejeição (Retorna a descrição do erro ocorrido no pagamento)

Não


tta_cod_banco

Character

X(08)

Banco

Não


  
  def temp-table tt_integr_item_pagto_online        
    field tta_cod_estab_bord               as character format "x(5)" label "Estabelecimento" column-label "Estab"
    field tta_cod_portador                 as character format "x(5)" label "Portador" column-label "Portador"
    field tta_num_bord_ap                  as integer format ">>>>>9" initial 0 label "N£mero Border“" column-label "Border“"
    field tta_num_seq_bord                 as integer format ">>>9" initial 0 label "Sequˆncia" column-label "Seq"
    field tta_cod_sit_pagto_online         as character format "x(20)" label "Sit Pagto Online" column-label "Sit Pagto Online"
    field tta_des_rej                      as character format "x(200)" label "Rejei‡Æo" column-label "Rejei‡Æo"
    field tta_cod_banco                    as character format "x(8)" label "Banco" column-label "Banco"
    index tt_id                            is primary
          tta_cod_estab_bord               ascending
          tta_cod_portador                 ascending
          tta_num_bord_ap                  ascending
          tta_num_seq_bord                 ascending
    .