Class SepaBalance

Namespace
Subsembly.Sepa
Assembly
Subsembly.Sepa.dll
public sealed class SepaBalance : SepaObject
Inheritance
SepaBalance
Inherited Members

Constructors

SepaBalance() 

public SepaBalance()

SepaBalance(decimal, string, DateTime, SepaBalanceType)

Contructs a new instance, initialized to the given values.

public SepaBalance(decimal nValue, string sCurrency, DateTime tDate, SepaBalanceType nType = SepaBalanceType.ClosingBooked)

Parameters

nValue decimal

The signed balance value. If this is a negative value, then the Debit indicator will be set, and the absolute amount is stored.

sCurrency string

The balance Amount Currency.

tDate DateTime

The balance Date.

nType SepaBalanceType

The balance Type

Properties

Amount

The amount and currency of this balance.

public SepaAmount Amount { get; }

Property Value

SepaAmount

CreditLineAmount

Amount of the credit line.

public SepaAmount CreditLineAmount { get; }

Property Value

SepaAmount

CreditLineIncluded

Indicates whether the given CreditLineAmount is included in the balance, or not.

public bool CreditLineIncluded { get; set; }

Property Value

bool

Remarks

Only if a nonempty CreditLineAmount was set, then this will actually be written together with the credit line amount. The default value is false.

If this is true, then the credit line amount must be subtracted from the balance value, in order to get the real balance value.

Date

The date of this balance.

public DateTime Date { get; set; }

Property Value

DateTime

Remarks

It is recommended to use a pure date value where the time is 00:00:00.

IsEmpty 

public override bool IsEmpty { get; }

Property Value

bool

Type 

public SepaBalanceType Type { get; set; }

Property Value

SepaBalanceType

TypeCode

The type of this balance.

public string TypeCode { get; set; }

Property Value

string

Exceptions

ArgumentException

An attempt was made to set a value that was not exactly four upper case characters.

TypeProprietary

Proprietary balance type.

public string TypeProprietary { get; set; }

Property Value

string

Remarks

Either TypeCode or TypeProprietary must be set, but not both.

Exceptions

ArgumentException

An attempt was made to set a value that is not a syntactically valid code.

Methods

Clear() 

public override void Clear()

Clone() 

public SepaBalance Clone()

Returns

SepaBalance

OnReadXml(XmlReader, SepaMessageInfo) 

protected override void OnReadXml(XmlReader aXmlReader, SepaMessageInfo aMessageInfo)

Parameters

aXmlReader XmlReader
aMessageInfo SepaMessageInfo

OnValidate(ICollection<SepaException>, string) 

protected override void OnValidate(ICollection<SepaException> vErrors, string sPath)

Parameters

vErrors ICollection<SepaException>
sPath string

OnWriteXml(XmlWriter, SepaMessageInfo) 

protected override void OnWriteXml(XmlWriter aXmlWriter, SepaMessageInfo aMessageInfo)

Parameters

aXmlWriter XmlWriter
aMessageInfo SepaMessageInfo