Interface ICctBSRemessasBanc

Classe utilizada para obter serviços e regras de negócio sobre Remessas Bancárias.

Namespace: ICctBS100

Assembly: ICctBS100.dll

Syntax

[ComVisible(true)]
[Guid("3D0BD2B6-AD01-4764-BAA2-AA4CF968F2EF")]
public interface ICctBSRemessasBanc

Methods

Actualiza(CctBERemessaBanc)

Actualiza uma remessa bancária.

Declaration

void Actualiza(CctBERemessaBanc objRemessaBanc)

Parameters

Type	Name	Description
CctBERemessaBanc	objRemessaBanc	Identifica o objecto da remessa bancária.

Actualiza(CctBERemessaBanc, ref String)

Actualiza uma remessa bancária.

Declaration

void Actualiza(CctBERemessaBanc objRemessaBanc, ref string StrAviso)

Parameters

Type	Name	Description
CctBERemessaBanc	objRemessaBanc	Identifica o objecto da remessa bancária.
System.String	StrAviso

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

Actualiza o valor de um atributo da transferencia.

Declaration

void ActualizaValorAtributo(string Filial, string TipoDoc, string Serie, int NumDoc, string Atributo, dynamic Valor)

Parameters

Type	Name	Description
System.String	Filial	Identifica a filial do documento.
System.String	TipoDoc	Identifica o tipo de documento.
System.String	Serie	Identifica a série do documento.
System.Int32	NumDoc	Identifica o numero do documento.
System.String	Atributo	Identifica o atributo a actualizar.
System.Object	Valor	Identifica o valor a gravar no atributo seleccionado.

ActualizaValorAtributoID(String, String, Object)

Actualiza o valor de um atributo pelo Id.

Declaration

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

Parameters

Type	Name	Description
System.String	Id	Identificador do Id.
System.String	Atributo	Identificador do Atributo.
System.Object	Valor	Identificador do Valor.

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

Actualiza o valor de um conjunto de atributos da transferencia.

Declaration

void ActualizaValorAtributos(string Filial, string TipoDoc, string Serie, int NumDoc, StdBECampos Atributos)

Parameters

Type	Name	Description
System.String	Filial	Identifica a filial do documento.
System.String	TipoDoc	Identifica o tipo de documento.
System.String	Serie	Identifica a série do documento.
System.Int32	NumDoc	Identifica o numero do documento.
StdBECampos	Atributos	Identifica os atributos e os respectivos valores a actualizar.

ActualizaValorAtributosID(String, StdBECampos)

Actualiza o valor de um conjunto de atributos da remessa.

Declaration

void ActualizaValorAtributosID(string Id, StdBECampos Atributos)

Parameters

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

AdicionaLinha(CctBERemessaBanc, String, String, String, String, Int32, Int32, String, Int32, Double)

Adiciona a(s) linha(s) ao documento de Transferencia com os dados do documento a liquidar.

Declaration

CctBERemessaBanc AdicionaLinha(CctBERemessaBanc objRemessaBanc, string Filial, string Modulo, string TipoDoc, string Serie, int NumDoc, int NumPrestacao, string Estado, int NumTransferencia, double ValorMoedaDoc = 0)

Parameters

Type	Name	Description
CctBERemessaBanc	objRemessaBanc	Objecto que identifica a remessa bancária.
System.String	Filial	Código da filial do documento a transferir.
System.String	Modulo	Módulo do documento a transferir.
System.String	TipoDoc	Código do tipo de documento a transferir.
System.String	Serie	Série do documento a transferir.
System.Int32	NumDoc	Número do documento a transferir.
System.Int32	NumPrestacao	Número da prestação do documento.
System.String	Estado	Identifica o estado.
System.Int32	NumTransferencia	Número de transferência.
System.Double	ValorMoedaDoc	Valor na moeda do documento.

Returns

Type	Description
CctBERemessaBanc

CalculaCambioMedio(CctBERemessaBanc)

Calcula o cambio médio de dum documento de remessa bancária

Declaration

CctBERemessaBanc CalculaCambioMedio(CctBERemessaBanc RemessaBanc)

Parameters

Type	Name	Description
CctBERemessaBanc	RemessaBanc	Remessa a ser aplicado o cambio médio

Returns

Type	Description
CctBERemessaBanc

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.

Declaration

StdBEDefCamposUtil DaDefCamposUtilLinhas()

Returns

Type	Description
StdBEDefCamposUtil

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

Devolve o valor de um atributo da transferencia.

Declaration

dynamic DaValorAtributo(string Filial, string TipoDoc, string Serie, int NumDoc, string Atributo)

Parameters

Type	Name	Description
System.String	Filial	Identifica a filial do documento.
System.String	TipoDoc	Identifica o tipo de documento.
System.String	Serie	Identifica a série do documento.
System.Int32	NumDoc	Identifica o numero do documento.
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 da transferencia.

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

DaValorAtributoIDLock(String, String)

Devolve o valor de um atributo da transferencia.

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, Int32, String)

Devolve o valor de um atributo da transferencia.

Declaration

dynamic DaValorAtributoLock(string Filial, string TipoDoc, string Serie, int NumDoc, string Atributo)

Parameters

Type	Name	Description
System.String	Filial	Identifica a filial do documento.
System.String	TipoDoc	Identifica o tipo de documento.
System.String	Serie	Identifica a série do documento.
System.Int32	NumDoc	Identifica o numero do documento.
System.String	Atributo	Identifica o atributo para o qual se pretende devolver o valor.

Returns

Type	Description
System.Object

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

Devolve o valor de um conjunto de atributos da transferencia.

Declaration

StdBECampos DaValorAtributos(string Filial, string TipoDoc, string Serie, int NumDoc, params string[] Atributos)

Parameters

Type	Name	Description
System.String	Filial	Identifica a filial do documento.
System.String	TipoDoc	Identifica o tipo de documento.
System.String	Serie	Identifica a série do documento.
System.Int32	NumDoc	Identifica o numero do documento.
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 da transferencia.

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

DaValorAtributosIDLock(String, String[])

Devolve o valor de um conjunto de atributos da transferencia.

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, Int32, String[])

Devolve o valor de um conjunto de atributos da transferencia.

Declaration

StdBECampos DaValorAtributosLock(string Filial, string TipoDoc, string Serie, int NumDoc, params string[] Atributos)

Parameters

Type	Name	Description
System.String	Filial	Identifica a filial do documento.
System.String	TipoDoc	Identifica o tipo de documento.
System.String	Serie	Identifica a série do documento.
System.Int32	NumDoc	Identifica o numero do documento.
System.String[]	Atributos	Identifica os atributos para os quais se pretende devolver o valor.

Returns

Type	Description
StdBECampos

DaValoresContaDomiciliacao(String, String, String, ref String, ref String, ref String, ref String)

Devolve os valores associados a uma conta de domiciliação para uma entidade.

Declaration

bool DaValoresContaDomiciliacao(string TipoEntidade, string Entidade, string Conta, ref string IBAN, ref string SWIFT, ref string Mandato, ref string Estado)

Parameters

Type	Name	Description
System.String	TipoEntidade	Tipo de entidade.
System.String	Entidade	Código da entidade.
System.String	Conta	Conta bancária.
System.String	IBAN	Valor referente ao IBAN a devolver.
System.String	SWIFT	Valor referente ao SWIFT a devolver.
System.String	Mandato	Valor referente ao mandato a devolver
System.String	Estado	Valor referente ao estado do mandato a devolver.

Returns

Type	Description
System.Boolean

Edita(String, String, String, Int32)

Permite editar uma transferencia.

Declaration

CctBERemessaBanc Edita(string Filial, string TipoDoc, string Serie, int NumDoc)

Parameters

Type	Name	Description
System.String	Filial	Identifica a filial do documento.
System.String	TipoDoc	Identifica o tipo de documento.
System.String	Serie	Identifica a série do documento.
System.Int32	NumDoc	Identifica o numero do documento.

Returns

Type	Description
CctBERemessaBanc

EditaID(String)

Permite editar uma remessa.

Declaration

CctBERemessaBanc EditaID(string Id)

Parameters

Type	Name	Description
System.String	Id	Identificador da remessa.

Returns

Type	Description
CctBERemessaBanc

EditaNumRemessa(String, Int32)

Permite editar uma remessa.

Declaration

CctBERemessaBanc EditaNumRemessa(string ContaBancaria, int NumRemessa)

Parameters

Type	Name	Description
System.String	ContaBancaria	Identificador da conta bancária.
System.Int32	NumRemessa	Número da remessa.

Returns

Type	Description
CctBERemessaBanc

Existe(String, String, String, Int32)

Verifica se uma transferencia existe.

Declaration

bool Existe(string Filial, string TipoDoc, string Serie, int NumDoc)

Parameters

Type	Name	Description
System.String	Filial	Identifica a filial do documento.
System.String	TipoDoc	Identifica o tipo de documento.
System.String	Serie
System.Int32	NumDoc	Identifica o numero do documento.

Returns

Type	Description
System.Boolean

ExisteID(String)

Verifica se uma remessa bancária existe.

Declaration

bool ExisteID(string Id)

Parameters

Type	Name	Description
System.String	Id	Identificador da remessa.

Returns

Type	Description
System.Boolean

ExisteNumRemessa(String, Int32)

Verifica se uma remessa bancária existe.

Declaration

bool ExisteNumRemessa(string ContaBancaria, int NumRemessa)

Parameters

Type	Name	Description
System.String	ContaBancaria	Identificador da conta bancária.
System.Int32	NumRemessa	Número da remessa.

Returns

Type	Description
System.Boolean

PodeSubmeterParaAprovacao(CctBERemessaBanc)

Verifica se a proposta pode ser submetida para aprovação

Declaration

bool PodeSubmeterParaAprovacao(CctBERemessaBanc objRemessaBanc)

Parameters

Type	Name	Description
CctBERemessaBanc	objRemessaBanc	The object remessa banc.

Returns

Type	Description
System.Boolean

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

Permite remover uma transferencia.

Declaration

bool Remove(string Filial, string TipoDoc, string Serie, int NumDoc, string StrAviso = "")

Parameters

Type	Name	Description
System.String	Filial	Identifica a filial do documento.
System.String	TipoDoc	Identifica o tipo de documento.
System.String	Serie	Identifica a série do documento.
System.Int32	NumDoc	Identifica o numero do documento.
System.String	StrAviso	Devolve os avisos encontrados durante a remoção.

Returns

Type	Description
System.Boolean

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

Permite anular uma transferencia.

Declaration

bool Remove(string Filial, string TipoDoc, string Serie, int NumDoc, string StrAviso = "", string strMotivoAnulacao = "", string strObservacoesAnulacao = "")

Parameters

Type	Name	Description
System.String	Filial	Identifica a filial do documento.
System.String	TipoDoc	Identifica o tipo de documento.
System.String	Serie	Identifica a série do documento.
System.Int32	NumDoc	Identifica o numero do documento.
System.String	StrAviso	Devolve os avisos encontrados durante a remoção.
System.String	strMotivoAnulacao	Indicar o motivo de anulação
System.String	strObservacoesAnulacao	Indicar as observações da anulação

Returns

Type	Description
System.Boolean

RemoveID(String, String)

Permite remover uma transferencia.

Declaration

bool RemoveID(string Id, string StrAviso = "")

Parameters

Type	Name	Description
System.String	Id	Identificador da remessa.
System.String	StrAviso

Returns

Type	Description
System.Boolean

RemoveNumRemessa(String, Int32, String)

Permite remover uma transferencia.

Declaration

bool RemoveNumRemessa(string ContaBancaria, int NumRemessa, string StrAviso = "")

Parameters

Type	Name	Description
System.String	ContaBancaria	Identifica da conta bancária.
System.Int32	NumRemessa	Número da remessa.
System.String	StrAviso

Returns

Type	Description
System.Boolean

SubmeterParaAprovacao(CctBERemessaBanc)

Submeter a proposta de pagamento para aprovação

Declaration

void SubmeterParaAprovacao(CctBERemessaBanc objRemessaBanc)

Parameters

Type	Name	Description
CctBERemessaBanc	objRemessaBanc	The object remessa banc.

TransferenciaEstado(CctBERemessaBanc)

Indica se o tipo de transferência do documento é de estado

Declaration

bool TransferenciaEstado(CctBERemessaBanc objRemessaBanc)

Parameters

Type	Name	Description
CctBERemessaBanc	objRemessaBanc	Remessa bancária.

Returns

Type	Description
System.Boolean

ValidaActualizacao(CctBERemessaBanc, ref String)

Função que valida a possibilidade de haver transferencias

Declaration

bool ValidaActualizacao(CctBERemessaBanc objRemessaBanc, ref string StrErro)

Parameters

Type	Name	Description
CctBERemessaBanc	objRemessaBanc	Identifica o documento de transferencia a ser validado.
System.String	StrErro

Returns

Type	Description
System.Boolean

ValidaActualizacaoEX(CctBERemessaBanc, ref String)

Função que valida a possibilidade de haver transferencias

Declaration

bool ValidaActualizacaoEX(CctBERemessaBanc RemessaBancaria, ref string Erros)

Parameters

Type	Name	Description
CctBERemessaBanc	RemessaBancaria
System.String	Erros	Devolve os erros encontrados durante a validação.

Returns

Type	Description
System.Boolean

ValidaActualizacaoEX(CctBERemessaBanc, ref String, ref String)

Função que valida a possibilidade de haver transferencias

Declaration

bool ValidaActualizacaoEX(CctBERemessaBanc RemessaBancaria, ref string Erros, ref string Avisos)

Parameters

Type	Name	Description
CctBERemessaBanc	RemessaBancaria
System.String	Erros	Devolve os erros encontrados durante a validação.
System.String	Avisos	Devolve os avisos encontrados durante a validação.

Returns

Type	Description
System.Boolean

ValidaActualizacaoEX(CctBERemessaBanc, ref String, ref String, Boolean)

Função que valida a possibilidade de haver transferencias

Declaration

bool ValidaActualizacaoEX(CctBERemessaBanc RemessaBancaria, ref string Erros, ref string Avisos, bool DocTrataTransacaoElectronica)

Parameters

Type	Name	Description
CctBERemessaBanc	RemessaBancaria
System.String	Erros	Devolve os erros encontrados durante a validação.
System.String	Avisos	Devolve os avisos encontrados durante a validação.
System.Boolean	DocTrataTransacaoElectronica	Indica se o documento envia para transações electrónicas.

Returns

Type	Description
System.Boolean

ValidaAnulacaoRemessa(String, ref String)

Valida se uma remessa pode ser editada ou anulada

Declaration

bool ValidaAnulacaoRemessa(string IdRemessa, ref string Erro)

Parameters

Type	Name	Description
System.String	IdRemessa	Indentificador da remessa a validar
System.String	Erro	Devolve a mensagem de erro caso não seja possível anular/editar

Returns

Type	Description
System.Boolean

ValidaRemocao(CctBERemessaBanc, ref String)

Permite efectuar a validação da remoção de uma transferencia.

Declaration

bool ValidaRemocao(CctBERemessaBanc objRemessaBanc, ref string StrErro)

Parameters

Type	Name	Description
CctBERemessaBanc	objRemessaBanc	Objecto que identifica a transferencia.
System.String	StrErro	Devolve os erros encontrados durante a validação.

Returns

Type	Description
System.Boolean