Documento de API

Objetivo

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

Funcionamento

Antes da declaração das variáveis de entrada e saída é necessário definir a include abaixo:

/*-- Filtro RECID x ROWID Aplicado --*/
{include/i_fncrowid.i}

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 é:

run prgfin/apb/apb788za.py(input 1,

                           input c-cod-estab,

                           input c-cod-estab-ext,

                           input c-matr-trad,

                           input c-cod-especie,

                           input i-cod-fornecedor,

                           input c-cod-serie,

                           input c-cod-tit-ap,

                           input c-cod-parcela,

                           output c-retorno,

                           output rec-tit-ap,

                           output i-num-id-tit-ap).

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_rec_tit_ap: retornará o recid\rowid da tabela tit_ap (Contas a Pagar);  

A declaração do parâmetro de saída  p_rec_tit_ap deve ser conforme abaixo:

def output param p_rec_tit_ap  &IF "{&ROWID_READY}" = "YES" &THEN as rowid  &ELSE as recid format ">>>>>>9"  &ENDIF no-undo.

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