Árvore de páginas

Documento de API

Produto:

Datasul

Ocorrência:

Documentação de API

Nome Físicoprgfin/acr/acr904zb

 

Objetivo

Gerar movimentos de comissões para o módulo Contas a Receber

 

Funcionamento

1. No programa que irá chamar está API, deve ser definida a temp-table(tt_movto_comis_repres_geracao2) como local e a temp-table(tt_movto_comis_erro) também como local.

2. Executar o programa API(utilizar o nome externo), da seguinte forma:

 

def var v_hdl_programa as Handle no-undo.

 

run prgfin/acr/acr904zb.py persistent set v_hdl_programa.

 

run pi_main_code_api_movto_comis_repres_geracao_c in v_hdl_programa

                                            (input  1,

                                             Input  table tt_movto_comis_repres_geracao2,

                                             output table tt_movto_comis_erro).

Delete procedure v_hdl_programa.

 

3. Após a execução do programa, deve ser testada a temp-table de erro (tt_movto_comis_erro), afim de verificar se houve ou não erros durante o processo de importação.

 

Parâmetro Entrada API Gera movimentos Comissões

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

 

Tabelas Temporárias

 

Tabela Temporária

Descrição

Entrada/Saída

tt_movto_comis_repres_geracao2

Conterá as informações dos movimentos a serem integradas com o ACR

Entrada

 

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

Atributo

Tipo

Formato

Descrição

Obrig.

Evol.

tta_cod_empresa

character

x(3)

Empresa

Sim

 

tta_cdn_repres

Integer

>>>,>>9

Representante

Sim

 

tta_cod_estab

character

x(3) / x(5)*

Estabelecimento

Sim

 

tta_cod_espec_docto

character

x(3)

Espécie Documento

Sim

 

tta_cod_ser_docto

character

x(3)

Série Documento

Sim

 

tta_cod_tit_acr

character

x(10)

Título

Sim

 

tta_cod_parcela

character

x(02)

Parcela

Sim

 

tta_cod_refer

character

x(10)

Referência

Sim

 

tta_cod_usuario

character

x(12)

Usuário

Sim

 

tta_dat_transacao

date

99/99/9999

Data Transação

Sim

 

tta_ind_trans_acr

character

X(29)

Transação

Sim

 

tta_ind_sit_movto_comis

character

X(18)

Situação

Sim

 

tta_ind_tip_movto

character

X(20)

Tipo Movimento

Sim

 

tta_ind_natur_lancto_ctbl

character

X(02)

Natureza

Sim

 

tta_val_base_calc_comis

decimal

>>>,>>>,>>9.99

Base Calc Comis

Sim

 

tta_val_movto_comis

decimal

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

Valor Movimento

Sim

 

tta_num_id_tit_acr

integer

9999999999

Token Cta Receber

Não

 

tta_des_histor_movto_comis

character

x(40)

Histórico

Não

 

tta_num_id_movto_tit_acr

integer

9999999999

Token Movto Tit ACR

Sim

 

tta_ind_trans_comis

character

X(30)

Transação Comissão

Sim

 

tta_cod_unid_negoc

character

x(3)

Unid Negócio

Não

 

ttv_log_consid_movto_pagto

logical

"Sim/Não"

Considera Pagto

Sim

 

tta_dat_emis_docto

date

99/99/9999

Data  Emissão

Sim

 

tta_cdn_motiv_movto_comis

Integer

>>>9

Código Motiv Movto

 

 

 

def temp-table tt_movto_comis_repres_geracao2 no-undo

    field tta_cod_empresa                  as character format "x(3)" label "Empresa" column-label "Empresa"

    field tta_cdn_repres                   as Integer format ">>>,>>9" initial 0 label "Representante" column-label "Representante"

    field tta_cod_estab                    as character format "x(3)" 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_cod_refer                    as character format "x(10)" label "Referência" column-label "Referência"

    field tta_cod_usuario                  as character format "x(12)" label "Usuário" column-label "Usuário"

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

    field tta_ind_trans_acr                as character format "X(29)" initial "Implantação" label "Transação" column-label "Transação"

    field tta_ind_sit_movto_comis          as character format "X(18)" initial "Liberado" label "Situação" column-label "Situação"

    field tta_ind_tip_movto                as character format "X(20)" label "Tipo Movimento" column-label "Tipo Movimento"

    field tta_ind_natur_lancto_ctbl        as character format "X(02)" initial "DB" label "Natureza" column-label "Natureza"

    field tta_val_base_calc_comis          as decimal format ">>>,>>>,>>9.99" decimals 2 initial 0 label "Base Calc Comis" column-label "Base Calc Comis"

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

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

    field tta_des_histor_movto_comis       as character format "x(40)" label "Histórico" column-label "Histórico"

    field tta_num_id_movto_tit_acr         as integer format "9999999999" initial 0 label "Token Movto Tit  ACR" column-label "Token Movto Tit  ACR"

    field tta_ind_trans_comis              as character format "X(35)" label "Transação Comissão" column-label "Transação Comissão"

    field tta_cod_unid_negoc               as character format "x(3)" label "Unid Negócio" column-label "Un Neg"

    field ttv_log_consid_movto_pagto       as logical format "Sim/Não" initial yes

    field tta_dat_emis_docto               as date format "99/99/9999" initial today label "Data  Emissão" column-label "Dt Emissão"

    field tta_cdn_motiv_movto_comis        as Integer format ">>>9" initial 0 label "Código Motiv Movto" column-label "Código Motiv"

    index tt_id_movto_comis              

          tta_cod_empresa                  ascending

          tta_cdn_repres                   ascending.

 

OBSERVAÇÕES:

  1. 1.  Caso a natureza do lançamento seja um débito a data Emissão do documento será igual a data de transação, caso contrario a data de emissão será gravada com o valor informado no campo tta_dat_emis_docto.

 

Tabela Temporária

Descrição

Entrada/Saída

tt_movto_comis_erro

Conterá as informações de erros na integração, é a temp-table (tt_movto_comis_erro) que retorna os possíveis problemas na integração dos registros.

Entrada

Atributo

Tipo

Formato

Descrição

Obrig.

Evol.

tta_cod_empresa

character

x(3)

Empresa

 

 

tta_cdn_repres

Integer

>>>,>>9

Representante

 

 

ttv_num_seq_movto_comis_erro

integer

>>>>,>>9

Num Sequência

 

 

ttv_des_mensagem

character

x(50)

Mensagem

 

 

ttv_des_ajuda

character

x(50)

Ajuda

 

 

 

def temp-table tt_movto_comis_erro no-undo

    field tta_cod_empresa                  as character format "x(3)" label "Empresa" column-label "Empresa"

    field tta_cdn_repres                   as Integer format ">>>,>>9" initial 0 label "Representante" column-label "Representante"

    field ttv_num_seq_movto_comis_erro     as integer format ">>>>,>>9" label "Num Sequência" column-label "Num Sequência"

    field ttv_des_mensagem                 as character format "x(50)" label "Mensagem" column-label "Mensagem"

    field ttv_des_ajuda                    as character format "x(50)" label "Ajuda" column-label "Ajuda"

    index tt_id_movto                    

          tta_cod_empresa                  ascending

          tta_cdn_repres                   ascending

          ttv_num_seq_movto_comis_erro     ascending.