Produto: | Datasul |
Ocorrência: | Documentação de API |
| Nome Físico | Prgfin/fgl/fgl201za |
Efetuar o Cancelamento de Lotes ou Lançamentos Contábeis (Descontabiliza / Elimina).
1 - No programa que irá chamar esta API, deve ser definida a variável global v_cod_empres_usuar.
def new global shared var v_cod_empres_usuar
as character
format "x(3)":U
label "Empresa"
column-label "Empresa"
no-undo.
Esta variável deve ser setada com a empresa do lote que será cancelado.
2 - 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/fgl/fgl201za.py (Input 1,
Input num_lote_ctbl,
Input num_lancto_ctbl, **
Input rs_tipo_cancelamento_contabil,
output table tt_log_erro).
** Para efetuar o Cancelamento de todo o Lote Contábil, deverá ser passado o conteúdo => 0 (zero) neste parâmetro. Pois caso tenha sido informado o número de um valor para este parâmetro, o programa entenderá que deve fazer o cancelamento apenas deste Lançamento.
Os parâmentros de Entrada são os seguintes:
num_vers_integr_api..............: será utilizado para determinar se o programa que está chamando está íntegro com as definições correntes da API;
p_num_lote_ctbl.....................: conterá a informação do número do lote contábil que será cancelado ( caso o módulo de origem do lote contábil seja diferente de FGL – Contabilidade Fiscal e tenha sido escolhido a opção de descontabilizar o lote, será retornado como erro a informação de que o lote somente poderá ser eliminado );
p_num_lancto_ctbl.................: conterá a informação do número do lançamento contábil que será cancelado (caso o módulo de origem do lançamento contábil seja diferente de FGL – Contabilidade Fiscal, será retornado como erro a informação de que deverá se cancelado todo o lote contábil )
p_cod_tit_cancel_ctbl.............: conterá a informação do tipo de cancelamento a ser executado pelo programa (Descontabilizar / Eliminar).
Os parâmentros de Saída são os seguintes:
tt_log_erro..............................: Retorna para o usuário numa tabela temporária, as informações de erros ocorridos durante o processamento do cancelamento dos lotes .
Nos atributos das tabelas temporárias de entrada e saída:
Tabela Temporária | Descrição | Entrada/Saída |
tt_log_erro | Conterá informações dos erros encontrados nas validações. | Saída |
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
ttv_num_cod_erro | integer | >>>>,>>9 | Número |
|
|
ttv_des_msg_ajuda | character | x(40) | Mensagem Ajuda |
|
|
ttv_des_msg_erro | character | x(60) | Mensagem Erro |
|
|
def temp-table tt_log_erro no-undo
field ttv_num_cod_erro as integer format ">>>>,>>9" label "Número" column-label "Número"
field ttv_des_msg_ajuda as character format "x(40)" label "Mensagem Ajuda" column-label "Mensagem Ajuda"
field ttv_des_msg_erro as character format "x(60)" label "Mensagem Erro" column-label "Inconsistência"
.
Quando a API for executado por um programa externo, logo após a chamada da API, deverá ser criado um tratamento para impressão dos erros (tt_log_erro). E para a correta visualização dos erros, todos os campos desta tabela devem ser impressos.
