Class EbicsOrderDetails

Holds the details about an EBICS order as provided by VEU inquiries.

Inheritance
System.Object
EbicsElement
EbicsOrderDetails
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.EBICS
Assembly: Subsembly.EBICS.Core.dll
Syntax
public class EbicsOrderDetails : EbicsElement
Remarks

Instance of this class are used to collect the order details returned in a HVUResponseOrderData, HVZResponseOrderData, or HVDResponseOrderData reponse document.

Constructors

EbicsOrderDetails()

Declaration
public EbicsOrderDetails()

Properties

AcctNoCheckSum

The check sum over all account numbers (Summe der Kontonummern).

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

This only appears in the DisplayFile and is only extracted when ParseDisplayFile(String) is called. Otherwise it will be null.

AdditionalOrderInfo

Additional plain text order information.

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

This element was added with EBICS 3.0 and only appears in HVUResponseOrderData and HVZResponseOrderData

BankCodeCheckSum

The check sum over all bank codes (Summe der Bankleitzahlen).

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

This only appears in the DisplayFile and is only extracted when ParseDisplayFile(String) is called. Otherwise it will be null.

BatchReference

The batch file reference. For SEPA orders this is the PmtInfId element from the SEPA XML.

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

This only appears in the DisplayFile and is only extracted when ParseDisplayFile(String) is called. Otherwise it will be null.

Currency

The currency of the payments in this order.

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

A Currency element appears in the HVZPaymentOrderDetailsStructure of the HVZResponseOrderData.

DataDigest

The hash value of the order data.

Declaration
public EbicsDataBuffer DataDigest { get; set; }
Property Value
Type Description
EbicsDataBuffer
Remarks

A DataDigest element appears in HVZResponseOrderData and HVDResponseOrderData.

DisplayFile

The display file data.

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

A DisplayFile element appears in HVDResponseOrderData.

FirstOrderAccountInfo

The account information of the ordering account of the first entry in this order.

Declaration
public EbicsAccountInfo FirstOrderAccountInfo { get; set; }
Property Value
Type Description
EbicsAccountInfo

FirstOrderPartyInfo

The order party name of the first entry in this order.

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

NumSigDone

The number of signatures already given for this order.

Declaration
public int NumSigDone { get; set; }
Property Value
Type Description
System.Int32
Remarks

A NumSigDone attribute appears in the SigningInfo element of HVUResponseOrderData and HVZResponseOrderData.

NumSigRequired

The total number of signatures required for this order.

Declaration
public int NumSigRequired { get; set; }
Property Value
Type Description
System.Int32
Remarks

A NumSigRequired attribute appears in the SigningInfo element of HVUResponseOrderData and HVZResponseOrderData.

OrderDataAvailable

Flag that indicates whether the complete order data is available for download.

Declaration
public bool OrderDataAvailable { get; set; }
Property Value
Type Description
System.Boolean
Remarks

A OrderDataAvailable flag appears in HVZResponseOrderData and HVDResponseOrderData.

OrderDataSize

The uncompressed order data size.

Declaration
public int OrderDataSize { get; set; }
Property Value
Type Description
System.Int32
Remarks

An OrderDataSize element appears in HVUResponseOrderData, HVZResponseOrderData, and HVDResponseOrderData.

OrderDetailsAvailable

Flag that indicates whether the complete order details are available for download in EBICS XML format.

Declaration
public bool OrderDetailsAvailable { get; set; }
Property Value
Type Description
System.Boolean
Remarks

A OrderDetailsAvailable flag appears in HVZResponseOrderData and HVDResponseOrderData.

OrderID

The order number.

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

An OrderID element appears in HVUResponseOrderData and HVZResponseOrderData.

OrderType

The order type.

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

An OrderType element appears in HVUResponseOrderData and HVZResponseOrderData.

Ebics-Version < 3.0

OriginatorInfo

Information about the originator of this order.

Declaration
public EbicsHVSignerInfo OriginatorInfo { get; set; }
Property Value
Type Description
EbicsHVSignerInfo
Remarks

An OriginatorInfo element appears in HVUResponseOrderData and HVZResponseOrderData.

ReadyToBeSigned

Flag that indicates whether this order is ready to be signed.

Declaration
public bool ReadyToBeSigned { get; set; }
Property Value
Type Description
System.Boolean
Remarks

A readyToBeSigned attribute appears in the SigningInfo element of HVUResponseOrderData and HVZResponseOrderData.

ScheduledDate

The scheduled date of the order.

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

If no scheduled date could be found, then this will return DateTime.MinValue. This only appears in the DisplayFile and is only extracted when ParseDisplayFile(String) is called. Otherwise it will be null.

Service

The service element

Declaration
public EbicsService Service { get; set; }
Property Value
Type Description
EbicsService
Remarks

Replaces OrderType with Ebics-Version 3.0.

SignatureVersion

The signature version of the DataDigest.

Declaration
public EbicsSecurityCode SignatureVersion { get; set; }
Property Value
Type Description
EbicsSecurityCode
Remarks

A SignatureVersion attribute appears in the DataDigest element of HVZResponseOrderData and HVDResponseOrderData.

SignerInfos

The collection of signer infos.

Declaration
public EbicsHVSignerInfos SignerInfos { get; }
Property Value
Type Description
EbicsHVSignerInfos
Remarks

A sequence of SignerInfo elements appears in HVUResponseOrderData, HVZResponseOrderData, and HVDResponseOrderData.

SigningInfo

Indicates whether a SigningInfo EBICS XML element is present.

Declaration
public bool SigningInfo { get; set; }
Property Value
Type Description
System.Boolean
Remarks

Only if this property is true, then the properties ReadyToBeSigned, NumSigRequired, and NumSigDone contain any meaningful information.

Title

The title line from the display file.

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

This only appears in the DisplayFile and is only extracted when ParseDisplayFile(String) is called. Otherwise it will be null.

TotalAmount

The total amount of all payments in this order.

Declaration
public decimal TotalAmount { get; set; }
Property Value
Type Description
System.Decimal
Remarks

A TotalAmount element appears in the HVZPaymentOrderDetailsStructure of the HVZResponseOrderData.

TotalOrders

The total number of payments in this order.

Declaration
public int TotalOrders { get; set; }
Property Value
Type Description
System.Int32
Remarks

A TotalOrders element appears in the HVZPaymentOrderDetailsStructure of the HVZResponseOrderData.

Methods

AugmentOrderDetails(EbicsOrderDetails)

Add additional properties of another EbicsOrderDetails to these order details.

Declaration
public void AugmentOrderDetails(EbicsOrderDetails aOrderDetails)
Parameters
Type Name Description
EbicsOrderDetails aOrderDetails

A EbicsOrderDetails instance with additional information that shall be merged with this instance. This must not be null.
Remarks

After this instance was created by downloading the order details through an HVU request, this method may be called to add the additional information from a HVZ download to these order details.

Exceptions
Type Condition
System.ArgumentNullException

The parameter was null.
System.ArgumentException

Is thrown if the given order details specify a different, non-null OrderID than this order.

BuildHVDResponseOrderData(EbicsVersion)

Creates a HVDResponseOrderData response order data document.

Declaration
public XmlDocument BuildHVDResponseOrderData(EbicsVersion nVersion)
Parameters
Type Name Description
EbicsVersion nVersion
Returns
Type Description
System.Xml.XmlDocument

BuildHVUOrderDetails(XmlDocument, EbicsVersion)

Declaration
public XmlElement BuildHVUOrderDetails(XmlDocument xmlDocument, EbicsVersion nVersion)
Parameters
Type Name Description
System.Xml.XmlDocument xmlDocument
EbicsVersion nVersion
Returns
Type Description
System.Xml.XmlElement

BuildHVZOrderDetails(XmlDocument, EbicsVersion)

Declaration
public XmlElement BuildHVZOrderDetails(XmlDocument xmlDocument, EbicsVersion nVersion)
Parameters
Type Name Description
System.Xml.XmlDocument xmlDocument
EbicsVersion nVersion
Returns
Type Description
System.Xml.XmlElement

BuildXml(XmlDocument, EbicsVersion)

Creates an OrderDetails element with all its data.

Declaration
public override XmlElement BuildXml(XmlDocument xmlDocument, EbicsVersion nVersion)
Parameters
Type Name Description
System.Xml.XmlDocument xmlDocument
EbicsVersion nVersion
Returns
Type Description
System.Xml.XmlElement
Overrides
Remarks

This always creates a very special OrderDetails element that includes all properties that have been set. This means that the resulting XML is not necessarily a valid EBICS XML document. However, it is guaranteed that ParseXml(XmlElement, EbicsVersion) can always parse back the created XML document with all its properties. Use BuildHVDResponseOrderData(EbicsVersion), BuildHVUOrderDetails(XmlDocument, EbicsVersion), or BuildHVZOrderDetails(XmlDocument, EbicsVersion), in order to create an order details XML for a particular context.

ParseDisplayFile(String)

Parses the display text of an order and adds the parsed data to this instance.

Declaration
public void ParseDisplayFile(string sDisplayFile)
Parameters
Type Name Description
System.String sDisplayFile
Remarks

This method does not completely replace the existing data of this instance, it only adds items that are missing.

See Also

ParseXml(XmlElement, EbicsVersion)

Parses an OrderDetails element from a HVUResponseOrderData, or HVZResponseOrderData, or a complete HVDResponseOrderData reponse document.

Declaration
public override void ParseXml(XmlElement xmlElement, EbicsVersion nVersion)
Parameters
Type Name Description
System.Xml.XmlElement xmlElement
EbicsVersion nVersion
Overrides

Extension Methods