Linha Datasul

Árvore de páginas

Versões comparadas

Versão antiga 6

changes.mady.by.user Tatiane Cristina Roos

Gravado em

comparado com

Nova versão 7

changes.mady.by.user Rafaela Gomes

Gravado em

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

Documento de API

Produto:

Datasul

Ocorrência:

Documentação de API

Nome Físicoprgfin/apb/apb768ze

Objetivo

Efetuar o estorno de movimentos dos títulos do contas a pagar ou o cancelamento dos mesmos.

Funcionamento

A sintaxe para a chamada da API/BO é:

...

run pi_main_code_apb768ze_new_1 in 2 in v_hdl_api (input p_num_vers_integr_api,
                                                                        input p_cod_modulo,
                                                                        input p_cod_matriz_trad_org_ext,
                                                                        input p_log_estorn_tit_relacto_comiss,
                                                                        input table tt_cancelamento_estorno_apb_3,
                                                                        input table tt_estornar_agrupados_1,
                                                                        output table tt_log_erros_atualiz,
                                                                        output table tt_log_erros_estorn_cancel_apb,
                                                                        output table tt_estorna_tit_imptos,
                                                                        output p_log_confir_estorn_cancel).

delete procedure v_hdl_api.

Considerações:

Antes das definições das temp-tables é necessário incluir a definição da include abaixo. 

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

Os parâmetros de entrada são:

Parâmetro

Descriçã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, utilizar o valor "1".

p_cod_moduloConterá o módulo, será utilizado para verificar se o módulo é “rep”.
p_cod_matriz_trad_org_extConterá o código da matriz de tradução da organização externa que tem por finalidade relacionar os códigos externos aos códigos presentes no Datasul-EMS5, caso a matriz de tradução não tiver sido informada, o parâmetro estará em branco.
p_log_estorn_tit_relacto_comissIndica se deve estornar o Título mesmo que ele esteja vinculado a uma comissão no Contas a Receber.
tt_cancelamento_estorno_apb_3Conterá os dados dos Títulos ou Movimentos a serem estornos/cancelamentos.
tt_estornar_agrupados_1Esta temp-table somente deverá ser criada no programa chamador e passada como parâmetro, a mesma é de uso interno e não poderá conter valor no momento da passagem como parâmetro.

Os parâmetros de saída são:

Parâmetro

Descrição

tt_log_erros_atualizConterá os dados dos erros ocorridos durante a execução do programa.
tt_log_erros_estorn_cancel_apbConterá os dados dos erros ocorridos durante a execução do programa.
tt_estorna_tit_imptosConterá os títulos que podem conter impostos vinculados ao fornecedor. A mesma é de uso interno.
p_log_confir_estorn_cancelVariável do tipo lógico, que receberá o valor do retorno do programa, porém está variável não deverá ser utilizada pelo programa que chama a api após o retorno. A mesma é de uso interno.

Tabelas Temporárias


Tabela Temporária

Descrição

Entrada/Saída

tt_cancelamento_estorno_apb_3

Conterá as informações do título e informações gerais.

Entrada

...

Atributo

Tipo

Formato

Descrição

Obrig.

Evol.

ttv_ind_niv_operac_apb

character

X(10)

1 = Movimento

2 = Titulo



ttv_ind_tip_operac_apb

character

X(12)

1 = Estorno

2 = Cancelamento



tta_cod_estab

character

x(3) / x(5)*

Estabelecimento



tta_num_id_tit_ap

integer

1E+10

Token Tit AP



tta_num_id_movto_tit_ap

integer

1E+10

Token Movto Tit AP



tta_cod_refer

character

x(10)

Referência



tta_dat_transacao

date

99/99/9999

Data Transação



tta_cod_histor_padr

character

x(8)

Histórico Padrão



ttv_des_histor

character

x(40)

Contém



ttv_ind_tip_estorn

character

X(10)

1 = Parcial

2 = Total



tta_cod_portador

character

x(5)

Portador



ttv_cod_estab_reembol

character

x(8)

Estabelecimento Reembolso



ttv_log_reaber_item

logical

Sim/Não

Reabre Item



ttv_log_reembol

logical

Sim/Não

Reembolso



ttv_log_estorn_impto_retid

logical

Sim/Não

Estorna Imposto



tta_cod_estab_ext

character

x(8)

Estabelecimento Externo



ttv_recrow_tit_ap

recid\rowid

>>>>>>9 (recid)

Recid\Rowid Título



tta_cdn_fornecedor

Integer

>>>,>>>,>>9

Fornecedor



tta_cod_espec_docto

character

x(3)

Espécie Documento



tta_cod_ser_docto

character

x(3)/x(5)**

Série Documento



tta_cod_tit_ap

character

x(10)/x(16)**

Título



tta_cod_parcela

character

x(02)

Parcela



ttv_log_estorn_todos_movlogicalSim/NãoEstorna Todos os Movimentos do Título ?

...

def temp-table tt_cancelamento_estorno_apb_3 no-undo
      field ttv_ind_niv_operac_apb as character format "X(10)"
      field ttv_ind_tip_operac_apb as character format "X(12)"
      field tta_cod_estab as character format "x(5)" label "Estabelecimento" column-label "Estab"
      field tta_num_id_tit_ap as integer format "9999999999" initial 0 label "Token Tit AP" column-label "Token Tit AP"
      field tta_num_id_movto_tit_ap as integer format "9999999999" initial 0 label "Token Movto Tit AP" column-label "Id Tit AP"
      field tta_cod_refer as character format "x(10)" label "Referência" column-label "Referência"
      field tta_dat_transacao as date format "99/99/9999" initial today label "Data Transação" column-label "Dat Transac"
      field tta_cod_histor_padr as character format "x(8)" label "Histórico Padrão" column-label "Histórico Padrão"
      field ttv_des_histor as character format "x(40)" label "Contém" column-label "Histórico"
      field ttv_ind_tip_estorn as character format "X(10)"
      field tta_cod_portador as character format "x(5)" label "Portador" column-label "Portador"
      field ttv_cod_estab_reembol as character format "x(8)"
      field ttv_log_reaber_item as logical format "Sim/Não" initial yes
      field ttv_log_reembol as logical format "Sim/Não" initial yes
      field ttv_log_estorn_impto_retid as logical format "Sim/Não" initial yes
      field tta_cod_estab_ext as character format "x(8)" label "Estabelecimento Exte" column-label "Estabelecimento Ext"
      field ttv_recrow_tit_ap                   as &IF "{&ROWID_READY}" = "YES" &THEN rowid &ELSE recid format ">>>>>>9" initial ? &ENDIFRowid
      field tta_cdn_fornecedor as Integer format ">>>,>>>,>>9" initial 0 label "Fornecedor" column-label "Fornecedor"
      field tta_cod_espec_docto as character format "x(3)" label "Espécie Documento" column-label "Espécie"
      field tta_cod_ser_docto as character format "x(5)" label "Série Documento" column-label "Série"
      field tta_cod_tit_ap as character format "x(16)" label "Título" column-label "Título"
      field tta_cod_parcela as character format "x(02)" label "Parcela" column-label "Parc"
      field ttv_log_estorn_todos_mov as logical format "Sim/Não" initial no
      .

...

Tabela Temporária

Descrição

Entrada/Saída

tt_estornar_agrupados_1

Esta temp-table apenas deverá ser definida, não poderá receber valor, é de uso interno.

Entrada

...

Atributo

Tipo

Formato

Descrição

Obrig.

Evol.

ttv_num_seq

integer

>>>,>>9

Seqüência



tta_nom_abrev

character

x(15)

Nome Abreviado



tta_cod_estab_pagto

character

x(3) / x(5)*

Estabelecimento Pagamento



tta_cod_refer

character

x(10)

Referência



tta_dat_pagto

date

99/99/9999

Data Pagamento



tta_cod_estab

character

x(3) / x(5)*

Estabelecimento



tta_cod_espec_docto

character

x(3)

Espécie Documento



tta_cod_ser_docto

character

x(3)/x(5)**

Série Documento



tta_cod_tit_ap

character

x(10)/x(16)**

Título



tta_cod_parcela

character

x(02)

Parcela



tta_val_movto_ap

decimal

->>>,>>>,>>9.99

Valor Movimento



tta_ind_modo_pagto

character

X(10)

Modo Pagamento



tta_cod_empresa

character

x(3)

Empresa



ttv_cod_recid_tit_ap

recid\rowidcharacter

>>>>>>9 x(recid20)

Recid\Rowid Título



ttv_num_seq_abrev

integer

>>>9

Sequência



tta_ind_trans_ap_abrev

character

X(04)

Transação Abreviada



ttv_reccod_id_compl_movto_pagto

recid\rowidcharacter

>>>>>>9 x(recid20)Recid\Rowid




ttv_reccod_id_movto_tit_ap

recid\rowidcharacter

>>>>>>9 x(recid20)

Recid\Rowid




ttv_reccod_id_item_cheq_ap

recid\rowidcharacter

>>>>>>9 x(recid20)

Recid\Rowid




ttv_cod_recid_item_bord_ap

recid\rowidcharacter

>>>>>>9 x(recid20)Recid\Rowid




ttv_cod_recid_item_lote_pagto

recid\rowidcharacter

>>>>>>9 x(recid20)

Recid\Rowid





def temp-table tt_estornar_agrupados_1 no-undo
      field field ttv_num_seq as integer                      as integer format ">>>,>>9" label "SeqüênciaSeq?ncia" column-label "Seq"
      field field tta_nom_abrev as                    as character format "x(15)" label "Nome Abreviado" column-label "Nome Abreviado"
      field field tta_cod_estab_pagto as              as character format "x(5)" label "Estab Pagto" column-label "Estab Pagto"
      field field tta_cod_refer as                    as character format "x(10)" label "ReferênciaRefer?ncia" column-label "ReferênciaRefer?ncia"
      field field tta_dat_pagto as                    as date format "99/99/9999" initial today label "Data Pagamento" column-label "Data Pagto"
      field field tta_cod_estab as character                    as character format "x(5)" label "Estabelecimento" column-label "Estab"
      field field tta_cod_espec_docto as              as character format "x(3)" label "Espécie Esp?cie Documento" column-label "EspécieEsp?cie"
      field field tta_cod_ser_docto as                as character format "x(5)" label "Série S?rie Documento" column-label "SérieS?rie"
      field field tta_cod_tit_ap                   as character format "x(16)" label "TítuloT¡tulo" column-label "TítuloT¡tulo"
      field field tta_cod_parcela as                  as character format "x(02)" label "Parcela" column-label "ParcParcela"
      field field tta_val_movto_ap as                 as decimal format "->>>,>>>,>>9.99" decimals 2 initial 0 label "Valor Movimento Movimento" column-label "Valor Movto"
      field field tta_ind_modo_pagto               as character format "X(10)" label "Modo Pagamento Pagamento" column-label "Modo Pagto"
      field field tta_cod_empresa as                  as character format "x(3)" label "Empresa" column-label "Empresa"
      field ttv_reccod_id_tit_ap                   as &IF "{&ROWID_READY}" = "YES" &THEN rowid &ELSE recid format ">>>>>>9" initial ? &ENDIF as character format "x(20)"
      field ttv_num_seq_abrev as integer _1              as integer format ">>>9" label "SqSeq" column-label "Seq"
      field field tta_ind_trans_ap_abrev           as character format "X(04)" label "Trans Abrev" column-label "Trans Abrev"
      field ttv_reccod_id_compl_movto_pagto        as &IF "{&ROWID_READY}" = "YES" &THEN rowid &ELSE recid format ">>>>>>9" &ENDIFas character format "x(20)"
      field ttv_cod_recid_movto_tit_ap             as &IF "{&ROWID_READY}" = "YES" &THEN rowid &ELSE recid format ">>>>>>9" &ENDIF
      field ttv_rec as character format "x(20)"
    field ttv_cod_id_item_cheq_ap             as &IF "{&ROWID_READY}" = "YES" &THEN rowid &ELSE recid format ">>>>>>9" &ENDIF as character format "x(20)"
      field ttv_reccod_id_item_bord_ap             as &IF "{&ROWID_READY}" = "YES" &THEN rowid &ELSE recid format ">>>>>>9" &ENDIF as character format "x(20)"
      field ttv_reccod_id_item_lote_pagto          as &IF "{&ROWID_READY}" = "YES" &THEN rowid &ELSE recid format ">>>>>>9" &ENDIFas character format "x(20)"
      index tt_ind_modo modo                     
               ttatta_ind_modo_pagto               ascending
       .


Tabela Temporária

Descrição

Entrada/Saída

tt_log_erros_atualiz

Conterá as informações de erro que poderão ocorrer na execução do programa.

Saída

...