Exclusão Documento Financeiro

Introdução
Essa rotina realiza a exclusão de documentos financeiros, de acordo com os parâmetros informados.

Observações:
- pelo menos um dos parâmetros documento financeiro e competência financeira devem ser informados.
- caso sejam informados o intervalo e a lista de parâmetros, somente serão selecionados os registros da lista que pertencerem ao intervalo informado.

Pré-requisito
O documento financeiro não pode ter número definitivo, ou seja, não pode ter sido processada a rotina de geração do número do documento.
O documento financeiro não pode ter nenhuma movimentação de documento associada.

Atualizações realizadas
O documento financeiro será excluído. Caso existam impostos, pensões e itens financeiros de carta de cobrança associados ao documento financeiro, os mesmos também serão excluídos.
A atualização nos itens financeiros se dará de acordo com o parâmetro Excluir Itens, exceto se o item for referente a imposto, pensão ou carta de cobrança, nesse caso, o item será excluído independente do parâmetro Excluir Itens.

Observação:
Na exclusão do documento financeiro, se o gerador do documento for 999 - QuitacaoDocFinan, independente da parametrização da opção Excluir Valores Originais, o sistema irá excluir os valores originais.

Antes de excluir os valores originais o sistema verifica se o documento relacionado a quitação está quitado ou parcialmente quitado, se estiver, atualiza a situação do documento para aberto e o valor do saldo em aberto passa a ser o valor total do documento, e deleta a quitação. Se o documento não estiver quitado ou parcialmente quitado, será exibida uma mensagem de erro.Além disso, também verifica se o documento financeiro possui Composição de Item Evento associada a um Movimento de Conta Corrente Participação. Se for encontrada, o documento não será excluído e uma mensagem será exibida para cada Composição.

Parâmetros de entrada

Pasta

Campo

Descrição

Tipo/Grid

Obrigatório

[Principal]
Documento
Documento financeiro a ser excluído.

Documento Financeiro

[Principal]
Competência Geração

[Principal]
Competência Financeira Inicial

[Principal]
Competência Financeira Final

[Principal]
Seq
Sequência de geração do documento para seleção dos documentos financeiros a serem excluídos.

[Principal]
Classe Documento
Classe de documento para seleção dos documentos financeiros a serem excluídos.

Classe de Documento Financeiro

[Principal]
Data Vencimento

[Principal]
Tipo Neg. Venc.
Tipo negociação de vencimento para seleção dos documentos financeiros a serem excluídos.

Tipo de Negociação de Vencimento

[Principal]
Excluir Itens
Se marcado serão excluídos todos os itens financeiros relacionados ao documento financeiro.
Se não marcado somente irá limpar a informação do campo documento na tabela de item financeiro.

[Principal]
Excluir Valores Originais
Se marcado irá fazer a exclusão dos valores que deram origem ao documento financeiro. Esses valores são identificados da seguinte forma:
No documento financeiro, temos os itens financeiros associados, nos itens temos os geradores dos itens financeiros, na tabela de gerador temos o campo Tipo Gerador, pelo tipo do gerador temos como saber a tabela que deu origem ao item financeiro associado ao documento financeiro, se o tipo gerador for:
1 - ModuloCompetencia - o registro de módulo competência será excluído.
2 - CompVlItemEvento - a informação do campo Localizador do gerador item financeiro será apagada.
3 - FatMovCadBeneficiario - o registro de faturamento de movimentação cadastral de beneficiário será excluído.
10 - ModuloCompetenciaPag - o registro de módulo competência pagamento será excluído.

O registro a ser excluído é identificado através do campo Id Gerador do gerador item financeiro.

[Principal]
Excluir Documentos TI
Exclui os documentos automaticamente da TI caso estiver checado. Se o sistema estiver trabalhando com a integração ligada, esta opção ficará checada e desabilitada para que os documentos da integração sejam excluídos automaticamente.
Se a integração estiver desligada, será possível optar em verificar se existe documento a ser excluído na TI (checkbox ativado) para caso em que exista documentos na integração ou deixar o checkbox não checado em caso da não existência de documentos na integração com a TI, deixando o processo mais rápido e, neste caso se existir documento na integração este não será apagado e ficará sem referência com o documento financeiro.

Sim

[Principal]
Excluir Documento Provisão

[Principal]
Excluir Manutenção Resultado ISS Município

[Contrato]
Contrato Financeiro Inicial
Intervalo inicial de contrato financeiro para seleção dos documentos financeiros a serem excluídos.

Contrato Financeiro

[Contrato]
Contrato Financeiro Final
Intervalo final de contrato financeiro para seleção dos documentos financeiros a serem excluídos.

Contrato Financeiro

[Contrato]
Exceto

[Contrato]
Lista Contratos
Relação de contratos financeiros para seleção dos documentos financeiros a serem excluídos.

Lista Contratos

[Classe]
Classe Contrato Financeiro Inicial
Intervalo inicial de classe de contrato financeiro para seleção dos documentos financeiros a serem excluídos.

Classe Contrato Financeiro

[Classe]
Classe Contrato Financeiro Final
Intervalo final de classe de contrato financeiro para seleção dos documentos financeiros a serem excluídos.

Classe Contrato Financeiro

[Classe]
Exceto

[Classe]
Lista Classes Contratos
Relação de classes de contratos financeiros para seleção dos documentos financeiros a serem excluídos.

Lista Classes Contratos

[Modelo Contrato]
Modelo Contrato Inicial

Modelo de Contrato

[Modelo Contrato]
Modelo Contrato Final

Modelo de Contrato

[Modelo Contrato]
Exceto

[Modelo Contrato]
Modelo Contrato

Modelo Contrato

[Num. Doc. Fornec.]
Exceto

[Num. Doc. Fornec.]
Num. Doc. Fornec.

Num. Doc. Fornec.

Pasta	Campo	Descrição	Tipo/Grid	Obrigatório
[Principal]	Documento	Documento financeiro a ser excluído.	Documento Financeiro
[Principal]	Competência Geração
[Principal]	Competência Financeira Inicial
[Principal]	Competência Financeira Final
[Principal]	Seq	Sequência de geração do documento para seleção dos documentos financeiros a serem excluídos.
[Principal]	Classe Documento	Classe de documento para seleção dos documentos financeiros a serem excluídos.	Classe de Documento Financeiro
[Principal]	Data Vencimento
[Principal]	Tipo Neg. Venc.	Tipo negociação de vencimento para seleção dos documentos financeiros a serem excluídos.	Tipo de Negociação de Vencimento
[Principal]	Excluir Itens	Se marcado serão excluídos todos os itens financeiros relacionados ao documento financeiro. Se não marcado somente irá limpar a informação do campo documento na tabela de item financeiro.
[Principal]	Excluir Valores Originais	Se marcado irá fazer a exclusão dos valores que deram origem ao documento financeiro. Esses valores são identificados da seguinte forma: No documento financeiro, temos os itens financeiros associados, nos itens temos os geradores dos itens financeiros, na tabela de gerador temos o campo Tipo Gerador, pelo tipo do gerador temos como saber a tabela que deu origem ao item financeiro associado ao documento financeiro, se o tipo gerador for: 1 - ModuloCompetencia - o registro de módulo competência será excluído. 2 - CompVlItemEvento - a informação do campo Localizador do gerador item financeiro será apagada. 3 - FatMovCadBeneficiario - o registro de faturamento de movimentação cadastral de beneficiário será excluído. 10 - ModuloCompetenciaPag - o registro de módulo competência pagamento será excluído. O registro a ser excluído é identificado através do campo Id Gerador do gerador item financeiro.
[Principal]	Excluir Documentos TI	Exclui os documentos automaticamente da TI caso estiver checado. Se o sistema estiver trabalhando com a integração ligada, esta opção ficará checada e desabilitada para que os documentos da integração sejam excluídos automaticamente. Se a integração estiver desligada, será possível optar em verificar se existe documento a ser excluído na TI (checkbox ativado) para caso em que exista documentos na integração ou deixar o checkbox não checado em caso da não existência de documentos na integração com a TI, deixando o processo mais rápido e, neste caso se existir documento na integração este não será apagado e ficará sem referência com o documento financeiro.		Sim
[Principal]	Excluir Documento Provisão
[Principal]	Excluir Manutenção Resultado ISS Município
[Contrato]	Contrato Financeiro Inicial	Intervalo inicial de contrato financeiro para seleção dos documentos financeiros a serem excluídos.	Contrato Financeiro
[Contrato]	Contrato Financeiro Final	Intervalo final de contrato financeiro para seleção dos documentos financeiros a serem excluídos.	Contrato Financeiro
[Contrato]	Exceto
[Contrato]	Lista Contratos	Relação de contratos financeiros para seleção dos documentos financeiros a serem excluídos.	Lista Contratos
[Classe]	Classe Contrato Financeiro Inicial	Intervalo inicial de classe de contrato financeiro para seleção dos documentos financeiros a serem excluídos.	Classe Contrato Financeiro
[Classe]	Classe Contrato Financeiro Final	Intervalo final de classe de contrato financeiro para seleção dos documentos financeiros a serem excluídos.	Classe Contrato Financeiro
[Classe]	Exceto
[Classe]	Lista Classes Contratos	Relação de classes de contratos financeiros para seleção dos documentos financeiros a serem excluídos.	Lista Classes Contratos
[Modelo Contrato]	Modelo Contrato Inicial		Modelo de Contrato
[Modelo Contrato]	Modelo Contrato Final		Modelo de Contrato
[Modelo Contrato]	Exceto
[Modelo Contrato]	Modelo Contrato		Modelo Contrato
[Num. Doc. Fornec.]	Exceto
[Num. Doc. Fornec.]	Num. Doc. Fornec.		Num. Doc. Fornec.