Interface ICctBSHistorico

Classe utilizada para obter serviços e regras de negócio sobre o Histórico.

Namespace: ICctBS100

Assembly: ICctBS100.dll

Syntax

[ComVisible(true)]
[Guid("F1A13DD1-E838-470F-959D-EC555FDC4E34")]
public interface ICctBSHistorico

Methods

Actualiza(CctBEHistorico, String)

Actualiza o documento no histórico.

Declaration

void Actualiza(CctBEHistorico ClsHistorico, string strAvisos = "")

Parameters

Type	Name	Description
CctBEHistorico	ClsHistorico
System.String	strAvisos	Devolve os avisos que foram encontrados durante a actualização.

ActualizaDataLiquidacao(String, String, String, String, Int32, Int32, Int32, DateTime)

Actualiza a data de liquidação.

Declaration

void ActualizaDataLiquidacao(string Filial, string Modulo, string Tipodoc, string strSerie, int NumDocInt, int NumPrestacao, int NumTransferencia, DateTime DataLiq)

Parameters

Type	Name	Description
System.String	Filial	Identificador da Filial.
System.String	Modulo	Identificador do Módulo.
System.String	Tipodoc
System.String	strSerie	Identificador da Série.
System.Int32	NumDocInt	Identificador do Número do Documento Interno.
System.Int32	NumPrestacao	Identificador do Númeri da Prestação.
System.Int32	NumTransferencia	Identificador do Número da Transferência.
System.DateTime	DataLiq	Identificador da Data da Liquidação.

ActualizaValorAtributo(String, String, String, String, Int32, Int32, Int32, String, Object)

Actualiza o valor de um atributo no historico.

Declaration

void ActualizaValorAtributo(string Tipodoc, string Modulo, string Serie, string Filial, int NumDocInt, int NumTransferencia, int NumPrestacao, string Atributo, dynamic Valor)

Parameters

Type	Name	Description
System.String	Tipodoc
System.String	Modulo	Identifica o modulo do documento.
System.String	Serie	Identifica a série do documento.
System.String	Filial	Identifica a filial do documento.
System.Int32	NumDocInt	Identifica o numero do documento.
System.Int32	NumTransferencia	Identifica o numero de transferencia.
System.Int32	NumPrestacao	Identifica o numero da prestação.
System.String	Atributo	Identifica o atributo a actualizar.
System.Object	Valor	Identifica o valor a gravar no atributo.

ActualizaValorAtributoID(String, String, Object)

Actualiza o valor de um atributo no historico.

Declaration

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

Parameters

Type	Name	Description
System.String	Id
System.String	Atributo	Identifica o atributo a actualizar.
System.Object	Valor	Identifica o valor a gravar no atributo.

ActualizaValorAtributos(String, String, String, String, Int32, Int32, Int32, StdBECampos)

Actualiza o valor de um conjunto de atributos no historico.

Declaration

void ActualizaValorAtributos(string Tipodoc, string Modulo, string Serie, string Filial, int NumDocInt, int NumTransferencia, int NumPrestacao, StdBECampos Atributos)

Parameters

Type	Name	Description
System.String	Tipodoc
System.String	Modulo	Identifica o modulo do documento.
System.String	Serie	Identifica a série do documento.
System.String	Filial	Identifica a filial do documento.
System.Int32	NumDocInt	Identifica o numero do documento.
System.Int32	NumTransferencia	Identifica o numero de transferencia.
System.Int32	NumPrestacao	Identifica o numero da prestação.
StdBECampos	Atributos	Identifica os atributos a actualizar e respectivos valores.

ActualizaValorAtributosID(String, StdBECampos)

Actualiza o valor de um conjunto atributos no historico.

Declaration

void ActualizaValorAtributosID(string Id, StdBECampos Atributos)

Parameters

Type	Name	Description
System.String	Id
StdBECampos	Atributos	Identifica os atributos a actualizar e respectivos valores.

DaDefCamposUtil()

Devolve a definição dos campos do utilizador.

Declaration

StdBEDefCamposUtil DaDefCamposUtil()

Returns

Type	Description
StdBEDefCamposUtil

DaTotalDoc(String, String, Int32, String, String)

Devolve o total de um documento na sua tabela de histórico

Declaration

double DaTotalDoc(string Modulo, string Tipodoc, int NumDocInt, string Serie, string Filial)

Parameters

Type	Name	Description
System.String	Modulo	Módulo do documento
System.String	Tipodoc	Tipo de documento
System.Int32	NumDocInt	Número do Documento
System.String	Serie	Série do documento
System.String	Filial	Filial do documento

Returns

Type	Description
System.Double

DaUltimoNumDocExterno(String, String, String, String, Int32)

Esta classe deve ser usada para obter serviços sobre histórico de documentos.

Declaration

string DaUltimoNumDocExterno(string Filial, string Modulo, string Tipodoc, string Serie, int NumDocInt)

Parameters

Type	Name	Description
System.String	Filial	Identifica a filial do documento.
System.String	Modulo	Identifica o módulo de origem do documento.
System.String	Tipodoc
System.String	Serie	Identifica a série do documento.
System.Int32	NumDocInt	Identifica o Numero do Documento Interno.

Returns

Type	Description
System.String

DaValorAtributo(String, String, String, String, Int32, Int32, Int32, String)

Devolve o valor de um atributo do historico.

Declaration

dynamic DaValorAtributo(string Tipodoc, string Modulo, string Serie, string Filial, int NumDocInt, int NumTransferencia, int NumPrestacao, string Atributo)

Parameters

Type	Name	Description
System.String	Tipodoc
System.String	Modulo	Identifica o modulo do documento.
System.String	Serie	Identifica a série do documento.
System.String	Filial	Identifica a filial do documento.
System.Int32	NumDocInt	Identifica o numero do documento.
System.Int32	NumTransferencia	Identifica o numero de transferencia.
System.Int32	NumPrestacao	Identifica o numero da prestação.
System.String	Atributo	Identifica o atributo para o qual se pretende devolver o valor.

Returns

Type	Description
System.Object

DaValorAtributoID(String, String)

Devolve o valor de um atributo do historico.

Declaration

dynamic DaValorAtributoID(string Id, string Atributo)

Parameters

Type	Name	Description
System.String	Id
System.String	Atributo	Identifica o atributo para o qual se pretende devolver o valor.

Returns

Type	Description
System.Object

DaValorAtributoIDDoc(String, Int32, String)

Devolve o valor de um atributo do historico.

Declaration

dynamic DaValorAtributoIDDoc(string IdDoc, int NumPrestacao, string Atributo)

Parameters

Type	Name	Description
System.String	IdDoc	Identificador do documento original.
System.Int32	NumPrestacao	Número da prestação.
System.String	Atributo	Identifica o atributo para o qual se pretende devolver o valor.

Returns

Type	Description
System.Object

DaValorAtributoIDDocLock(String, Int32, String)

Devolve o valor de um atributo do historico.

Declaration

dynamic DaValorAtributoIDDocLock(string IdDoc, int NumPrestacao, string Atributo)

Parameters

Type	Name	Description
System.String	IdDoc	Identificador do documento original.
System.Int32	NumPrestacao	Número da prestação.
System.String	Atributo	Identifica o atributo para o qual se pretende devolver o valor.

Returns

Type	Description
System.Object

DaValorAtributoIDLock(String, String)

Devolve o valor de um atributo do historico.

Declaration

dynamic DaValorAtributoIDLock(string Id, string Atributo)

Parameters

Type	Name	Description
System.String	Id
System.String	Atributo	Identifica o atributo para o qual se pretende devolver o valor.

Returns

Type	Description
System.Object

DaValorAtributoLock(String, String, String, String, Int32, Int32, Int32, String)

Devolve o valor de um atributo do historico.

Declaration

dynamic DaValorAtributoLock(string Tipodoc, string Modulo, string Serie, string Filial, int NumDocInt, int NumTransferencia, int NumPrestacao, string Atributo)

Parameters

Type	Name	Description
System.String	Tipodoc
System.String	Modulo	Identifica o modulo do documento.
System.String	Serie	Identifica a série do documento.
System.String	Filial	Identifica a filial do documento.
System.Int32	NumDocInt	Identifica o numero do documento.
System.Int32	NumTransferencia	Identifica o numero de transferencia.
System.Int32	NumPrestacao	Identifica o numero da prestação.
System.String	Atributo	Identifica o atributo para o qual se pretende devolver o valor.

Returns

Type	Description
System.Object

DaValorAtributos(String, String, String, String, Int32, Int32, Int32, String[])

Devolve o valor de um conjunto de atributos do historico.

Declaration

StdBECampos DaValorAtributos(string Tipodoc, string Modulo, string Serie, string Filial, int NumDocInt, int NumTransferencia, int NumPrestacao, params string[] Atributos)

Parameters

Type	Name	Description
System.String	Tipodoc
System.String	Modulo	Identifica o modulo do documento.
System.String	Serie	Identifica a série do documento.
System.String	Filial	Identifica a filial do documento.
System.Int32	NumDocInt	Identifica o numero do documento.
System.Int32	NumTransferencia	Identifica o numero de transferencia.
System.Int32	NumPrestacao	Identifica o numero da prestação.
System.String[]	Atributos	Identifica os atributos para os quais se pretende devolver o valor.

Returns

Type	Description
StdBECampos

DaValorAtributosID(String, String[])

Devolve o valor de um conjunto de atributos do historico.

Declaration

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

Parameters

Type	Name	Description
System.String	Id
System.String[]	Atributos	Identifica os atributos para os quais se pretende devolver o valor.

Returns

Type	Description
StdBECampos

DaValorAtributosIDDoc(String, Int32, String[])

Devolve o valor de um conjunto de atributos do historico.

Declaration

StdBECampos DaValorAtributosIDDoc(string IdDoc, int NumPrestacao, params string[] Atributos)

Parameters

Type	Name	Description
System.String	IdDoc	Identificador do documento original.
System.Int32	NumPrestacao	Número da prestação.
System.String[]	Atributos	Identifica os atributos para os quais se pretende devolver o valor.

Returns

Type	Description
StdBECampos

DaValorAtributosIDDocLock(String, Int32, String[])

Devolve o valor de um conjunto de atributos do historico.

Declaration

StdBECampos DaValorAtributosIDDocLock(string IdDoc, int NumPrestacao, params string[] Atributos)

Parameters

Type	Name	Description
System.String	IdDoc	Identificador do documento original.
System.Int32	NumPrestacao	Número da prestação.
System.String[]	Atributos	Identifica os atributos para os quais se pretende devolver o valor.

Returns

Type	Description
StdBECampos

DaValorAtributosIDLock(String, String[])

Devolve o valor de um conjunto de atributos do historico.

Declaration

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

Parameters

Type	Name	Description
System.String	Id
System.String[]	Atributos	Identifica os atributos para os quais se pretende devolver o valor.

Returns

Type	Description
StdBECampos

DaValorAtributosLock(String, String, String, String, Int32, Int32, Int32, String[])

Devolve o valor de um conjunto de atributos do historico.

Declaration

StdBECampos DaValorAtributosLock(string Tipodoc, string Modulo, string Serie, string Filial, int NumDocInt, int NumTransferencia, int NumPrestacao, params string[] Atributos)

Parameters

Type	Name	Description
System.String	Tipodoc
System.String	Modulo	Identifica o modulo do documento.
System.String	Serie	Identifica a série do documento.
System.String	Filial	Identifica a filial do documento.
System.Int32	NumDocInt	Identifica o numero do documento.
System.Int32	NumTransferencia	Identifica o numero de transferencia.
System.Int32	NumPrestacao	Identifica o numero da prestação.
System.String[]	Atributos	Identifica os atributos para os quais se pretende devolver o valor.

Returns

Type	Description
StdBECampos

DaValorIvaDedutivel(String)

Declaration

double DaValorIvaDedutivel(string IdCabec)

Parameters

Type	Name	Description
System.String	IdCabec

Returns

Type	Description
System.Double

Edita(String, String, String, String, Int32, Int32, Int32)

Edita um documento do histórico.

Declaration

CctBEHistorico Edita(string Filial, string Modulo, string Tipodoc, string strSerie, int NumDocInt, int NumPrestacao, int NumTransferencia)

Parameters

Type	Name	Description
System.String	Filial	Código da filial.
System.String	Modulo	Modulo do documento.
System.String	Tipodoc
System.String	strSerie	Série do documento.
System.Int32	NumDocInt	Número do documento.
System.Int32	NumPrestacao	Número da prestação.
System.Int32	NumTransferencia	Número da Transferencia.

Returns

Type	Description
CctBEHistorico

EditaID(String)

Edita um documento de histórico.

Declaration

CctBEHistorico EditaID(string Id)

Parameters

Type	Name	Description
System.String	Id

Returns

Type	Description
CctBEHistorico

Existe(String, String, String, String, Int32, Int32, Int32)

Verifica se o documento existe em histórico.

Declaration

bool Existe(string Filial, string Modulo, string Tipodoc, string strSerie, int NumDocInt, int NumPrestacao, int NumTransferencia)

Parameters

Type	Name	Description
System.String	Filial	Código da filial.
System.String	Modulo	Modulo do documento.
System.String	Tipodoc
System.String	strSerie	Série do documento.
System.Int32	NumDocInt	Número do documento.
System.Int32	NumPrestacao	Número da prestação.
System.Int32	NumTransferencia	Número da transferencia.

Returns

Type	Description
System.Boolean

ExisteDocExterno(String, String, String, String, String, String, String, Int32, Int32)

Verifica se o documento pendente existe em Historico.

Declaration

bool ExisteDocExterno(string Filial, string Modulo, string Tipodoc, string strSerie, string NumDoc, string TipoEntidade, string Entidade, int NumPrestacao = 1, int NumTransferencia = 0)

Parameters

Type	Name	Description
System.String	Filial	Código da filial.
System.String	Modulo	Módulo do documento pendente.
System.String	Tipodoc
System.String	strSerie	Série do documento pendente.
System.String	NumDoc	Número do documento externo.
System.String	TipoEntidade	Tipo da entidade pendente.
System.String	Entidade	Código da entidade pendente.
System.Int32	NumPrestacao	Número da prestação.
System.Int32	NumTransferencia	Número da transferência.

Returns

Type	Description
System.Boolean

ExisteDocumento(String, String)

Verifica se o tipo do documento existe no histórico.

Declaration

bool ExisteDocumento(string Modulo, string Tipodoc)

Parameters

Type	Name	Description
System.String	Modulo	Módulo do documento.
System.String	Tipodoc

Returns

Type	Description
System.Boolean

ExisteID(String)

Verifica se o documento existe em histórico.

Declaration

bool ExisteID(string Id)

Parameters

Type	Name	Description
System.String	Id

Returns

Type	Description
System.Boolean

IncrementaValorTotal(String, String, String, String, Int32, Int32, Int32, Double)

Incrementa o valor total.

Declaration

void IncrementaValorTotal(string Filial, string Modulo, string Tipodoc, string strSerie, int NumDocInt, int NumPrestacao, int NumTransferencia, double Valor)

Parameters

Type	Name	Description
System.String	Filial	Identificador da Filial.
System.String	Modulo	Identificador do Módulo.
System.String	Tipodoc
System.String	strSerie	Identificador da Série.
System.Int32	NumDocInt	Identificador do Número do Documento Interno.
System.Int32	NumPrestacao	Identificador do Númeri da Prestação.
System.Int32	NumTransferencia	Identificador do Número da Transferência.
System.Double	Valor	Identificador do Valor.

LstExtracto(String, String, String, String, String, String, Int32, DateTime, DateTime, String, Int32, ref Double[])

Devolve uma lista com o Extracto de Conta.

Declaration

StdBELista LstExtracto(string TipoEntidade, string EntidadeInicial, string EntidadeFinal, string TipoConta, string Moeda, string Obra, int TipoData, DateTime DataIni, DateTime DataFim, string MoedaTrab, int TipoCambio, ref double[] Saldos)

Parameters

Type	Name	Description
System.String	TipoEntidade	Identifica o tipo de entidade.
System.String	EntidadeInicial	Identifica a entidade inicial de um intervalo de entidades.
System.String	EntidadeFinal	Identifica a entidade final de um intervalo de entidades.
System.String	TipoConta	Lista que identifica o(s) tipo(s) de conta a analisar, no Formato Conta, Estado, Modulo, Documento. Ex: "(TipoConta = 'CCC' AND (Estado IN ('PEN')) AND ( ((Modulo='V' AND TipoDoc IN ('DV', 'FA', 'NC', 'ND', 'VD'))) OR ((Modulo='C' AND TipoDoc IN ('VFA', 'VNC', 'VND', 'VVD'))) OR ((Modulo='M' AND TipoDoc IN ('ADC', 'CSG', 'FA', 'FAC', 'NCC', 'NDC', 'NDF', 'VEC'))))) OR (TipoConta = 'CLR' AND (Estado IN ('ACT', 'DES', 'EAC')) AND ( ((Modulo='M' AND TipoDoc IN ('LTC')))))". 'PriGlobal: IGNORE
System.String	Moeda	Identifica a moeda dos documentos.
System.String	Obra	Identifica o Id da obra a que estão associados os documentos.
System.Int32	TipoData	Identifica a data a considerar no extracto. 0-Data do extracto; 1-Data do documento
System.DateTime	DataIni	Identifica a data inicial a considerar no extracto
System.DateTime	DataFim	Identifica a data final a considerar no extracto
System.String	MoedaTrab	Identifica a moeda de trabalho (a moeda em que vão ser apresentados os valores).
System.Int32	TipoCambio	Identifica o Tipo de Câmbio a ser utilizado (Histórico/Actual).
System.Double[]	Saldos	Array que vai devolver os saldos dos Valores Pendentes pela seguinte ordem (Anterior, Período, Total)

Returns

Type	Description
StdBELista

Remove(String, String, String, String, Int32, Int32, Int32)

Remove um documento do histórico.

Declaration

void Remove(string Filial, string Modulo, string Tipodoc, string strSerie, int NumDocInt, int NumPrestacao, int NumTransferencia)

Parameters

Type	Name	Description
System.String	Filial	Código da filial.
System.String	Modulo	Modulo do documento.
System.String	Tipodoc
System.String	strSerie	Série do documento.
System.Int32	NumDocInt	Número do documento.
System.Int32	NumPrestacao	Número da prestação.
System.Int32	NumTransferencia	Número da Transferencia.

RemoveDocsGerados(String)

Remove os documentos gerados no histórico

Declaration

void RemoveDocsGerados(string IdDoc)

Parameters

Type	Name	Description
System.String	IdDoc	Identificador do documento de histórico.

RemoveID(String)

Remove um documento do histórico.

Declaration

void RemoveID(string Id)

Parameters

Type	Name	Description
System.String	Id

ValidaActualizacao(CctBEHistorico, String)

Efectua as validações necessárias à actualização do histórico.

Declaration

bool ValidaActualizacao(CctBEHistorico ClsHistorico, string StrErro)

Parameters

Type	Name	Description
CctBEHistorico	ClsHistorico
System.String	StrErro

Returns

Type	Description
System.Boolean

ValidaRemocao(String, String, String, String, Int32, Int32, Int32, ref String)

Efectua as validações necessárias à remoção do documento.

Declaration

bool ValidaRemocao(string Filial, string Modulo, string Tipodoc, string strSerie, int NumDocInt, int NumPrestacao, int NumTransferencia, ref string StrErro)

Parameters

Type	Name	Description
System.String	Filial	Código da filial.
System.String	Modulo	Modulo do documento.
System.String	Tipodoc
System.String	strSerie	Série do documento.
System.Int32	NumDocInt	Número do documento.
System.Int32	NumPrestacao	Número da prestação.
System.Int32	NumTransferencia	Número da Transferencia.
System.String	StrErro

Returns

Type	Description
System.Boolean