Documento de API

Ocorrência:

Documentação de API

Parâmetro

Descrição

num_vers_integr_api

Será utilizado para determinar se o programa que está chamando está íntegro com as definições correntes da API.

tt_operac_financ_emprestimo

Conterá os dados do empréstimo a ser criado.

tt_indic_econ_operac_fin_emp

Conterá as taxas do empréstimo.

[ tt_gartia_operac_financ_emp ]

Conterá as garantias do empréstimo.

[ tt_fiador_operac_financ_emp ]

Conterá os fiadores do empréstimo.

[ tt_docto_operac_financ_emp ]

Conterá os documentos necessários para o empréstimo.

[ tt_despes_operac_financ_emp ]

Conterá as despesas financeiras do empréstimo.

[ tt_parc_operac_financ_emp ]

Conterá as parcelas do empréstimo. Caso não queira informar as parcelas deve-se passar o parâmetro v_log_gera_parc como ‘yes’.

p_log_gera_parc

Parâmetro utilizado para saber se as parcelas devem ser geradas pelo sistema. Caso seja informado ‘No’, é necessário que as parcelas sejam informadas.

tt_log_erro

Os retornos de erros encontrados durante o processo de criação serão gravados nesta tabela.

num_id_operac_financ

Retorna o número de identificação do registro criado.

tt_rateio_operac_financ

Tabela que contém as informações referente ao Rateio da Operação, quando a função Contabilização por UM e Estabelecimento estiver habilitada.

Tabela Temporária

Descrição

Entrada/Saída

tt_operac_financ_emprestimo

Conterá as informações do empréstimo a ser criado no APL.

Entrada

Atributo

Tipo

Formato

Descrição

Obrig.

Evolução

cod_banco

character

x(8)

Inserir código do Banco para o qual deve ser efetuado a inclusão da Operação Financeira.

cod_produt_financ

character

x(8)

Neste campo deve ser inserido código do Produto Financeiro relacionado a Operação Financeira.

cod_operac_financ

character

x(10)

Inserir código para a Operação Financeira em questão.

Nota
O código do Banco, o código do Produto Financeiro e o código da Operação Financeira é a chave de identificação da operação em futuras consultas.

dat_operac_financ

date

99/99/9999

Data da operação financeira.

dat_vencto_operac_financ

date

99/99/9999

A data de vencimento da operação financeira deve ser inserida neste campo.

cod_cta_corren_padr

character

x(10)

Inserir Conta Corrente padrão para a Operação Financeira em questão.

cod_indic_econ_orig_apl

character

x(8)

É a moeda da operação financeira. Deve existir na tabela indic_econ e ser do tipo “Moeda”.

ind_ump_produt_financ

character

x(20)

Indica a unidade de medida do período da operação financeira. Pode assumir os seguintes valores: Dia, Semana, Quinzena, Mês, Bimestre, Trimestre, Quadrimestre, Semestre, Ano.

qtd_period_carenc_ump

decimal

>>9

É o período de carência, onde para empréstimos significa que o usuário não pagará amortizações neste período.

val_operac_financ

decimal

>>>,>>>,>>9.99

Inserir neste campo o valor da Operação Financeira em questão.

cod_atrib_utiliz_usuar_1

character

x(20)

Inserir os atributos de utilização do usuário. Estes atributos são passados para a planilha do produto quando forem efetuados cálculos para empréstimo. Assim o usuário pode parametrizar corretamente os produtos financeiros.

cod_atrib_utiliz_usuar_2

character

x(20)

Idem cod_atrib_utiliz_usuar_1.

cod_atrib_utiliz_usuar_3

character

x(20)

Idem cod_atrib_utiliz_usuar_1.

cod_atrib_utiliz_usuar_4

character

x(20)

Idem cod_atrib_utiliz_usuar_1.

cod_atrib_utiliz_usuar_5

character

x(20)

Idem cod_atrib_utiliz_usuar_1.

des_anot_tab

character

x(2000)

Anotações.

val_cotac_contrat

Decimal

>>>>>,>>9.9999999999

Inserir a cotação de moeda utilizada para o pagamento do empréstimo. Esta cotação deve ser informada quando a moeda da conta corrente do pagamento for diferente da moeda da contratação. Quando a conta corrente de resgate for igual a conta corrente de destino o valor da cotação deve permanecer igual a 1,00000000.

num_dia_aniver_apl

integer

>9

Inserir o dia de aniversário da Operação de Empréstimo. O dia de aniversário apenas é considerado para operações do tipo data/data. Este dia pode ser diferente do dia do empréstimo.

ind_forma_pagto_parc_apl

character

x(8)

É a forma de pagamento da primeira parcela do empréstimo. Podendo ser:

Postecipadas, quando selecionada esta opção determina que o pagamento da primeira parcela do empréstimo deve ser efetuado ao término do primeiro período após a contratação.

Antecipadas, assinalando esta opção determina que o pagamento da primeira parcela do empréstimo deve ser efetuado à vista.

qtd_freq_juros_carenc_ump

Integer

>9

É a freqüência de pagamento de juros durante o período de carência para pagamento do empréstimo em questão.

qtd_parc_emprest_apl

Integer

>>9

É a quantidade de parcelas de pagamento do empréstimo (amortizações).

qtd_parc_liber_emprest

Integer

>>9

É a quantidade de parcelas de liberação do empréstimo.

Se o empréstimo for liberado em apenas uma parcela esta poderá ser gerada automaticamente pelo sistema. Para empréstimos com mais de 1 parcela de liberação, as parcelas de liberação precisam ser informadas para que o sistema possa gerar automaticamente as parcelas de juros e pagamento.

val_resid_operac_financ

Decimal

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

Quando o Tipo de Produto Financeiro informado para a Operação Financeiraem questão for Leasing, deve ser inserido neste campo o valor residual do contrato de leasing.

log_operac_financ_andto

logical

Sim/Não

Identifica que é operação em andamento.

cod_modul_orig_operac

character

x (3)

Identifica qual Módulo originou a Operação.

Tabela Temporária

Descrição

Entrada/Saída

tt_indic_econ_operac_fin_apl

Conterá as informações do indicador econômico da Operação financeira.

Entrada

Atributo

Tipo

Formato

Descrição

Obrig.

Evol.

num_id_operac_financ

Int

 >>>>,>>9

Identificador da tabela da operação financeira. Este valor será ignorado e assumirá o número da operação criada em tempo de execução da api.

num_seq

Int

>>>,>>9

Campo utilizado para a formação da chave primária e única. O número de seqüência é de acordo com a implantação dos indicadores econômicos para uma operação, podendo para esta ser implementada vários indicadores desde que não seja com a mesma faixa de data de validade.

dat_inic_valid

Date

99/99/9999

Data início de validade do indicador.

dat_fim_valid

Date

99/99/9999

Data fim de validade do indicador.

ind_ump_tax_juros

Char

x(12)

É a UMP da taxa pré-fixada. Pode assumir os seguintes valores: Dia, Semana, Quinzena, Mês, Bimestre, Trimestre, Quadrimestre, Semestre, Ano. Se o mesmo não for informado, assumirá automaticamente a ump da operação financeira.

val_tax_juros_operac_financ

Decimal

>>>9.9999

É o percentual de juros pré-fixado. Estará informado na ump acima.

val_tax_delcred_apl

Decimal

>9.99/>9.99999

É a taxa del credere da operação financeira. Caso a mesma seja informada será ignorada pelo sistema.

val_perc_gartia_tax_aplic

Decimal

>>9.99

É o percentual de garantia sobre a taxa. Ex: 90% CDI.

val_perc_min_variac_tax_apl

Decimal

>>9.9999

Representa o Floor. É o mínimo de variação da taxa. Este percentual determina que se a taxa render menos que isto assume o valor deste percentual como variação da taxa.

val_perc_max_variac_tax_apl

Decimal

>>9.9999

Representa o Cap. É o máximo de variação da taxa. Este percentual determina que se a taxa render mais que isto assume o valor deste percentual como variação da taxa.

cod_indic_econ_operac

Character

x(8)

É o índice econômico para a taxa pós-fixada. Pode ser por percentual ou por cotas ou ainda uma moeda (o dólar por exemplo). Este campo deverá ser informado somente se o produto financeiro suportar taxas pós-fixadas ou ambas (pré-pós).

log_indic_econ_swap

Logical

Sim/Não

Este atributo não será considerado e será assumido sempre como não. Caso o usuário deseje swapar a taxa de juros deverá fazê-lo pelo programa de Movimentação Diária de Aplicações.

ind_capitaliz_indic_econ

Char

x(15)

Indicador do tipo de capitalização: Nominal ou Efetiva. Se o mesmo não for informado, assumirá automaticamente ‘Efetiva’.

cod_livre_1

Char

x(100)

Não usado.

val_livre_1

Decimal

>>>,>>>,>>9.9999

Não usado.

log_livre_1

Logi

Sim/Não

Não usado.

dat_livre_1

Date

99/99/9999

Não usado.

ind_ump_tax_declared_apl

Char

x(12)

cod_livre_2

Char

x(100)

Não usado.

dat_livre_2

Date

99/99/9999

Não usado.

log_livre_2

Logical

Sim/Não

Não usado.

num_livre_1

Int

>>>>>9

Não usado.

num_livre_2

Int

>>>>>9

Não usado.

val_livre_2

Decimal

>>>,>>>,>>9.9999

Não usado.

Tabela Temporária

Descrição

Entrada/Saída

tt_gartia_operac_financ_emp

Conterá as informações das garantias da operação financeira.

Entrada

Atributo

Tipo

Formato

Descrição

Obrig.

Evolução

tta_cod_gartia_apl

Char

x(8)

Código da garantia. Deve pertencer ao Cadastro de Garantias e podem ser: Títulos do Contas a Receber, Bens, Estoques ou Outros.

tta_num_id_operac_financ

Int

>>>>,>>9

Identificador da tabela da operação financeira. Este valor será ignorado e assumirá o número da operação criada em tempo de execução da api.

tta_val_gartia_operac_financ

Decimal

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

Valor da garantia da operação financeira.

tta_val_gartia_contrat_financ

Decimal

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

Valor da garantia no Contrato Financeiro.

tta_cod_livre_1

Char

x(100)

Não usado.

tta_val_livre_1

Decimal

>>>,>>>,>>9.9999

Não usado.

tta_dat_livre_1

Date

99/99/9999

Não usado.

tta_log_livre_1

Logical

Sim/Não

Não usado.

tta_des_gartia_operac_financ

Char

x(2000)

Tabela Temporária

Descrição

Entrada/Saída

tt_fiador_operac_financ_emp

Conterá as informações dos fiadores da operação financeira.

Entrada

Atributo

Tipo

Formato

Descrição

Obrig.

Evolução

tta_cod_fiador

Char

x(8)

Código do Fiador. Deve pertencer ao Cadastro de Fiadores.

tta_num_id_operac_financ

Int

>>>>,>>9

Identificador da tabela da operação financeira. Este valor será ignorado e assumirá o número da operação criada em tempo de execução da api.

tta_val_perc_gartia_fiador

Decimal

>>9.99

Valor em Percentual da garantia fornecida pelo fiador.

tta_cod_livre_1

Char

x(100)

Não usado.

tta_dat_livre_1

Date

99/99/9999

Não usado.

tta_val_livre_1

Decimal

>>>,>>>,>>9.9999

Não usado.

tta_log_livre_1

Logical

Sim/Não

Não usado.

tta_num_pessoa_fiador

Int

>>>,>>>,>>9

Tabela Temporária

Descrição

Entrada/Saída

tt_docto_operac_financ_emp

Conterá as informações dos documentos da operação financeira.

Entrada

Atributo

Tipo

Formato

Descrição

Obrig.

Evolução

num_id_operac_financ

Int

>>>>,>>9

Identificador da tabela da operação financeira. Este valor será ignorado e assumirá o número da operação criada em tempo de execução da api.

num_seq_documen_operac

Int

>>9

Campo utilizado para a formação da chave primária e única.

des_docto_operac

Char

x(2000)

Inserir a descrição relacionado ao documento necessário para a Operação Financeira em questão.

des_abrev_docto_operac

Char

x(40)

Descrição da abreviatura do documento.

dat_apres_documen_apl

Date

99/99/9999

Data da apresentação do documento.

dat_lim_apres_documen_apl

Date

99/99/9999

Data limite para a apresentação do documento.

log_control_apres_docto

Logical

Sim/Não

Lógico de controle da apresentação do documento. Se assinalado este campo e a data limite estiver ultrapassada e os documentos não foram entregues é apresentado automaticamente pelo sistema a relação destes documentos no Relatório de Abertura do Dia.

nom_arq_docto_operac_financ

Char

x(100)

Nome do arquivo do documento.

cod_livre_1

Char

x(100)

Não usado.

dat_livre_1

Date

99/99/9999

Não usado.

log_livre_1

Logical

Sim/Não

Não usado.

cod_livre_2

Char

x(100)

Não usado.

dat_livre_2

Date

99/99/9999

Não usado.

log_livre_2

Logical

Sim/Não

Não usado.

num_livre_1

Int

>>>>>9

Não usado.

num_livre_2

Int

>>>>>9

Não usado.

val_livre_1

Decimal

>>>,>>>,>>9.9999

Não usado.

val_livre_2

Decimal

>>>,>>>,>>9.9999

Não usado.

Tabela Temporária

Descrição

Entrada/Saída

tt_despes_operac_financ_apl

Conterá as informações das despesas da operação financeira.

Entrada

Atributo

Tipo

Formato

Descrição

Obrig.

Evol.

num_id_operac_financ

Int

>>>>,>>9

Identificador da tabela da operação financeira. Este valor será ignorado e assumirá o número da operação criada em tempo de execução da api.

num_seq

Int

>>>,>>9

Campo utilizado para a formação da chave primária e única.

log_control_perc_despes

Logical

Sim/Não

Esta opção determina que o valor das despesas é um valor calculado sobre o percentual a ser informado.

val_perc_despes_operac

Decimal

>>9.9999

Indica o percentual a ser aplicado sobre o valor da operação para a despesa bancária. Este atributo somente será considerado se o atributo Controle Percentual for “sim”.

val_despes_operac

Decimal

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

É o valor fixo da despesa. Somente será considerado se o atributo Controle Percentual for “não”.

ind_base_calc_despes

Char

x(09)

Determina sobre que valor da Operação Financeira incidirá o percentual para o cálculo o valor das despesas bancárias.

Podendo ser:

Original, esta opção determina que o cálculo das despesas bancárias deve ser efetuado sobre o valor original da operação em questão.

Saldo, esta opção determina que o cálculo das despesas bancárias deve ser efetuado sobre o valor saldo da operação em questão.

Movimento, esta opção determina que o cálculo das despesas bancárias deve ser efetuado sobre o valor do movimento da operação em questão.

ind_dat_despes_operac

Char

x(15)

Esta opção defini o momento que deve ocorrer as despesas bancárias. Podendo ser:

Implantação, esta opção determina que as despesas bancárias devem ocorrer na implantação da operação financeira;

Resgate, esta opção determina que as despesas bancárias devem ocorrer no resgate da operação financeira;

Pagamentos, esta opção determina que as despesas bancárias devem ocorrer no pagamento da operação financeira.

des_despes_operac

Char

x(40)

Inserir descrição para a despesa da Operação Financeira em questão.

des_anot_tab

Char

x(2000)

Neste campo pode ser inserido anotações relacionadas a despesa bancária, as informações inseridas ficam a critério do usuário.

ind_forma_aprop_despes

Char

x(14)

Abate Saldo, quando selecionado esta opção determina que o valor da despesa é diminuído do saldo do empréstimo.

Gera Movto C/C, quando selecionado esta opção determina que para o valor da despesa é gerado um movimento de saída na conta corrente informada.

Aumenta Saldo.

cod_livre_1

Char

x(100)

Não usado.

log_livre_1

Logical

Sim/Não

Não usado.

val_livre_1

Decimal

>>>,>>>,>>9.9999

Não usado.

dat_livre_1

Date

99/99/9999

Não usado.

cod_livre_2

Char

x (100)

dat_livre_2

Date

99/99/9999

log_livre_2

Logical

Sim/Não

num_livre_1

Int

>>>>>9

num_livre_2

Int

>>>>>9

val_livre_2

Decimal

>>>,>>>,>>9.9999

Tabela Temporária

Descrição

Entrada/Saída

tt_parc_operac_financ_emp

São as parcelas de liberação, de pagamento e de juros do empréstimo. Caso o parâmetro p_log_gera_parc esteja setado como sim e o empréstimo seja liberado em uma única parcela, o sistema criará automaticamente a parcela de liberação na data da operação financeira e gerará automaticamente as parcelas de pagamento. Caso existam mais parcelas de liberação, o sistema necessita que as mesmas sejam informadas para que possa então gerar automaticamente as parcelas de pagamento.

Caso o parâmetro esteja setado que não gera parcelas, as mesmas deverão ser informadas.

Entrada

Atributo

Tipo

Formato

Descrição

Obrig.

Evolução

tta_num_id_operac_financ

Int

>>>>,>>9

Identificador da tabela da operação financeira. Este valor será ignorado e assumirá o número da operação criada em tempo de execução da api.

tta_num_parcela

Int

>>9

Indica o número da parcela. É utilizado para a formação da chave primária e única.

tta_ind_tip_parc_emprest

Char

X(09)

É o Tipo de parcela que deve ser inserido.

Podendo ser:

Parcela de Liberação, esta opção determina que a parcela em questão representa entrada de dinheiro.

Parcela de Pagamento, esta opção determina que a parcela em questão representa pagamento de amortização.

Parcela de Juros, assinalando esta opção determina que a parcela em questão representa pagamento de juros.

tta_ind_sit_parc_pagto

Char

X(08)

Indicador da situação da parcela: Quitada ou Pendente.

tta_dat_vencto_parc

Date

99/99/9999

Inserir neste campo a data de vencimento da parcela em questão.

tta_dat_pagto

Date

99/99/9999

Data de Pagamento.

tta_val_parc_ftfin

Decimal

->>>,>>>,>>9.999999

Valor da parcela no fator financeiro. Este campo é calculado pelo sistema.

tta_val_ftfin

Decimal

->>>,>>9.999999999

Valor do fator financeiro.

tta_val_parc_pagto

Decimal

->>,>>>,>>>,>>9.999

Valor da Parcela.

[tta_val_multa_atraso_parc ]

Decimal

->>>,>>>,>>9.999999

Valor da Multa. Este campo deverá ser informado caso seja uma parcela de pagamento.

[tta_val_juros_pago_atraso ]

Decimal

->>>,>>>,>>9.999999

Valor do Juros. Este campo deverá ser informado caso seja uma parcela de pagamento.

[tta_val_desconto ]

Decimal

->>>,>>>,>>9.999999

Valor do desconto. Este campo deverá ser informado caso seja uma parcela de pagamento.

tta_cod_cta_corren_pagto

Char

x(10)

Conta corrente em que acontecerá o movimento de pagamento.

tta_log_val_parc_fixad

Logical

Sim/Não

Quando assinalado, determina que o valor da parcela não será calculado pelo sistema e sim assumirá o valor que o usuário informar.

tta_cod_empresa

Char

x(3)

Código da empresa.

tta_cod_livre_1

Char

x(100)

Não usado.

tta_log_livre_1

Logical

Sim/Não

Não usado.

tta_dat_livre_1

Date

99/99/9999

Não usado.

tta_val_livre_1

Decimal

->>,>>>,>>>,>>9.999

Não usado.

tta_val_princ_parc_pagto

Decimal

->>,>>>,>>>,>>9.999

tta_val_princ_parc_ftfin

Decimal

->>,>>>,>>>,>>9.999

Tabela Temporária

Descrição

Entrada/Saída

tt_log_erros_atualiz

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

Saída

Atributo

Tipo

Formato

Descrição

Obrig.

Evolução

Ttv_num_cod_erro

integer

>>>>,>>9

Número da Mensagem

Ttv_des_msg_ajuda

character

x(40)

Descrição da Mensagem de Ajuda

Ttv_des_msg_erro

character

x(60)

Descrição da Mensagem de Erro.

Tabela Temporária

Descrição

Entrada/Saída

tt_rateio_operac_financ

Conterá as informações de Rateio da Operação Financeira na integração.

Entrada

Atributo

Tipo

Formato

Descrição

Obrig.

Evolução

tta_num_id_operac_financ

Decimal

>>>>,>>9

Num id da Operação Financeira

tta_cod_unid_negoc

Character

x(3)

Código Unidade de Negócio

tta_cod_estab

Character

x(3) / x(5)*

Código do Estabelecimento

tta_val_perc_rat_ctbz

Decimal

>>9.99

Valor em percentual do Rateio

tta_cod_rat_padr_apl

Character

x(5)

Código Rateio Padrão

tta_cod_livre_1

Character

x(100)

Campo livre

tta_cod_livre_2

Character

x(100)

Campo livre

tta_log_livre_1

Logical

Sim/Não

Campo livre

tta_log_livre_2

Logical

Sim/Não

Campo livre

tta_num_livre_1

Integer

>>>>>9

Campo livre

tta_num_livre_2

Integer

>>>>>9

Campo livre

tta_val_livre_1

Decimal

>>>,>>>,>>9.9999

Campo livre

tta_val_livre_2

Decimal

>>>,>>>,>>9.9999

Campo livre

tta_dat_livre_1

Date

99/99/9999

Campo livre

tta_dat_livre_2

Date

99/99/9999

Campo livre