Class SepaStatement

Generic class for statements ("Stmt" element in "camt.053"), reports ("Rpt" element in "camt.052"), and notifications ("Ntfctn" element in "camt.054").

Inheritance
System.Object
SepaObject
SepaStatement
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 class SepaStatement : SepaObject

Constructors

SepaStatement(String)

Declaration
public SepaStatement(string sTagName)
Parameters
Type Name Description
System.String sTagName

Properties

Account

The account of this statement.

Declaration
public SepaAccount Account { get; set; }
Property Value
Type Description
SepaAccount

AdditionalInformation

Additional information text pertaining to the statement.

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

The additional information is optional and may be null.

Balances

Sequence of balances of this statement.

Declaration
public SepaBalances Balances { get; }
Property Value
Type Description
SepaBalances
Remarks

For "camt.053" statements there must be at least two balances. The first must be the opening balance of the statement, and the second must be the closing balance of the statement. For "camt.052" reports, balances are optional and the collection may be empty. For "camt.054" notifications the collection must be empty.

CreationDateTime

The local date and time when the statement was created.

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

By default this is initialized with the current local date and time. When setting this property any date and time, except DateTime.MinValue may be given.
Exceptions
Type Condition
System.ArgumentException

An attempt was made to set this property to DateTime.MinValue. The value DateTime.MinValue is often used to indicate a logical Null-DateTime and therefore is not permitted here.

ElectronicSequenceNumber

Electronic sequence number of this statement.

Declaration
public long ElectronicSequenceNumber { get; set; }
Property Value
Type Description
System.Int64

By default this has an internal null value to indicate that the property was not initialized. Only when the property is explicitly set, then it will written when the XML is generated.
Remarks

This property is mandatory by the ZKA specification for statements. It is optional for repors and notifications.

Exceptions
Type Condition
System.ArgumentOutOfRangeException

An attempt was made to set a negative value.

Entries

Sequence of statement entries of this statement.

Declaration
public SepaStatementEntries Entries { get; }
Property Value
Type Description
SepaStatementEntries
Remarks

The collection may be empty if there are no statement entries.

FromDateTime

Optional local date and time at the begin of this statement.

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

By default this is initialized with DateTime.MinValue to indicate that no From date and time is available.
Remarks

Either both, FromDateTime and ToDateTime must be set, or none.

Identification

Unique identification of this statement provided by bank.

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

An arbitrary text with a maximum length of MaxIdLen (35) characters.

IsEmpty

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

LegalSequenceNumber

The sequence number of the corresponding printed statement.

Declaration
public long LegalSequenceNumber { get; set; }
Property Value
Type Description
System.Int64

By default this has an internal null value to indicate that the property was not initialized. Only when the property is explicitly set, then it will written when the XML is generated.
Exceptions
Type Condition
System.ArgumentOutOfRangeException

An attempt was made to set a negative value.

ToDateTime

Optional local date and time at the end of this statement.

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

By default this is initialized with DateTime.MinValue to indicate that no From date and time is available.
Remarks

Either both, FromDateTime and ToDateTime must be set, or none.

Methods

Clear()

Declaration
public override void Clear()
Overrides

CreateStatement(SepaMessageType, SepaBalance, SepaBalance, IEnumerable<SepaStatementEntry>)

Declaration
public static SepaStatement CreateStatement(SepaMessageType nMessageType, SepaBalance aOpeningBalance, SepaBalance aClosingBalance, IEnumerable<SepaStatementEntry> vEntries)
Parameters
Type Name Description
SepaMessageType nMessageType
SepaBalance aOpeningBalance
SepaBalance aClosingBalance
System.Collections.Generic.IEnumerable<SepaStatementEntry> vEntries
Returns
Type Description
SepaStatement

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