Class SepaBalance

Inheritance
System.Object
SepaObject
SepaBalance
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Subsembly.Sepa
Assembly: Subsembly.Sepa.dll
Syntax
public sealed class SepaBalance : SepaObject

Constructors

SepaBalance()

Declaration
public SepaBalance()

SepaBalance(Decimal, String, DateTime, SepaBalanceType)

Contructs a new instance, initialized to the given values.

Declaration
public SepaBalance(decimal nValue, string sCurrency, DateTime tDate, SepaBalanceType nType = SepaBalanceType.ClosingBooked)
Parameters
Type Name Description
System.Decimal nValue

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

The balance Amount Currency.
System.DateTime tDate

The balance Date.
SepaBalanceType nType

The balance Type

Properties

Amount

The amount and currency of this balance.

Declaration
public SepaAmount Amount { get; }
Property Value
Type Description
SepaAmount

CreditLineAmount

Amount of the credit line.

Declaration
public SepaAmount CreditLineAmount { get; }
Property Value
Type Description
SepaAmount

CreditLineIncluded

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

Declaration
public bool CreditLineIncluded { get; set; }
Property Value
Type Description
System.Boolean
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.

Declaration
public DateTime Date { get; set; }
Property Value
Type Description
System.DateTime
Remarks

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

IsEmpty

Declaration
public override bool IsEmpty { get; }
Property Value
Type Description
System.Boolean
Overrides

Type

Declaration
public SepaBalanceType Type { get; set; }
Property Value
Type Description
SepaBalanceType

TypeCode

The type of this balance.

Declaration
public string TypeCode { get; set; }
Property Value
Type Description
System.String
Exceptions
Type Condition
System.ArgumentException

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

TypeProprietary

Proprietary balance type.

Declaration
public string TypeProprietary { get; set; }
Property Value
Type Description
System.String
Remarks

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

Exceptions
Type Condition
System.ArgumentException

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

Methods

Clear()

Declaration
public override void Clear()
Overrides

Clone()

Declaration
public SepaBalance Clone()
Returns
Type Description
SepaBalance

OnReadXml(XmlReader, SepaMessageInfo)

Declaration
protected override void OnReadXml(XmlReader aXmlReader, SepaMessageInfo aMessageInfo)
Parameters
Type Name Description
System.Xml.XmlReader aXmlReader
SepaMessageInfo aMessageInfo
Overrides

OnValidate(ICollection<SepaException>, String)

Declaration
protected override void OnValidate(ICollection<SepaException> vErrors, string sPath)
Parameters
Type Name Description
System.Collections.Generic.ICollection<SepaException> vErrors
System.String sPath
Overrides

OnWriteXml(XmlWriter, SepaMessageInfo)

Declaration
protected override void OnWriteXml(XmlWriter aXmlWriter, SepaMessageInfo aMessageInfo)
Parameters
Type Name Description
System.Xml.XmlWriter aXmlWriter
SepaMessageInfo aMessageInfo
Overrides