Class SepaStatementEntry

Inheritance

System.Object

SepaObject

SepaStatementEntry

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.OnAfterXmlRead(SepaMessageInfo)

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 SepaStatementEntry : SepaObject

Constructors

SepaStatementEntry()

Declaration

public SepaStatementEntry()

Properties

AccountServicerReference

Optional unique entry reference of this statement entry, provided by the bank.

Declaration

public string AccountServicerReference { get; set; }

Property Value

Type	Description
System.String	An arbitrary text with a maximum length of MaxIdLen (35) characters. The character set must match CheckCharset(String).

Exceptions

Type	Condition
System.ArgumentException	An attempt was made to set a string longer than 35 characters, or a string that contains invalid characters.

See Also

EntryReference

AdditionalEntryInformation

Additional information text pertaining to the statement.

Declaration

public string AdditionalEntryInformation { get; set; }

Property Value

Type	Description
System.String	The additional information is optional and may be null. Usually the banks provide the narrative of the transaction code in this field.

AdditionalInformationMessageIdentification

Optional reference to a message identification that provides details about a batch booking.

Declaration

public string AdditionalInformationMessageIdentification { get; set; }

Property Value

Type	Description
System.String	An arbitrary text with a maximum length of MaxIdLen (35) characters. The character set must match CheckCharset(String).

Remarks

This provides the message identification of a message that was prepared by the bank in order to supply detailed information about the batch booking summarized by this entry. The type of the supplementary message is provided in AdditionalInformationMessageNameIdentification.

AdditionalInformationMessageNameIdentification

Optional reference to message type that provides details about a batch booking.

Declaration

public string AdditionalInformationMessageNameIdentification { get; set; }

Property Value

Type	Description
System.String	A message name such as "camt.054.001.02".

Remarks

This provides the message type of a message that was prepared by the bank in order to supply detailed information about the batch booking summarized by this entry. The actual message identification of the supplementary message is provided in AdditionalInformationMessageIdentification.

Amount

The monetary amount of the statement entry.

Declaration

public SepaAmount Amount { get; }

Property Value

Type	Description
SepaAmount

Remarks

The currency of this amount must match the account currency.

BankTransactionCode

DEPRECATED. Use TransactionCode.ProprietaryCode instead.

Declaration

public string BankTransactionCode { get; set; }

Property Value

Type	Description
System.String

Remarks

For compatibility: Settings this property also sets the BankTransactionCodeIssuer to "DK", unless it was already set to another non-empty value.

BankTransactionCodeIssuer

DEPRECATED. Use TransactionCode.ProprietaryIssuer instead.

Declaration

public string BankTransactionCodeIssuer { get; set; }

Property Value

Type	Description
System.String

Batch

Indicates whether this is a batch entry, or a single transaction.

Declaration

public bool Batch { get; set; }

Property Value

Type	Description
System.Boolean

Remarks

This flag must be set when generating a statement entry for a batch booking. The individual transactions may be included in the TransactionDetails collection, or be referenced by BatchMessageIdentification or BatchPaymentInformationIdentification.

If this is false, then the this is a statement entry for a single transaction and must contain one transaction only.

When reading the statement entry this flag is set whenever a Btch element was contained in the NtryDtls element. Also, whenever if this flag is set, then a Btch element will be written.

BatchMessageIdentification

Optional identification of the orginal batch message of a batch entry.

Declaration

public string BatchMessageIdentification { get; set; }

Property Value

Type	Description
System.String	An arbitrary text with a maximum length of MaxIdLen (35) characters. By default this property is null.

Remarks

The character set must match CheckCharset(String). Setting this property with a nonempty value will implicitly set the Batch flag, too.

Exceptions

Type	Condition
System.ArgumentException	An attempt was made to set a string longer than 35 characters, or a string that contains invalid characters.

BatchNumberOfTransactions

Optional number of transactions in batch entry.

Declaration

public int BatchNumberOfTransactions { get; set; }

Property Value

Type	Description
System.Int32

Remarks

Setting this property with a nonzero value will implicitly set the Batch flag, too.

Exceptions

Type	Condition
System.ArgumentException	An attempt was made to set a negative value.

BatchPaymentInformationIdentification

Optional identification of the original batch payment information.

Declaration

public string BatchPaymentInformationIdentification { get; set; }

Property Value

Type	Description
System.String	An arbitrary text with a maximum length of MaxIdLen (35) characters.

Remarks

If this entry originated from a batch file, then the bank may provide the payment information identification of the original batch file in this property. For German DTAUS batch files this should be the content of field A10 of the batch file.

Setting this property with a nonempty value will implicitly set the Batch flag, too.

Exceptions

Type	Condition
System.ArgumentException	An attempt was made to set a string longer than 35 characters, or a string that contains invalid characters.

BookingDate

The booking date of this entry.

Declaration

public DateTime BookingDate { get; set; }

Property Value

Type	Description
System.DateTime	The value DateTime.MinValue indicates that no date has been set.

Remarks

When writing this entry only the date without the time is written. When reading the date, either the date, or a date and a time is read from the XML document.

Charges

Collection of SepaChargesRecords contained in this entry.

Declaration

public SepaCharges Charges { get; }

Property Value

Type	Description
SepaCharges

EntryReference

Optional unique entry reference of this statement entry, provided by the bank.

Declaration

public string EntryReference { get; set; }

Property Value

Type	Description
System.String	An arbitrary text with a maximum length of MaxIdLen (35) characters. The character set must match CheckCharset(String).

Exceptions

Type	Condition
System.ArgumentException	An attempt was made to set a string longer than 35 characters, or a string that contains invalid characters.

See Also

AccountServicerReference

IsEmpty

Declaration

public override bool IsEmpty { get; }

Property Value

Type	Description
System.Boolean

Overrides

SepaObject.IsEmpty

ReversalIndicator

Indicates whether this entry is a reversal of a previous entry.

Declaration

public bool ReversalIndicator { get; set; }

Property Value

Type	Description
System.Boolean

Status

Status of this entry.

Declaration

public string Status { get; set; }

Property Value

Type	Description
System.String	A four letter code that indicates the status of this entry. This is a required property and therefore must be set with a valid code before the entry can be written.

StatusCode

Status of this entry.

Declaration

public SepaStatementEntryStatus StatusCode { get; set; }

Property Value

Type	Description
SepaStatementEntryStatus

TransactionCode

The bank transaction code set of elements.

Declaration

public SepaBankTransactionCode TransactionCode { get; }

Property Value

Type	Description
SepaBankTransactionCode

TransactionDetails

Collection of individual transactions that make up this entry.

Declaration

public SepaTransactionDetailsCollection TransactionDetails { get; }

Property Value

Type	Description
SepaTransactionDetailsCollection

Remarks

Usually this collection contains only a single entry. When this statement entry stems from a batch payment, then the bank may opt to provide the details of the individual transactions of the batch payment as multiple SepaTransactionDetails objects in this collection. In all cases, the total amount of all transactions must match the Amount of the entry.

ValueDate

The value date of this entry.

Declaration

public DateTime ValueDate { get; set; }

Property Value

Type	Description
System.DateTime	The value DateTime.MinValue indicates that no date has been set.

Remarks

When writing this entry only the date without the time is written. When reading the date, either the date, or a date and a time is read from the XML document.

Methods

Clear()

Declaration

public override void Clear()

Overrides

SepaObject.Clear()

CreateEntry(SepaTransactionDetails)

Creates a simple default entry that contains the given single transaction.

Declaration

public static SepaStatementEntry CreateEntry(SepaTransactionDetails aTxn)

Parameters

Type	Name	Description
SepaTransactionDetails	aTxn

Returns

Type	Description
SepaStatementEntry

OnReadXml(XmlReader, SepaMessageInfo)

Declaration

protected override void OnReadXml(XmlReader aXmlReader, SepaMessageInfo aMessageInfo)

Parameters

Type	Name	Description
System.Xml.XmlReader	aXmlReader
SepaMessageInfo	aMessageInfo

Overrides

SepaObject.OnReadXml(XmlReader, SepaMessageInfo)

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

SepaObject.OnValidate(ICollection<SepaException>, String)

OnWriteXml(XmlWriter, SepaMessageInfo)

Declaration

protected override void OnWriteXml(XmlWriter aXmlWriter, SepaMessageInfo aMessageInfo)

Parameters

Type	Name	Description
System.Xml.XmlWriter	aXmlWriter
SepaMessageInfo	aMessageInfo

Overrides

SepaObject.OnWriteXml(XmlWriter, SepaMessageInfo)