Documento de API

Objetivo

Funcionamento

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

A sintaxe para a chamada da API é:

run prgfin/acr/acr769zb.py (Input 1,

                            input-output table tt_integr_acr_estorn_cobr_1,

                      input-output table tt_antecip_vincul_sco,

                            Input        p_log_gera_carta_portad,

                            Input        p_nom_arq_carta_portad,

                            output table tt_log_erros_estorn_cobr).

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_acr_estorn_cobr: conterá os dados dos títulos de cobrança especial a serem estornados

p_log_gera_carta_portad: indicará se deve gerar uma carta do processo ao portador;

p_nom_arq_carta_portad: determinará o nome do arquivo para gerar a carta acima referenciada;

tt_log_erros_estorn_cobr: temp-table contendo os erros encontrados na execução, caso existam. Ficará sob responsabilidade o tratamento ou impressão de qualquer erro.

Para cada título de cobrança especial lido da tt_integr_acr_estorn_cobr parametrizada:

Num primeiro passo, o título de cobrança especial é validado, conforme as parametrizações recebidas. Ao encontrar algum erro, um registro correspondente ao erro é gravado na tabela temporária tt_log_erros_estorn_cobr e o processo é interrompido imediatamente após, seguindo-se da leitura do próximo título de cobrança especial. Caso na validação não ocorra nenhum erro, num segundo passo, o estorno será realmente efetivado conforme as parametrizações recebidas, chegando então à sua conclusão, para assim seguir na leitura do próximo título de cobrança especial a ser processado.

Ao final do processo, conforme parametrização, poderá ser gerado um arquivo com a carta do estorno efetuado para cada portador relacionado.

O processo de estorno não efetua grandes alterações no título de cobrança especial, somente atualiza o valor já estornado do mesmo. Tal processo consiste na geração de uma antecipação em favor do portador - deduzindo do valor do estorno o percentual de comissão retida gerada como remuneração do mesmo - e na geração de um título normal contra o cliente - no valor do estorno, e para o portador/carteira da regra de destinação de cobrança vinculada ao motivo de rejeição parametrizado.

Obs 1: Somente podem ser estornados os títulos de cobrança especial que foram liquidados, parcialmente estornados ou que retornaram de cobrança do portador sem rejeição.

Obs 2: Na tt_integr_acr_estorn_cobr parametrizada, quando não é informado o motivo de rejeição, a API tentará utilizar o motivo de rejeição parametrizado na tabela de Parâmetros Gerais SCO, anexando à descrição do motivo o código/parcela da nota de crédito informado.

Tabelas Temporárias

Nos atributos das tabelas temporárias de entrada e saída:

(*) A partir da 5.07A o estabelecimento passa a ter cinco dígitos.

def temp-table tt_integr_acr_estorn_cobr_1 no-undo

    field tta_cod_estab                    as character format "x(3)" label "Estabelecimento" column-label "Estab"

    field tta_num_id_tit_acr               as integer format "9999999999" initial 0 label "Token Cta Receber" column-label "Token Cta Receber"

    field tta_num_seq_tit_acr              as integer format ">>>9" initial 0 label "Sequência" column-label "Sequência"

    field tta_dat_transacao                as date format "99/99/9999" initial today label "Data Transação" column-label "Dat Transac"

    field ttv_val_tit_acr_estorn           as decimal format ">>>,>>>,>>9.99" decimals 2 initial 0 label "Valor Estorno" column-label "Valor Estorno"

    field tta_cdn_motiv_rej_tit_acr        as Integer format ">>>9" initial 0 label "Motivo Rejeição" column-label "Motivo Rejeição"

    field ttv_cod_tit_acr_ncredito         as character format "x(15)" label "Título Nota Crédito" column-label "Título Nota Crédito"

    field tta_cod_espec_docto_antecip      as character format "x(03)" label "Espécie Antecipação" column-label "Espécie Antecipação"

    field tta_cod_plano_cta_ctbl           as character format "x(8)" label "Plano Contas" column-label "Plano Contas"

    field tta_cod_cta_ctbl                 as character format "x(20)" label "Conta Contábil" column-label "Conta Contábil"

    field tta_des_text_histor              as character format "x(2000)" label "Histórico" column-label "Histórico"

    field ttv_num_id_tit_acr_antecip       as integer format "9999999999" label "ID Título Antecip" column-label "ID Título Antecip"

    field ttv_num_id_tit_acr_normal        as integer format "9999999999" label "ID Título Normal" column-label "ID Título Normal"

    field ttv_wgh_lista                    as widget-handle extent 10 format ">>>>>>9"

    field ttv_log_error                    as logical format "Sim/Não" initial no

    field tta_cod_portador                 as character format "x(5)" label "Portador" column-label "Portador"

    field tta_cod_cart_bcia                as character format "x(3)" label "Carteira" column-label "Carteira"

    field ttv_dat_prev_cr                  as date format "99/99/9999" label "Previsão Crédito" column-label "Previsão Crédito"

    field ttv_log_gera_tit_cobr_normal     as logical format "Sim/Não" initial yes label "Gera Tit Cobr Normal"

    field ttv_val_tit_acr_antecip          as decimal format ">>>,>>>,>>9.99" decimals 2 label "Valor Antecip" column-label "Valor Antecip"

    index tt_id                            is primary unique

          tta_cod_estab                    ascending

          tta_num_id_tit_acr               ascending

          tta_num_seq_tit_acr              ascending.

(*) A partir da 5.07A o estabelecimento passa a ter cinco dígitos.

def temp-table tt_log_erros_estorn_cobr no-undo

    field tta_cod_estab                    as character format "x(5)" label "Estabelecimento" column-label "Estab"

    field tta_num_id_tit_acr               as integer format "9999999999" initial 0 label "Token Cta Receber" column-label "Token Cta Receber"

    field tta_num_seq_tit_acr              as integer format ">>>9" initial 0 label "Sequência" column-label "Sequência"

    field ttv_num_mensagem                 as integer format ">>>>,>>9" label "Número" column-label "Número Mensagem"

    field ttv_des_msg_erro                 as character format "x(60)" label "Mensagem Erro" column-label "Inconsistência"

    field ttv_des_msg_ajuda                as character format "x(40)" label "Mensagem Ajuda" column-label "Mensagem Ajuda"

    field ttv_wgh_focus                    as widget-handle format ">>>>>>9"

    index tt_relac_tit_acr               

          tta_cod_estab                    ascending

          tta_num_id_tit_acr               ascending

          tta_num_seq_tit_acr              ascending

          ttv_num_mensagem                 ascending.

(*) A partir da 5.07A o estabelecimento passa a ter cinco dígitos.

(**) Liberado o número de documento com 16 posições e série com 5, a partir de maio/2011.

def temp-table tt_antecip_vincul_sco no-undo

    field tta_cod_estab                    as character format "x(5)" label "Estabelecimento" column-label "Estab"

    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(3)" label "S‚rie Documento" column-label "S‚rie"

    field tta_cod_tit_acr                  as character format "x(10)" label "T¡tulo" column-label "T¡tulo"

    field tta_cod_parcela                  as character format "x(02)" label "Parcela" column-label "Parc"

    field tta_num_seq                      as integer format ">>>,>>9" initial 0 label "Sequˆncia" column-label "NumSeq"

    field ttv_log_antecip_vincul           as logical format "Sim/NÆo" initial no

    field tta_cod_refer                    as character format "x(10)" label "Referˆncia" column-label "Referˆncia"

    field tta_num_seq_refer                as integer format ">>>9" initial 0 label "Sequˆncia" column-label "Seq"

    field tta_val_abat_tit_acr             as decimal format ">>>>,>>>,>>9.99" decimals 2 initial 0 label "Vl Abatimento" column-label "Vl Abatimento".