Interface ICctBSOutrasRetencoes
Esta classe deve ser usada para obter serviços sobre Outras Retenções.
Namespace: ICctBS100
Assembly: ICctBS100.dll
Syntax
[ComVisible(true)]
[Guid("8CAB4FAF-F704-4EA2-8196-B1C71B3C37BD")]
public interface ICctBSOutrasRetencoes
Methods
Actualiza(BasBEOutraRetencao, String)
Actualiza a informação do cliente.
Declaration
void Actualiza(BasBEOutraRetencao ObjEntidadeRetencao, string strAvisos = "")
Parameters
Type | Name | Description |
---|---|---|
BasBEOutraRetencao | ObjEntidadeRetencao | Objecto que identifica o cliente a actualizar. |
System.String | strAvisos | Descrição dos avisos que possam surgir durante a actualização de um cliente. |
ActualizaTotalDebito(Double, String, Double, Int32)
Actualiza o total em débito na ficha da entidade pública.
Declaration
void ActualizaTotalDebito(double ValorTotal, string Entidade, double Cambio, int MoedaDaUEM)
Parameters
Type | Name | Description |
---|---|---|
System.Double | ValorTotal | Valor Total do documento. |
System.String | Entidade | Código do terceiro. |
System.Double | Cambio | Câmbio associado à moeda. |
System.Int32 | MoedaDaUEM | Indica se a moeda pertence à União Europeia. |
ActualizaValorAtributo(String, String, String, String, String, Object)
Actualiza o valor de um atributo da Entidade/Retenção.
Declaration
void ActualizaValorAtributo(string TipoEntidade, string Entidade, string TipoEntidadeRetencao, string EntidadeRetencao, string Atributo, dynamic Valor)
Parameters
Type | Name | Description |
---|---|---|
System.String | TipoEntidade | Identifica o tipo de entidade. |
System.String | Entidade | Código da Entidade. |
System.String | TipoEntidadeRetencao | Identifica o tipo de entidade de retenção. |
System.String | EntidadeRetencao | Identifica a entidade de retenção. |
System.String | Atributo | Identifica o atributo a actualizar. |
System.Object | Valor | Identifica o valor a gravar no atributo seleccionado. |
ActualizaValorAtributos(String, String, String, String, StdBECampos)
Actualiza o valor de um conjunto de atributos da Entidade/Retenção.
Declaration
void ActualizaValorAtributos(string TipoEntidade, string Entidade, string TipoEntidadeRetencao, string EntidadeRetencao, StdBECampos Atributos)
Parameters
Type | Name | Description |
---|---|---|
System.String | TipoEntidade | Identifica o tipo de entidade. |
System.String | Entidade | Código da Entidade. |
System.String | TipoEntidadeRetencao | Identifica o tipo de entidade de retenção. |
System.String | EntidadeRetencao | Identifica a entidade de retenção. |
StdBECampos | Atributos | Identifica os atributos e os respectivos valores a actualizar. |
DaCamposUtil()
Devolve os campos do utilizador.
Declaration
StdBECampos DaCamposUtil()
Returns
Type | Description |
---|---|
StdBECampos |
DaDefCamposUtil()
Devolve as definições dos campos do utilizador.
Declaration
StdBEDefCamposUtil DaDefCamposUtil()
Returns
Type | Description |
---|---|
StdBEDefCamposUtil |
DaValorAtributo(String, String, String, String, String)
Devolve o valor de um atributo da Entidade/Retenção
Declaration
dynamic DaValorAtributo(string TipoEntidade, string Entidade, string TipoEntidadeRetencao, string EntidadeRetencao, string Atributo)
Parameters
Type | Name | Description |
---|---|---|
System.String | TipoEntidade | Identifica o tipo de entidade. |
System.String | Entidade | Código da Entidade. |
System.String | TipoEntidadeRetencao | Identifica o tipo de entidade de retenção. |
System.String | EntidadeRetencao | Identifica a entidade de retenção. |
System.String | Atributo | Identifica o atributo para o qual se pretende devolver o valor. |
Returns
Type | Description |
---|---|
System.Object |
DaValorAtributoLock(String, String, String, String, String)
Devolve o valor de um atributo da Entidade/Retenção
Declaration
dynamic DaValorAtributoLock(string TipoEntidade, string Entidade, string TipoEntidadeRetencao, string EntidadeRetencao, string Atributo)
Parameters
Type | Name | Description |
---|---|---|
System.String | TipoEntidade | Identifica o tipo de entidade. |
System.String | Entidade | Código da Entidade. |
System.String | TipoEntidadeRetencao | Identifica o tipo de entidade de retenção. |
System.String | EntidadeRetencao | Identifica a entidade de retençã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, String[])
Devolve o valor de um conjunto de atributos da Entidade/Retenção.
Declaration
StdBECampos DaValorAtributos(string TipoEntidade, string Entidade, string TipoEntidadeRetencao, string EntidadeRetencao, params string[] Atributos)
Parameters
Type | Name | Description |
---|---|---|
System.String | TipoEntidade | Identifica o tipo de entidade. |
System.String | Entidade | Código da Entidade. |
System.String | TipoEntidadeRetencao | Identifica o tipo de entidade de retenção. |
System.String | EntidadeRetencao | Identifica a entidade de retenção. |
System.String[] | Atributos | Identifica os atributos para os quais se pretende devolver o valor. |
Returns
Type | Description |
---|---|
StdBECampos |
DaValorAtributosLock(String, String, String, String, String[])
Devolve o valor de um conjunto de atributos da Entidade/Retenção.
Declaration
StdBECampos DaValorAtributosLock(string TipoEntidade, string Entidade, string TipoEntidadeRetencao, string EntidadeRetencao, params string[] Atributos)
Parameters
Type | Name | Description |
---|---|---|
System.String | TipoEntidade | Identifica o tipo de entidade. |
System.String | Entidade | Código da Entidade. |
System.String | TipoEntidadeRetencao | Identifica o tipo de entidade de retenção. |
System.String | EntidadeRetencao | Identifica a entidade de retenção. |
System.String[] | Atributos | Identifica os atributos para os quais se pretende devolver o valor. |
Returns
Type | Description |
---|---|
StdBECampos |
Edita(String, String, String, String)
Edita a relação entidade/entidade associada.
Declaration
BasBEOutraRetencao Edita(string TipoEntidade, string Entidade, string TipoEntidadeRetencao, string EntidadeRetencao)
Parameters
Type | Name | Description |
---|---|---|
System.String | TipoEntidade | Código do tipo de entidade. |
System.String | Entidade | Código da entidade. |
System.String | TipoEntidadeRetencao | Código do tipo de entidade associada. |
System.String | EntidadeRetencao | Código da EntidadeRetencao. |
Returns
Type | Description |
---|---|
BasBEOutraRetencao |
Existe(String, String, String, String)
Verifica se a relação entidade/entidade associada existe na base de dados.
Declaration
bool Existe(string TipoEntidade, string Entidade, string TipoEntidadeRetencao, string EntidadeRetencao)
Parameters
Type | Name | Description |
---|---|---|
System.String | TipoEntidade | Código do tipo de entidade. |
System.String | Entidade | Código da entidade. |
System.String | TipoEntidadeRetencao | Código do tipo de entidade associada. |
System.String | EntidadeRetencao | Código da EntidadeRetencao. |
Returns
Type | Description |
---|---|
System.Boolean |
ListaOutrasRetencoesEntidade(String, String)
Devolve as outras retenções associadas à entidade.
Declaration
BasBEOutrasRetencoes ListaOutrasRetencoesEntidade(string TipoEntidade, string Entidade)
Parameters
Type | Name | Description |
---|---|---|
System.String | TipoEntidade | Identifica o tipo de entidade. |
System.String | Entidade | Identifica a entidade. |
Returns
Type | Description |
---|---|
BasBEOutrasRetencoes |
ListaRetencoesObra(String, String)
Devolve as outras retenções associadas à obra.
Declaration
BasBEOutrasRetencoes ListaRetencoesObra(string IdObra, string TipoAuto)
Parameters
Type | Name | Description |
---|---|---|
System.String | IdObra | Identifica a obra CCOP. |
System.String | TipoAuto | Identifica a tipo de auto em que seplica a retenção. |
Returns
Type | Description |
---|---|
BasBEOutrasRetencoes |
Recalcula(Boolean)
Recalcula retenções dos documentos pendentes
Declaration
bool Recalcula(bool TotalmentePendentes = true)
Parameters
Type | Name | Description |
---|---|---|
System.Boolean | TotalmentePendentes | True-Processa apenas documentos totalmente pendentes. False-Processa para todos os documentos pendentes. |
Returns
Type | Description |
---|---|
System.Boolean |
Remove(String, String, String, String)
Remove toda a informação relacionada com a entidade associada.
Declaration
void Remove(string TipoEntidade, string Entidade, string TipoEntidadeRetencao, string EntidadeRetencao)
Parameters
Type | Name | Description |
---|---|---|
System.String | TipoEntidade | Código do tipo de entidade. |
System.String | Entidade | Código da entidade. |
System.String | TipoEntidadeRetencao | Código do tipo de entidade associada. |
System.String | EntidadeRetencao | Código da EntidadeRetencao. |
RemoveEntidade(String, String)
Remove toda a informação relacionada com a entidade.
Declaration
void RemoveEntidade(string TipoEntidade, string Entidade)
Parameters
Type | Name | Description |
---|---|---|
System.String | TipoEntidade | Código do tipo de entidade. |
System.String | Entidade | Código da entidade. |
ValidaActualizacao(BasBEOutraRetencao, ref String)
Efectua as validações necessárias à actualização da entidade associada.
Declaration
bool ValidaActualizacao(BasBEOutraRetencao ObjEntidadeRetencao, ref string StrErro)
Parameters
Type | Name | Description |
---|---|---|
BasBEOutraRetencao | ObjEntidadeRetencao | Objecto que identifica a entidade associada. |
System.String | StrErro |
Returns
Type | Description |
---|---|
System.Boolean |
ValidaRemocao(String, String, String, String, String)
Efectua todas as validações necessárias para a remoção do cliente.
Declaration
bool ValidaRemocao(string TipoEntidade, string Entidade, string TipoEntidadeRetencao, string EntidadeRetencao, string StrErro)
Parameters
Type | Name | Description |
---|---|---|
System.String | TipoEntidade | Código do tipo de entidade. |
System.String | Entidade | Código da entidade. |
System.String | TipoEntidadeRetencao | Código do tipo de entidade associada. |
System.String | EntidadeRetencao | Código da EntidadeRetencao. |
System.String | StrErro | Descrição do erro. |
Returns
Type | Description |
---|---|
System.Boolean |