Class SepaStatement

Namespace: Subsembly.Sepa

Assembly: Subsembly.Sepa.dll

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

public class SepaStatement : SepaObject

Inheritance: object

SepaObject

SepaStatement

Inherited Members: SepaObject.TagName

SepaObject.IsMandatory

SepaObject.WriteXml(XmlWriter, SepaMessageInfo)

SepaObject.WriteXml(XmlWriter, SepaMessageInfo, string)

SepaObject.ReadXml(XmlReader, SepaMessageInfo)

SepaObject.ReadXml(XmlReader, SepaMessageInfo, string)

SepaObject.IsValid

SepaObject.Validate(ICollection<SepaException>, string)

SepaObject.OnWriteObjectXml(XmlWriter, SepaMessageInfo, string)

SepaObject.OnReadObjectXml(XmlReader, SepaMessageInfo, string)

SepaObject.OnAfterXmlRead(SepaMessageInfo)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

SepaStatement(string)

public SepaStatement(string sTagName)

Parameters

sTagName string

Properties

Account

The account of this statement.

public SepaAccount Account { get; set; }

Property Value

SepaAccount

AdditionalInformation

Additional information text pertaining to the statement.

public string AdditionalInformation { get; set; }

Property Value

string: The additional information is optional and may be null.

Balances

Sequence of balances of this statement.

public SepaBalances Balances { get; }

Property Value

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 date and time when the statement was created.

public DateTime CreationDateTime { get; set; }

Property Value

DateTime: By default this is initialized with the current local date and time. When setting this property any date and time may be given.

ElectronicSequenceNumber

Electronic sequence number of this statement.

public long ElectronicSequenceNumber { get; set; }

Property Value

long: 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

ArgumentOutOfRangeException: An attempt was made to set a negative value.

Entries

Sequence of statement entries of this statement.

public SepaStatementEntries Entries { get; }

Property Value

SepaStatementEntries

Remarks

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

FromDateTime

Optional date and time at the begin of this statement.

public DateTime FromDateTime { get; set; }

Property Value

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.

public string Identification { get; set; }

Property Value

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

IsEmpty

public override bool IsEmpty { get; }

Property Value

bool

LegalSequenceNumber

The sequence number of the corresponding printed statement.

public long LegalSequenceNumber { get; set; }

Property Value

long: 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

ArgumentOutOfRangeException: An attempt was made to set a negative value.

ToDateTime

Optional date and time at the end of this statement.

public DateTime ToDateTime { get; set; }

Property Value

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()

public override void Clear()

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

public static SepaStatement CreateStatement(SepaMessageType nMessageType, SepaBalance aOpeningBalance, SepaBalance aClosingBalance, IEnumerable<SepaStatementEntry> vEntries)

Parameters

nMessageType SepaMessageType
aOpeningBalance SepaBalance
aClosingBalance SepaBalance
vEntries IEnumerable<SepaStatementEntry>

Returns

SepaStatement

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