Documento de API

Produto:	Datasul
Ocorrência:	Documentação de API
Nome Físico	prgfin/apb/apb945zb

Considerações Gerais

Objetivo

Efetuar a consulta de títulos fechados do módulo Contas a Pagar.

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_input_parameters: será utilizado para determinar as informações referente a busca dos títulos fechados.

Parâmetros de Saída

tt_tit_ap_fechado: Retorna os títulos fechados do módulo Contas a Pagar que foram considerados na busca conforme os parâmetros.
tt_movto_tit_ap_fechado: retorna os movimentos dos títulos do contas a pagar que foram considerados na busca conforme os parâmetros.
tt_tot_tit_ap_fechado: retorna os valores totais de multa, juros, abatimento, desconto e valor pago referente aos títulos que foram selecionados.
tt_log_erros: retorna os erros que ocorrerão durante o processamento de busca dos titulos.

Funcionamento

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

run prgfin/apb/apb945zb.py persistent set v_hdl_aux.

No campo tt_input_parameters.ttv_des_conteudo, deve ser informado os valores para serem considerados na busca dos títulos
Os valores para o campo tt_input_parameters.ttv_cod_label obrigatoriamente precisam ser informados conforme abaixo, caso sejam escritos de forma diferente pode não trazer os títulos corretamente.
Utilizar a pesquisa “Interno” para buscar os títulos do Legado Totvs e “Externo” para os títulos de outros produtos.

ASSIGN tt_input_parameters.ttv_cod_label = "Id"

tt_input_parameters.ttv_des_conteudo = "Interno" ou “Externo”

tt_input_parameters.ttv_num_seq = 1.

CREATE tt_input_parameters.

ASSIGN tt_input_parameters.ttv_cod_label = "Estab Ini"

tt_input_parameters.ttv_des_conteudo =

tt_input_parameters.ttv_num_seq = 2.

CREATE tt_input_parameters.

ASSIGN tt_input_parameters.ttv_cod_label = "Estab Fim"

tt_input_parameters.ttv_des_conteudo =

tt_input_parameters.ttv_num_seq = 3.

CREATE tt_input_parameters.

ASSIGN tt_input_parameters.ttv_cod_label = "Fornec Ini"

tt_input_parameters.ttv_des_conteudo =

tt_input_parameters.ttv_num_seq = 4.

CREATE tt_input_parameters.

ASSIGN tt_input_parameters.ttv_cod_label = "Fornec Fim"

tt_input_parameters.ttv_des_conteudo =

tt_input_parameters.ttv_num_seq = 5.

CREATE tt_input_parameters.

ASSIGN tt_input_parameters.ttv_cod_label = "Série Ini"

tt_input_parameters.ttv_des_conteudo =

tt_input_parameters.ttv_num_seq = 6.

CREATE tt_input_parameters.

ASSIGN tt_input_parameters.ttv_cod_label = "Série Fim"

tt_input_parameters.ttv_des_conteudo =

tt_input_parameters.ttv_num_seq = 7.

CREATE tt_input_parameters.

ASSIGN tt_input_parameters.ttv_cod_label = "Espec Ini"

tt_input_parameters.ttv_des_conteudo =

tt_input_parameters.ttv_num_seq = 8.

CREATE tt_input_parameters.

ASSIGN tt_input_parameters.ttv_cod_label = "Espec Fim"

tt_input_parameters.ttv_des_conteudo =

tt_input_parameters.ttv_num_seq = 9.

CREATE tt_input_parameters.

ASSIGN tt_input_parameters.ttv_cod_label = "Título Ini"

tt_input_parameters.ttv_des_conteudo =

tt_input_parameters.ttv_num_seq = 10.

CREATE tt_input_parameters.

ASSIGN tt_input_parameters.ttv_cod_label = "Título Fim"

tt_input_parameters.ttv_des_conteudo =

tt_input_parameters.ttv_num_seq = 11.

CREATE tt_input_parameters.

ASSIGN tt_input_parameters.ttv_cod_label = "Parcela Ini"

tt_input_parameters.ttv_des_conteudo =

tt_input_parameters.ttv_num_seq = 12.

CREATE tt_input_parameters.

ASSIGN tt_input_parameters.ttv_cod_label = "Parcela Fim"

tt_input_parameters.ttv_des_conteudo =

tt_input_parameters.ttv_num_seq = 13.

CREATE tt_input_parameters.

ASSIGN tt_input_parameters.ttv_cod_label = "Dat Pagto Ini"

tt_input_parameters.ttv_des_conteudo =

tt_input_parameters.ttv_num_seq = 14.

CREATE tt_input_parameters.

ASSIGN tt_input_parameters.ttv_cod_label = "Dat Pagto Fim"

tt_input_parameters.ttv_des_conteudo =

tt_input_parameters.ttv_num_seq = 15.

CREATE tt_input_parameters.

ASSIGN tt_input_parameters.ttv_cod_label = "Dat Vencto Ini"

tt_input_parameters.ttv_des_conteudo =

tt_input_parameters.ttv_num_seq = 16.

CREATE tt_input_parameters.

ASSIGN tt_input_parameters.ttv_cod_label = "Dat Vencto Fim"

tt_input_parameters.ttv_des_conteudo =

tt_input_parameters.ttv_num_seq = 17.

CREATE tt_input_parameters.

ASSIGN tt_input_parameters.ttv_cod_label = "Empresa"

tt_input_parameters.ttv_des_conteudo =

tt_input_parameters.ttv_num_seq = 18.

CREATE tt_input_parameters.

ASSIGN tt_input_parameters.ttv_cod_label = "Matriz UO"

tt_input_parameters.ttv_des_conteudo =

tt_input_parameters.ttv_num_seq = 19.

if valid-handle(v_hdl_aux) then do:

run pi_main_api_generic_cons_tit_fechado_apb IN v_hdl_aux (Input 1,

Input table tt_input_parameters,

Output table tt_tit_ap_fechado,

Output table tt_movto_tit_ap_fechado,

Output table tt_tot_tit_ap_fechado,

Output table tt_log_erros).

Delete procedure v_hdl_aux.

end.

A variável denominada v_hdl_aux irá receber o “handle” do programa, permitindo o acesso aos “métodos” internos da API.

Tabelas Temporárias

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

tt_input_parameters					Entrada/Saída
Conterá as informações referente aos parâmetros de busca dos títulos.					Entrada
Atributo	Tipo	Formato	Descrição	Obrigatório	Evolução
ttv_cod_label	character	X(08)	Nome do Parâmetro que será utilizado	Sim
ttv_des_conteudo	character	X(40)	Valor do Parâmetro	Sim
ttv_num_seq	integer	>>>,>>9	Sequência dos parâmetros da tabela temporária	Sim

def temp-table tt_input_parameters no-undo

field ttv_cod_label as character format "x(8)" label "Label" column-label "Label"

field ttv_des_conteudo as character format "x(40)" label "Texto" column-label "Texto"

field ttv_num_seq as integer format ">>>,>>9" label "Sequência" column-label "Seq"

.

tt_tit_ap_fechado	Entrada/Saída
Conterá as informações dos títulos que serão retornados da busca.	Saída

Por ser uma tabela temporária copia da tabela do banco, as informações dos campos podem ser encontradas no dicionário de dados.

def temp-table tt_tit_ap_fechado no-undo like tit_ap_fechado

.

tt_movto_tit_ap_fechado	Entrada/Saída
Conterá as informações referentes aos movimentos dos títulos que retornaram da busca.	Saída

Por ser uma tabela temporária copia da tabela do banco, as informações dos campos podem ser encontradas no dicionário de dados.

def temp-table tt_movto_tit_ap_fechado no-undo like movto_tit_ap_fechado

.

tt_tot_tit_ap_fechado					Entrada/Saída
Conterá os totais de multa, juros, desconto e valor pago referente aos títulos que foram retornados da busca.					Saída
Atributo	Tipo	Formato	Descrição	Obrigatório	Evolução
ttv_val_tot_liquidac	Decimal	->>,>>>,>>>,>>9.99	Valor Total Liquidação
ttv_val_tot_desc	Decimal	"->>,>>>,>>>,>>9.99	Valor Total Desconto
ttv_val_tot_juros	Decimal	"->>,>>>,>>>,>>9.99	Valor Total Juros
ttv_val_tot_multa	Decimal	"->>,>>>,>>>,>>9.99	Valor Total Multa
ttv_val_abat	Decimal	"->>,>>>,>>>,>>9.99	Valor Total Abatimento

def temp-table tt_tot_tit_ap_fechado no-undo

field ttv_val_tot_liquidac as decimal format "->>,>>>,>>>,>>9.99" decimals 2 label "Total Liquidação"

field ttv_val_tot_desc as decimal format "->>,>>>,>>>,>>9.99" decimals 2 label "Total Desconto"

field ttv_val_tot_juros as decimal format "->>,>>>,>>>,>>9.99" decimals 2 label "Total Juros/Capit" column-label "Total Juros/Capit"

field ttv_val_tot_multa as decimal format ">>>,>>>,>>9.99" decimals 2 label "Valor da Multa" column-label "Valor da Multa"

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

.

tt_log_erros					Entrada/Saída
Conterá os erros que ocorreram durante o processamento da api.					Saída
Atributo	Tipo	Formato	Descrição	Obrigatório	Evolução
ttv_num_seq	integer	>>>,>>9	Sequência
ttv_num_cod_erro	integer	">>>,>>9	Número
ttv_des_erro	character	X(50)	Inconsistência
ttv_des_ajuda	character	X(50)	Ajuda

def temp-table tt_log_erros no-undo

field ttv_num_seq as integer format ">>>,>>9" label "Sequência" column-label "Seq"

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

field ttv_des_erro as character format "x(50)" label "Inconsistência" column-label "Inconsistência"

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

index tt_id

ttv_num_seq ascending

ttv_num_cod_erro ascending

.