Documento de API

Objetivo

Retornar o rowid e num_id_tit_ap da tabela tit_ap (Contas a Pagar) conforme a chave do título informada ao programa.

Funcionamento

Na forma padrão, realiza-se a chamada através de um comando RUN normal, passando-se as informações necessárias.

A sintaxe para a chamada da API/BO é:

def var v_hdl_api as Handle format ">>>>>>9":U no-undo.

run prgfin/apb/apb788zb.py persistent set v_hdl_api.
run pi_main_code_api_retorna_id_tit_ap in v_hdl_api ( input  2,
                                                      input  p_cod_estab,
                                                      input  p_cod_estab_ext,
                                                      input  p_cod_matriz_trad_org_ext,
                                                      input  p_cod_espec_docto,
                                                      input  p_cdn_fornecedor,
                                                      input  p_cod_ser_docto,
                                                      input  p_cod_tit_ap,
                                                      input  p_cod_parcela,
                                                      output p_cod_return,
                                                      output v_row_tit_ap,
                                                      output p_num_id_tit_ap).

delete object v_hdl_api.

Parâmetros Entrada/Saída da API

Os parâmetros de entrada e saída 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;

p_cod_estab: receberá o código do estabelecimento que já está traduzido e que será utilizada para buscar a Unidade de Negócio;

p_cod_estab_ext: receberá o código do estabelecimento a ser traduzido e será feita a tradução da mesma;

p_cod_matriz_trad_org_ext: receberá o código da matriz de tradução da Unidade Organizacional para poder fazer a tradução do código do estabelecimento. Este campo só deverá ser informado quando o p_cod_estab_ext estiver preenchido;

p_cod_espec_docto: receberá o código da espécie do título a ser pesquisado;

p_cdn_fornecedor: receberá o código do fornecedor do título a ser pesquisado;

p_cod_ser_docto: receberá o código da série do título a ser pesquisado;

p_cod_tit_ap: receberá o código do título a ser pesquisado;

p_cod_parcela: receberá o número da parcela do título a ser pesquisado;

p_cod_return: caso ocorra erro será retornado o código e a descrição desse erro, caso contrário será retornado “OK”;

p_row_tit_ap: retornará o rowid da tabela tit_ap (Contas a Pagar);

p_num_id_tit_ap: retornará o num_id da tabela tit_ap (Contas a Pagar);