Documento de API

Produto:

Datasul

Versões:

12.1.19 ou superior

Ocorrência:

Documentação de API

Nome Físico

prgfin/apb/apb532za


Objetivo

Realizar a vinculação de Antecipações a Títulos do Contas a Pagar. A vinculação é "Vários para Vários", isto é, poderão ser vinculadas várias Antecipações a um Título ou vice-versa.


Parâmetros de entrada

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

p_dat_transacao: Data de Transação que será utilizada para realizar a operação;

tt_vinc_an_x_tit: Temp-Table com as informações das Antecipações e Títulos que devem ser vinculados.


Parâmetros de saída

tt_erro_msg: Temp-Table com os erros ocorridos durante a operação.

Funcionamento

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

run prgfin/apb/apb532za.py persisten set v_hdl_api.

run pi_main_code_api_vinc_an_x_tit_ap in v_hdl_api (input 1,
                                                                                       input p_dat_transacao,
                                                                                       input table tt_vinc_an_x_tit,
                                                                                       output table tt_erro_msg).
delete procedure v_hdl_api.

Tabelas Temporárias


Tabela Temporária

Descrição

Entrada/Saída

tt_vinc_an_x_tit

Informações das Antecipações e Títulos que serão vinculados.

Entrada

Atributo

Tipo

Formato

Descrição

Obrig.

Evol.

ttv_cod_estab_ant

characterx(5)Estabelecimento da Antecipação

Sim


ttv_num_id_ant

integer999999999Num-ID (Token) do Título de Antecipação

Sim


ttv_cod_estab_tit_ap

characterx(5)Estabelecimento do Título

Sim


ttv_num_id_tit_ap

integer999999999Num-ID (Token) do Título

Sim


ttv_val_vincul

decimal->>,>>>,>>>,>>9.99Valor a ser Vinculado

Sim


ttv_val_cotac_indic_econ

decimal->>,>>>,>>>,>>9.9999999999Cotação Informada

Não


ttv_des_text_histor

characterx(2000)Histórico

Não



def temp-table tt_vinc_an_x_tit no-undo

      field ttv_cod_estab_ant as character format "x(5)" column-label "Estab AN"
      field ttv_num_id_ant as integer format "999999999" initial 0 label "Token Tít AN" column-label "Token Tít AN"
      field ttv_cod_estab_tit_ap as character format "x(5)" column-label "Estab Tít"
      field ttv_num_id_tit_ap as integer format "999999999" initial 0 label "Token Tít AP" column-label "Token Tít AP"
      field ttv_val_vincul as decimal format "->>,>>>,>>>,>>9.99" decimals 2 label "Valor Vinculado" column-label "Valor Vinculado"
      field ttv_val_cotac_indic_econ as decimal format "->>,>>>,>>>,>>9.9999999999" decimals 10 label "Cotação" column-label "Cotação"
      field ttv_des_text_histor as character format "x(2000)" label "Histórico" column-label "Histórico"
      index tt_id is primary unique
                ttv_cod_estab_ant ascending
                ttv_num_id_ant ascending
                ttv_cod_estab_tit_ap ascending
                ttv_num_id_tit_ap ascending.



Tabela Temporária

Descrição

Entrada/Saída

tt_erro_msg

Temp-Table com os erros ocorridos durante a operação.

Saída

Atributo

Tipo

Formato

Descrição

Obrig.

Evol.

ttv_num_msg_erro

integer>>>>>>9Número do ErroSim


ttv_des_msg_erro

characterx(60)Mensagem de ErroSim


ttv_des_help_erro

characterx(200)Texto de Ajuda do ErroSim



def temp-table tt_erro_msg no-undo
      field ttv_num_msg_erro as integer format ">>>>>>9" label "Mensagem" column-label "Mensagem"
      field ttv_des_msg_erro as character format "x(60)" label "Mensagem Erro" column-label "Inconsistência"
      field ttv_des_help_erro as character format "x(200)"
      index tt_num_erro
                ttv_num_msg_erro ascending.