Interface ICblBSRegularizacaoDif
Esta classe deve ser usada para obter serviços sobre Regularização de Diferimentos.
Namespace: ICblBS100
Assembly: ICblBS100.dll
Syntax
[ComVisible(true)]
[Guid("4AE983CC-92E6-4636-A6D1-83097A5CB0AB")]
public interface ICblBSRegularizacaoDif
Methods
Actualiza(CblBERegularizacaoDif)
Actualiza a Regularização do Diferimento na base de dados. Criação automática de um Modelo de Lançamento, quando este não é explícito na configuração do Modelo de Diferimento.
Declaration
void Actualiza(CblBERegularizacaoDif objBE)
Parameters
Type | Name | Description |
---|---|---|
CblBERegularizacaoDif | objBE | Objecto que identifica a Regularização do Diferimento a actualizar |
Actualiza(CblBERegularizacaoDif, ref String)
Actualiza a Regularização do Diferimento na base de dados. Criação automática de um Modelo de Lançamento, quando este não é explícito na configuração do Modelo de Diferimento.
Declaration
void Actualiza(CblBERegularizacaoDif objBE, ref string strAvisos)
Parameters
Type | Name | Description |
---|---|---|
CblBERegularizacaoDif | objBE | Objecto que identifica a Regularização do Diferimento a actualizar |
System.String | strAvisos | Descrição dos avisos que possam surgir durante a actualização |
DaDefCamposUtil()
Devolve as definições dos campos do utilizador.
Declaration
StdBEDefCamposUtil DaDefCamposUtil()
Returns
Type | Description |
---|---|
StdBEDefCamposUtil |
DaValorAcumulado(String, String, Int32, Int32)
Devolve o valor acumulado na moeda base do movimento de um diferimento.
Declaration
double DaValorAcumulado(string IdDiferimento, string IdMovimento, int Exercicio = 0, int Periodo = 0)
Parameters
Type | Name | Description |
---|---|---|
System.String | IdDiferimento | Identificador (ID) do diferimento. |
System.String | IdMovimento | Identificador (ID) do movimento. |
System.Int32 | Exercicio | Exercício (opcional) - calcula o valor acumulado até ao exercício indicado. |
System.Int32 | Periodo | Período (opcional) - calcula valor acumulado até ao período indicado. |
Returns
Type | Description |
---|---|
System.Double |
DaValorAtributo(Int32, Int32, String, String, String)
Devolve o valor de um atributo de uma regularização.
Declaration
dynamic DaValorAtributo(int Exercicio, int Periodo, string IdDiferimento, string IdMovimento, string Atributo)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | Exercicio | Exercício do Diferimento. |
System.Int32 | Periodo | Período do Diferimento. |
System.String | IdDiferimento | Identificador (ID) do diferimento. |
System.String | IdMovimento | Identificador (ID) do movimento. |
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 de uma regularização.
Declaration
dynamic DaValorAtributoID(string IdRegularizacao, string Atributo)
Parameters
Type | Name | Description |
---|---|---|
System.String | IdRegularizacao | Identificador (ID) único da regularização. |
System.String | Atributo | Identifica o atributo para o qual se pretende devolver o valor. |
Returns
Type | Description |
---|---|
System.Object |
DaValorAtributos(Int32, Int32, String, String, Object[])
Devolve o valor de um conjunto de atributos de uma regularização.
Declaration
StdBECampos DaValorAtributos(int Exercicio, int Periodo, string IdDiferimento, string IdMovimento, params dynamic[] Atributos)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | Exercicio | Exercício do Diferimento. |
System.Int32 | Periodo | Período do Diferimento. |
System.String | IdDiferimento | Identificador (ID) do diferimento. |
System.String | IdMovimento | Identificador (ID) do movimento. |
System.Object[] | Atributos | Identifica os atributos para os quais se pretende devolver o valor. |
Returns
Type | Description |
---|---|
StdBECampos |
DaValorAtributosID(String, Object[])
Devolve o valor de um conjunto de atributos de uma regularização.
Declaration
StdBECampos DaValorAtributosID(string IdRegularizacao, params dynamic[] Atributos)
Parameters
Type | Name | Description |
---|---|---|
System.String | IdRegularizacao | Identificador (ID) único da regularização. |
System.Object[] | Atributos |
Returns
Type | Description |
---|---|
StdBECampos |
DaValorAtributosUltimaRegularizacao(String, String, Object[])
Devolve o valor de um conjunto de atributos da última regularização de um movimento.
Declaration
StdBECampos DaValorAtributosUltimaRegularizacao(string IdDiferimento, string IdMovimento, params dynamic[] Atributos)
Parameters
Type | Name | Description |
---|---|---|
System.String | IdDiferimento | Identificador (ID) do diferimento. |
System.String | IdMovimento | Identificador (ID) do movimento. |
System.Object[] | Atributos | Identifica os atributos para os quais se pretende devolver o valor. |
Returns
Type | Description |
---|---|
StdBECampos |
DaValorAtributoUltimaRegularizacao(String, String, String)
Devolve o valor de um atributo da última regularização de um movimento.
Declaration
dynamic DaValorAtributoUltimaRegularizacao(string IdDiferimento, string IdMovimento, string Atributo)
Parameters
Type | Name | Description |
---|---|---|
System.String | IdDiferimento | Identificador (ID) do diferimento. |
System.String | IdMovimento | Identificador (ID) do movimento. |
System.String | Atributo | Identifica o atributo para o qual se pretende devolver o valor. |
Returns
Type | Description |
---|---|
System.Object |
Existe(Int32, Int32, String, String)
Verifica se a Regularização do Diferimento existe na base de dados.
Declaration
bool Existe(int Exercicio, int Periodo, string IdDiferimento, string IdMovimento)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | Exercicio | Exercício do Diferimento. |
System.Int32 | Periodo | Período do Diferimento. |
System.String | IdDiferimento | Identificador (ID) do diferimento. |
System.String | IdMovimento | Identificador (ID) do movimento. |
Returns
Type | Description |
---|---|
System.Boolean |
ExisteID(String)
Verifica se a Regularização do Diferimento existe na base de dados.
Declaration
bool ExisteID(string IdRegularizacao)
Parameters
Type | Name | Description |
---|---|---|
System.String | IdRegularizacao | Identificador da Regularização de Diferimento. |
Returns
Type | Description |
---|---|
System.Boolean |
ExisteRegularizacaoDiferimento(String, String, Int32, Int32)
Verifica se existe alguma Regularização do Diferimento.
Declaration
bool ExisteRegularizacaoDiferimento(string IdDiferimento, string IdMovimento = "", int Exercicio = 0, int Periodo = 0)
Parameters
Type | Name | Description |
---|---|---|
System.String | IdDiferimento | Identificador (ID) do diferimento. |
System.String | IdMovimento | Identificador (ID) do movimento configurado no diferimento indicado (opcional). |
System.Int32 | Exercicio | Exercício da regularização (opcional). |
System.Int32 | Periodo | Período da regularização (opcional). |
Returns
Type | Description |
---|---|
System.Boolean |
ExisteRegularizacaoMovimento(String, Int32, Int32)
Verifica se existe alguma Regularização efetuada para o movimento (ID) contabilístico indicado.
Declaration
bool ExisteRegularizacaoMovimento(string IdMovimento, int Exercicio = 0, int Periodo = 0)
Parameters
Type | Name | Description |
---|---|---|
System.String | IdMovimento | Identificador (ID) do movimento. |
System.Int32 | Exercicio | Exercício da regularização (opcional). |
System.Int32 | Periodo | Período da regularização (opcional). |
Returns
Type | Description |
---|---|
System.Boolean |
Processa(Int32, Int32, Int32, String, String)
Processa a Regularização do Diferimento.
Declaration
StdBELista Processa(int Exercicio, int Periodo, int DiferimentosEstado = 0, string Restricao = "", string SelectSQL = "")
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | Exercicio | Exercício da regularização. |
System.Int32 | Periodo | Período da regularização. |
System.Int32 | DiferimentosEstado | Indica se processa para todos os movimentos/apenas os já diferidos/apenas os não diferidos. |
System.String | Restricao | Restrição (Cláusula SQL) a aplicar. |
System.String | SelectSQL | Cláusula SQL a aplicar aos campos selecionados. |
Returns
Type | Description |
---|---|
StdBELista |
ProcessaAutomatico(Int32, Int32)
Processa e grava a Regularização do Diferimento. Criação automática de um Modelo de Lançamento, quando este não é explícito na configuração do Modelo de Diferimento.
Declaration
bool ProcessaAutomatico(int Exercicio, int Periodo)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | Exercicio | Exercício da regularização. |
System.Int32 | Periodo | Período da regularização. |
Returns
Type | Description |
---|---|
System.Boolean |
ProcessaAutomatico(Int32, Int32, ref String)
Processa e grava a Regularização do Diferimento. Criação automática de um Modelo de Lançamento, quando este não é explícito na configuração do Modelo de Diferimento.
Declaration
bool ProcessaAutomatico(int Exercicio, int Periodo, ref string strAvisos)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | Exercicio | Exercício da regularização. |
System.Int32 | Periodo | Período da regularização. |
System.String | strAvisos | Descrição dos avisos que possam surgir durante a actualização |
Returns
Type | Description |
---|---|
System.Boolean |
Remove(Int32, Int32, String, String)
Remove toda a informação associada a uma Regularização do Diferimento.
Declaration
void Remove(int Exercicio, int Periodo, string IdDiferimento, string IdMovimento)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | Exercicio | Exercício do Diferimento. |
System.Int32 | Periodo | Período do Diferimento. |
System.String | IdDiferimento | Identificador (ID) do diferimento. |
System.String | IdMovimento | Identificador (ID) do movimento. |
RemoveID(String)
Remove toda a informação associada a uma Regularização do Diferimento.
Declaration
void RemoveID(string IdRegularizacao)
Parameters
Type | Name | Description |
---|---|---|
System.String | IdRegularizacao | Identificador da Regularização de Diferimento. |
ValidaActualizacao(CblBERegularizacaoDif, ref String)
Efectua a validação da actualização da Regularização de Diferimentos.
Declaration
bool ValidaActualizacao(CblBERegularizacaoDif objBE, ref string StrErro)
Parameters
Type | Name | Description |
---|---|---|
CblBERegularizacaoDif | objBE | Identifica da Regularização de Diferimento a actualizar. |
System.String | StrErro |
Returns
Type | Description |
---|---|
System.Boolean |
ValidaRemocao(Int32, Int32, String, String, ref String)
Valida a remoção do Diferimento.
Declaration
bool ValidaRemocao(int Exercicio, int Periodo, string IdDiferimento, string IdMovimento, ref string StrErro)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | Exercicio | Exercício do Diferimento. |
System.Int32 | Periodo | Período do Diferimento. |
System.String | IdDiferimento | Identificador (ID) do diferimento. |
System.String | IdMovimento | Identificador (ID) do movimento. |
System.String | StrErro |
Returns
Type | Description |
---|---|
System.Boolean |
ValidaRemocaoID(String, ref String)
Valida a remoção do Diferimento.
Declaration
bool ValidaRemocaoID(string IdRegularizacao, ref string StrErro)
Parameters
Type | Name | Description |
---|---|---|
System.String | IdRegularizacao | Identificador da Regularização de Diferimento. |
System.String | StrErro |
Returns
Type | Description |
---|---|
System.Boolean |