Interface ICctBSPlanosPagamentos

Esta classe deve ser usada para obter serviços sobre os planos de pagamentos.

Namespace: ICctBS100

Assembly: ICctBS100.dll

Syntax

[ComVisible(true)]
[Guid("83698433-D7F1-4AFC-83CD-9F895185EC30")]
public interface ICctBSPlanosPagamentos

Methods

Actualiza(CctBEPlanoPagamentos)

Actualiza a informação do plano de pagamentos.

Declaration

void Actualiza(CctBEPlanoPagamentos BEPlanoPagamentos)

Parameters

Type	Name	Description
CctBEPlanoPagamentos	BEPlanoPagamentos	Objecto que identifica o plano.

Actualiza(CctBEPlanoPagamentos, Boolean, ref String)

Actualiza a informação do plano de pagamentos.

Declaration

void Actualiza(CctBEPlanoPagamentos BEPlanoPagamentos, bool Processar, ref string Avisos)

Parameters

Type	Name	Description
CctBEPlanoPagamentos	BEPlanoPagamentos	Objecto que identifica o plano.
System.Boolean	Processar	Processa a informação do plano de pagamentos..
System.String	Avisos	Mensagens de aviso na gravação.

Actualiza(CctBEPlanoPagamentos, ref String)

Actualiza a informação do plano de pagamentos.

Declaration

void Actualiza(CctBEPlanoPagamentos BEPlanoPagamentos, ref string Avisos)

Parameters

Type	Name	Description
CctBEPlanoPagamentos	BEPlanoPagamentos	Objecto que identifica o plano.
System.String	Avisos	Mensagens de aviso na gravação.

ActualizaValorAtributo(Int32, String, Object)

Actualiza o valor de um determinado atributo

Declaration

void ActualizaValorAtributo(int NumPlano, string Atributo, dynamic Valor)

Parameters

Type	Name	Description
System.Int32	NumPlano	Número do plano.
System.String	Atributo	Atributo do plano a actualizar.
System.Object	Valor	Valor a gravar no atributo.

ActualizaValorAtributoID(String, String, Object)

Actualiza o valor de um determinado atributo

Declaration

void ActualizaValorAtributoID(string IdPlano, string Atributo, dynamic Valor)

Parameters

Type	Name	Description
System.String	IdPlano	Identificador do plano.
System.String	Atributo	Atributo do plano a actualizar.
System.Object	Valor	Valor a gravar no atributo.

ActualizaValorAtributoIDDoc(String, String, Int32, Int32, String, Object)

Declaration

void ActualizaValorAtributoIDDoc(string IdPlano, string IDDocumento, int NumPrestacao, int NumTransferencia, string Atributo, dynamic Valor)

Parameters

Type	Name	Description
System.String	IdPlano
System.String	IDDocumento
System.Int32	NumPrestacao
System.Int32	NumTransferencia
System.String	Atributo
System.Object	Valor

ActualizaValorAtributoIDLinha(String, Int32, String, Object)

Actualiza um atributo da tabela LinhasPlanosPagamentos.

Declaration

void ActualizaValorAtributoIDLinha(string IdPlano, int NumPagamento, string Atributo, dynamic Valor)

Parameters

Type	Name	Description
System.String	IdPlano	Identificador do plano de pagamento.
System.Int32	NumPagamento	Número de pagamento.
System.String	Atributo	Atributo a actualizar.
System.Object	Valor	Valor a aplicar ao atributo.

ActualizaValorAtributoIDPendente(String, Int32, String, Int32, Int32, String, Object)

Actualiza um atributo da tabela PendentesPlanosPagamentos.

Declaration

void ActualizaValorAtributoIDPendente(string IdPlano, int NumPagamento, string IDDocumento, int NumPrestacao, int NumTransferencia, string Atributo, dynamic Valor)

Parameters

Type	Name	Description
System.String	IdPlano	Identificador do plano de pagamento.
System.Int32	NumPagamento	Número de pagamento.
System.String	IDDocumento	Identificador do documento a actualizar.
System.Int32	NumPrestacao	Número da prestação da linha.
System.Int32	NumTransferencia	Número da transferência da linha.
System.String	Atributo	Atributo a actualizar.
System.Object	Valor	Valor a aplicar ao atributo.

ActualizaValorAtributos(Int32, StdBECampos)

Actualiza o valor de um determinado conjunto de atributos.

Declaration

void ActualizaValorAtributos(int NumPlano, StdBECampos Atributos)

Parameters

Type	Name	Description
System.Int32	NumPlano	Número do plano.
StdBECampos	Atributos	Atributos do plano a actualizar e respectivos valores.

ActualizaValorAtributosID(String, StdBECampos)

Actualiza o valor de um determinado conjunto de atributos.

Declaration

void ActualizaValorAtributosID(string IdPlano, StdBECampos Atributos)

Parameters

Type	Name	Description
System.String	IdPlano	Identificador do plano.
StdBECampos	Atributos	Atributos do plano a actualizar e respectivos valores.

ActualizaValorAtributosIDLinha(String, Int32, StdBECampos)

Actualiza um conjunto de atributos da tabela LinhasPlanosPagamentos.

Declaration

void ActualizaValorAtributosIDLinha(string IdPlano, int NumPagamento, StdBECampos Atributos)

Parameters

Type	Name	Description
System.String	IdPlano	Identificador do plano de pagamento.
System.Int32	NumPagamento	Número de pagamento.
StdBECampos	Atributos	Atributos a actualizar.

ActualizaValorPendenteDocPlano(String, String, Int32, Int32, Double)

Actualiza o valor pendente de um documento no plano de pagamento

Declaration

void ActualizaValorPendenteDocPlano(string IdDocumento, string IdPlanoPagamento, int NumTransferencia, int NumPrestacao, double ValorPendente)

Parameters

Type	Name	Description
System.String	IdDocumento	The identifier documento.
System.String	IdPlanoPagamento	The identifier plano pagamento.
System.Int32	NumTransferencia	The number transferencia.
System.Int32	NumPrestacao	The number prestacao.
System.Double	ValorPendente	The valor pendente.

AdicionaDocPlanoPagamentos(ref CctBEPlanoPagamentos, String, String)

Adiciona documento ao plano

Declaration

void AdicionaDocPlanoPagamentos(ref CctBEPlanoPagamentos BEPlanoPagamentos, string IdHistorico, string Estado)

Parameters

Type	Name	Description
CctBEPlanoPagamentos	BEPlanoPagamentos	Objecto que identifica o plano.
System.String	IdHistorico	Identificador do pendente.
System.String	Estado	Identificadores do estado do pendente.

AdicionaDocPlanoPagamentos(ref CctBEPlanoPagamentos, String, String, String, String, Int32, Int32, Int32, String, String)

Adiciona documento ao plano

Declaration

void AdicionaDocPlanoPagamentos(ref CctBEPlanoPagamentos BEPlanoPagamentos, string Modulo, string Filial, string TipoDoc, string Serie, int NumDocInt, int NumPrestacao, int NumTransferencia, string TipoConta, string Estado)

Parameters

Type	Name	Description
CctBEPlanoPagamentos	BEPlanoPagamentos	Objecto que identifica o plano.
System.String	Modulo	Identifica o modulo do documento.
System.String	Filial	Identifica a filial do documento.
System.String	TipoDoc	Identifica o código do tipo de documento.
System.String	Serie	Identifica a série do documento
System.Int32	NumDocInt	Identifica o numero do documento.
System.Int32	NumPrestacao	Identificadores do número de prestação do pendente.
System.Int32	NumTransferencia	Identificadores do número de transferência do pendente.
System.String	TipoConta	Identificadores do tipo de conta do pendente.
System.String	Estado	Identificadores do estado do pendente.

CalculaPagamentosDocumento(CctBEPlanoPagamentos, DateTime, CctBETipos.EnumTipoAfectacaoPlanoPagamentos, CctBETipos.EnumRecorrenciaPlanoPagamentos, Int32)

Calcula os pagamentos para aplicar a um plano

Declaration

CctBEPlanoPagamentos CalculaPagamentosDocumento(CctBEPlanoPagamentos PlanoPagamentos, DateTime DataPrimeiraPrestacao, CctBETipos.EnumTipoAfectacaoPlanoPagamentos TipoAfectacao, CctBETipos.EnumRecorrenciaPlanoPagamentos Recorrencia, int NumeroOcorrencias)

Parameters

Type	Name	Description
CctBEPlanoPagamentos	PlanoPagamentos
System.DateTime	DataPrimeiraPrestacao	Data de vencimento da primeira prestacao
CctBETipos.EnumTipoAfectacaoPlanoPagamentos	TipoAfectacao	Tipo de data a afectar
CctBETipos.EnumRecorrenciaPlanoPagamentos	Recorrencia	Tipo de recorrencia da prestacao
System.Int32	NumeroOcorrencias	Número de ocorrências

Returns

Type	Description
CctBEPlanoPagamentos

DaDefCamposUtil()

Devolve as definições dos campos do utilizador.

Declaration

StdBEDefCamposUtil DaDefCamposUtil()

Returns

Type	Description
StdBEDefCamposUtil

DaDefCamposUtilLinhas()

Devolve as definições dos campos do utilizador das linhas.

Declaration

StdBEDefCamposUtil DaDefCamposUtilLinhas()

Returns

Type	Description
StdBEDefCamposUtil

DaDefCamposUtilPendentes()

Devolve as definições dos campos do utilizador das linhas pendentes.

Declaration

StdBEDefCamposUtil DaDefCamposUtilPendentes()

Returns

Type	Description
StdBEDefCamposUtil

DaNumPlanoPagamentosProcessadoDoc(String, String, String, String, Int32)

Devolve se existir um plano de pagamento processado.

Declaration

int DaNumPlanoPagamentosProcessadoDoc(string Filial, string Modulo, string TipoDoc, string Serie, int NumDoc)

Parameters

Type	Name	Description
System.String	Filial
System.String	Modulo
System.String	TipoDoc
System.String	Serie
System.Int32	NumDoc

Returns

Type	Description
System.Int32

DaPlanoPagamentosDoc(String, String, String, String, Int32, Int32)

Devolve se existe um plano de pagamentos criada para o documento.

Declaration

int DaPlanoPagamentosDoc(string Filial, string Modulo, string TipoDoc, string Serie, int NumDoc, int NumPrestacao)

Parameters

Type	Name	Description
System.String	Filial	Filial do documento.
System.String	Modulo	Módulo do documento.
System.String	TipoDoc	Código do documento
System.String	Serie	Série do documento.
System.Int32	NumDoc	Número do documento.
System.Int32	NumPrestacao

Returns

Type	Description
System.Int32	-1 se não encontrar

DaPlanoPagamentosDoc(String, String, String, String, Int32, Int32, Boolean)

Devolve se existe um plano de pagamentos criada para o documento.

Declaration

int DaPlanoPagamentosDoc(string Filial, string Modulo, string TipoDoc, string Serie, int NumDoc, int NumPrestacao, bool CarregarPlanoCancelado)

Parameters

Type	Name	Description
System.String	Filial	Filial do documento.
System.String	Modulo	Módulo do documento.
System.String	TipoDoc	Código do documento
System.String	Serie	Série do documento.
System.Int32	NumDoc	Número do documento.
System.Int32	NumPrestacao
System.Boolean	CarregarPlanoCancelado

Returns

Type	Description
System.Int32	-1 se não encontrar

DaProximoNumPlano()

Devolve o próximo numerador para os planos.

Declaration

int DaProximoNumPlano()

Returns

Type	Description
System.Int32

DaValorAtributo(Int32, String)

Devolve o valor de um determinado atributo.

Declaration

dynamic DaValorAtributo(int NumPlano, string Atributo)

Parameters

Type	Name	Description
System.Int32	NumPlano	Número do plano.
System.String	Atributo	Atributo para o qual se pretende devolver o valor.

Returns

Type	Description
System.Object

DaValorAtributoID(String, String)

Devolve o valor de um determinado atributo.

Declaration

dynamic DaValorAtributoID(string IdPlano, string Atributo)

Parameters

Type	Name	Description
System.String	IdPlano	Identificador do plano.
System.String	Atributo	Atributo para o qual se pretende devolver o valor.

Returns

Type	Description
System.Object

DaValorAtributoIDLock(String, String)

Devolve o valor de um determinado atributo.

Declaration

dynamic DaValorAtributoIDLock(string IdPlano, string Atributo)

Parameters

Type	Name	Description
System.String	IdPlano	Identificador do plano.
System.String	Atributo	Atributo para o qual se pretende devolver o valor.

Returns

Type	Description
System.Object

DaValorAtributoLock(Int32, String)

Devolve o valor de um determinado atributo.

Declaration

dynamic DaValorAtributoLock(int NumPlano, string Atributo)

Parameters

Type	Name	Description
System.Int32	NumPlano	Número do plano.
System.String	Atributo	Atributo para o qual se pretende devolver o valor.

Returns

Type	Description
System.Object

DaValorAtributos(Int32, String[])

Devolve o valor de um determinado conjunto de atributos.

Declaration

StdBECampos DaValorAtributos(int NumPlano, params string[] Atributos)

Parameters

Type	Name	Description
System.Int32	NumPlano	Número do plano.
System.String[]	Atributos	Atributos para os quais se pretende devolver o valor.

Returns

Type	Description
StdBECampos

DaValorAtributosID(String, String[])

Devolve o valor de um determinado conjunto de atributos.

Declaration

StdBECampos DaValorAtributosID(string IdPlano, params string[] Atributos)

Parameters

Type	Name	Description
System.String	IdPlano	Identificador do plano.
System.String[]	Atributos	Atributos para os quais se pretende devolver o valor.

Returns

Type	Description
StdBECampos

DaValorAtributosIDLock(String, String[])

Devolve o valor de um determinado conjunto de atributos.

Declaration

StdBECampos DaValorAtributosIDLock(string IdPlano, params string[] Atributos)

Parameters

Type	Name	Description
System.String	IdPlano	Identificador do plano.
System.String[]	Atributos	Atributos para os quais se pretende devolver o valor.

Returns

Type	Description
StdBECampos

DaValorAtributosLock(Int32, String[])

Devolve o valor de um determinado conjunto de atributos.

Declaration

StdBECampos DaValorAtributosLock(int NumPlano, params string[] Atributos)

Parameters

Type	Name	Description
System.Int32	NumPlano	Número do plano.
System.String[]	Atributos	Atributos para os quais se pretende devolver o valor.

Returns

Type	Description
StdBECampos

DaValorPendenteDocPlano(String, String)

Devolve o valor pendente de um documento associado a um plano de pagamento

Declaration

double DaValorPendenteDocPlano(string IdDocumento, string IdPlanoPagamento)

Parameters

Type	Name	Description
System.String	IdDocumento	The identifier documento.
System.String	IdPlanoPagamento	The identifier plano pagamento.

Returns

Type	Description
System.Double

DaValorPendenteDocPlano(String, String, Int32)

Devolve o valor pendente de um documento associado a um plano de pagamento

Declaration

double DaValorPendenteDocPlano(string IdDocumento, string IdPlanoPagamento, int NumTransferencia)

Parameters

Type	Name	Description
System.String	IdDocumento	The identifier documento.
System.String	IdPlanoPagamento	The identifier plano pagamento.
System.Int32	NumTransferencia	The number transferencia.

Returns

Type	Description
System.Double

DaValorPendenteDocPlano(String, String, Int32, Int32)

Devolve o valor pendente de um documento associado a um plano de pagamento

Declaration

double DaValorPendenteDocPlano(string IdDocumento, string IdPlanoPagamento, int NumTransferencia, int NumPrestacao)

Parameters

Type	Name	Description
System.String	IdDocumento	The identifier documento.
System.String	IdPlanoPagamento	The identifier plano pagamento.
System.Int32	NumTransferencia	The number transferencia.
System.Int32	NumPrestacao	The number prestacao.

Returns

Type	Description
System.Double

Edita(Int32)

Edita a informação do plano de pagamentos.

Declaration

CctBEPlanoPagamentos Edita(int NumPlano)

Parameters

Type	Name	Description
System.Int32	NumPlano	Número do plano.

Returns

Type	Description
CctBEPlanoPagamentos

EditaID(String)

Edita a informação do plano de pagamentos.

Declaration

CctBEPlanoPagamentos EditaID(string IdPlano)

Parameters

Type	Name	Description
System.String	IdPlano	Identificador do plano.

Returns

Type	Description
CctBEPlanoPagamentos

Existe(Int32)

Verifica se o plano de pagamentos existe na base de dados.

Declaration

bool Existe(int NumPlano)

Parameters

Type	Name	Description
System.Int32	NumPlano	Número do plano.

Returns

Type	Description
System.Boolean

ExisteID(String)

Verifica se o plano de pagamentos existe na base de dados.

Declaration

bool ExisteID(string IdPlano)

Parameters

Type	Name	Description
System.String	IdPlano	Identificador do plano.

Returns

Type	Description
System.Boolean

ExistemLiquidacoesPlano(Int32)

Verifica se existem liquidacoes no plano.

Declaration

bool ExistemLiquidacoesPlano(int NumPlano)

Parameters

Type	Name	Description
System.Int32	NumPlano	The number plano.

Returns

Type	Description
System.Boolean

ExistePlanoPagamentosDoc(String, String, String, String, Int32)

Indica se existe, pelo menos, um plano de pagamentos criada para o documento.

Declaration

bool ExistePlanoPagamentosDoc(string Filial, string Modulo, string TipoDoc, string Serie, int NumDoc)

Parameters

Type	Name	Description
System.String	Filial	Filial do documento.
System.String	Modulo	Módulo do documento.
System.String	TipoDoc	Código do documento
System.String	Serie	Série do documento.
System.Int32	NumDoc	Número do documento.

Returns

Type	Description
System.Boolean

ExistePlanoPagamentosDocId(String)

Indica se existe, pelo menos, um plano de pagamentos criada para o documento.

Declaration

bool ExistePlanoPagamentosDocId(string IDDocumento)

Parameters

Type	Name	Description
System.String	IDDocumento

Returns

Type	Description
System.Boolean

PreecheDocsPlanoPagamentos(CctBEPlanoPagamentos, String[])

Preenche um objecto de planos de pagamentos com os documentos a entrarem no plano, através de uma listagem de pendentes.

Declaration

CctBEPlanoPagamentos PreecheDocsPlanoPagamentos(CctBEPlanoPagamentos BEPlanoPagamentos, string[] arrIdHistorico)

Parameters

Type	Name	Description
CctBEPlanoPagamentos	BEPlanoPagamentos	Objecto que identifica o plano.
System.String[]	arrIdHistorico	Array com os identificadores dos pendentes.

Returns

Type	Description
CctBEPlanoPagamentos

PreecheDocsPlanoPagamentosEX(CctBEPlanoPagamentos, String[], String[])

Preenche um objecto de planos de pagamentos com os documentos a entrarem no plano, através de uma listagem de pendentes.

Declaration

CctBEPlanoPagamentos PreecheDocsPlanoPagamentosEX(CctBEPlanoPagamentos BEPlanoPagamentos, string[] arrIdHistorico, string[] arrEstado)

Parameters

Type	Name	Description
CctBEPlanoPagamentos	BEPlanoPagamentos	Objecto que identifica o plano.
System.String[]	arrIdHistorico	Array com os identificadores dos pendentes.
System.String[]	arrEstado	Array com os identificadores dos estados dos pendentes.

Returns

Type	Description
CctBEPlanoPagamentos

Processar(CctBEPlanoPagamentos, ref String)

Processa a informação do plano de pagamentos.

Declaration

void Processar(CctBEPlanoPagamentos BEPlanoPagamentos, ref string Avisos)

Parameters

Type	Name	Description
CctBEPlanoPagamentos	BEPlanoPagamentos	Objecto que identifica o plano.
System.String	Avisos	Mensagens de aviso na gravação.

Remove(Int32)

Remove o plano de pagamentos.

Declaration

void Remove(int NumPlano)

Parameters

Type	Name	Description
System.Int32	NumPlano	Número do plano.

RemoveChequesDocTesouraria(String)

Remove a associação dos cheques pré-datados de um documento de tesouraria

Declaration

void RemoveChequesDocTesouraria(string IdCabecTesouraria)

Parameters

Type	Name	Description
System.String	IdCabecTesouraria	Identificador do documento de tesouraria.

RemoveDocPlanoPagamento(ref CctBEPlanoPagamentos, String)

Remove documento ao plano

Declaration

bool RemoveDocPlanoPagamento(ref CctBEPlanoPagamentos BEPlanoPagamentos, string IdHistorico)

Parameters

Type	Name	Description
CctBEPlanoPagamentos	BEPlanoPagamentos	Objecto que identifica o plano.
System.String	IdHistorico	Identificador do pendente.

Returns

Type	Description
System.Boolean

RemoveID(String)

Remove o plano de pagamentos.

Declaration

void RemoveID(string IdPlano)

Parameters

Type	Name	Description
System.String	IdPlano	Identificador do plano.

RemoveID(String, Boolean)

Remove o plano de pagamentos.

Declaration

void RemoveID(string IdPlano, bool ExisteLiquidacao)

Parameters

Type	Name	Description
System.String	IdPlano	Identificador do plano.
System.Boolean	ExisteLiquidacao	Indica se existem liquidações/transferências associadas ao plano.

ValidaActualizacao(CctBEPlanoPagamentos, ref String)

Valida a actualização do plano de pagamentos.

Declaration

bool ValidaActualizacao(CctBEPlanoPagamentos BEPlanoPagamentos, ref string Erros)

Parameters

Type	Name	Description
CctBEPlanoPagamentos	BEPlanoPagamentos	Objecto que identifica o plano.
System.String	Erros	Erros encontrados na validação.

Returns

Type	Description
System.Boolean

ValidaRemocao(Int32, ref String)

Efectua as validações necessárias à remoção do plano de pagamentos.

Declaration

bool ValidaRemocao(int NumPlano, ref string Erros)

Parameters

Type	Name	Description
System.Int32	NumPlano	Número do plano.
System.String	Erros

Returns

Type	Description
System.Boolean

ValidaRemocaoID(String, ref String)

Efectua as validações necessárias à remoção do plano de pagamentos.

Declaration

bool ValidaRemocaoID(string IdPlano, ref string Erros)

Parameters

Type	Name	Description
System.String	IdPlano	Identificador do plano.
System.String	Erros

Returns

Type	Description
System.Boolean