Class EbicsOrderDetails

Namespace
Subsembly.EBICS
Assembly
Subsembly.EBICS.Core.dll

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

public class EbicsOrderDetails : EbicsElement
Inheritance
EbicsOrderDetails
Inherited Members
Extension Methods

Remarks

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

Constructors

EbicsOrderDetails() 

public EbicsOrderDetails()

Properties

AcctNoCheckSum

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

public string AcctNoCheckSum { get; set; }

Property Value

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.

public string AdditionalOrderInfo { get; set; }

Property Value

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

public string BankCodeCheckSum { get; set; }

Property Value

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.

public string BatchReference { get; set; }

Property Value

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.

public string Currency { get; set; }

Property Value

string

Remarks

A Currency element appears in the HVZPaymentOrderDetailsStructure of the HVZResponseOrderData.

DataDigest

The hash value of the order data.

public EbicsDataBuffer DataDigest { get; set; }

Property Value

EbicsDataBuffer

Remarks

A DataDigest element appears in HVZResponseOrderData and HVDResponseOrderData.

DisplayFile

The display file data.

public string DisplayFile { get; set; }

Property Value

string

Remarks

A DisplayFile element appears in HVDResponseOrderData.

FirstOrderAccountInfo

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

public EbicsAccountInfo FirstOrderAccountInfo { get; set; }

Property Value

EbicsAccountInfo

FirstOrderPartyInfo

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

public string FirstOrderPartyInfo { get; set; }

Property Value

string

NumSigDone

The number of signatures already given for this order.

public int NumSigDone { get; set; }

Property Value

int

Remarks

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

NumSigRequired

The total number of signatures required for this order.

public int NumSigRequired { get; set; }

Property Value

int

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.

public bool OrderDataAvailable { get; set; }

Property Value

bool

Remarks

A OrderDataAvailable flag appears in HVZResponseOrderData and HVDResponseOrderData.

OrderDataSize

The uncompressed order data size.

public int OrderDataSize { get; set; }

Property Value

int

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.

public bool OrderDetailsAvailable { get; set; }

Property Value

bool

Remarks

A OrderDetailsAvailable flag appears in HVZResponseOrderData and HVDResponseOrderData.

OrderID

The order number.

public string OrderID { get; set; }

Property Value

string

Remarks

An OrderID element appears in HVUResponseOrderData and HVZResponseOrderData.

OrderType

The order type.

public string OrderType { get; set; }

Property Value

string

Remarks

An OrderType element appears in HVUResponseOrderData and HVZResponseOrderData.

Ebics-Version < 3.0

OriginatorInfo

Information about the originator of this order.

public EbicsHVSignerInfo OriginatorInfo { get; set; }

Property Value

EbicsHVSignerInfo

Remarks

An OriginatorInfo element appears in HVUResponseOrderData and HVZResponseOrderData.

ReadyToBeSigned

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

public bool ReadyToBeSigned { get; set; }

Property Value

bool

Remarks

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

ScheduledDate

The scheduled date of the order.

public DateTime ScheduledDate { get; set; }

Property Value

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

public EbicsService Service { get; set; }

Property Value

EbicsService

Remarks

Replaces OrderType with Ebics-Version 3.0.

SignatureVersion

The signature version of the DataDigest.

public EbicsSecurityCode SignatureVersion { get; set; }

Property Value

EbicsSecurityCode

Remarks

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

SignerInfos

The collection of signer infos.

public EbicsHVSignerInfos SignerInfos { get; }

Property Value

EbicsHVSignerInfos

Remarks

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

SigningInfo

Indicates whether a SigningInfo EBICS XML element is present.

public bool SigningInfo { get; set; }

Property Value

bool

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.

public string Title { get; set; }

Property Value

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.

public decimal TotalAmount { get; set; }

Property Value

decimal

Remarks

A TotalAmount element appears in the HVZPaymentOrderDetailsStructure of the HVZResponseOrderData.

TotalOrders

The total number of payments in this order.

public int TotalOrders { get; set; }

Property Value

int

Remarks

A TotalOrders element appears in the HVZPaymentOrderDetailsStructure of the HVZResponseOrderData.

Methods

AugmentOrderDetails(EbicsOrderDetails)

Add additional properties of another EbicsOrderDetails to these order details.

public void AugmentOrderDetails(EbicsOrderDetails aOrderDetails)

Parameters

aOrderDetails EbicsOrderDetails

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

ArgumentNullException

The parameter was null.

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.

public XmlDocument BuildHVDResponseOrderData(EbicsVersion nVersion)

Parameters

nVersion EbicsVersion

Returns

XmlDocument

BuildHVUOrderDetails(XmlDocument, EbicsVersion) 

public XmlElement BuildHVUOrderDetails(XmlDocument xmlDocument, EbicsVersion nVersion)

Parameters

xmlDocument XmlDocument
nVersion EbicsVersion

Returns

XmlElement

BuildHVZOrderDetails(XmlDocument, EbicsVersion) 

public XmlElement BuildHVZOrderDetails(XmlDocument xmlDocument, EbicsVersion nVersion)

Parameters

xmlDocument XmlDocument
nVersion EbicsVersion

Returns

XmlElement

BuildXml(XmlDocument, EbicsVersion)

Creates an OrderDetails element with all its data.

public override XmlElement BuildXml(XmlDocument xmlDocument, EbicsVersion nVersion)

Parameters

xmlDocument XmlDocument
nVersion EbicsVersion

Returns

XmlElement

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.

public void ParseDisplayFile(string sDisplayFile)

Parameters

sDisplayFile string

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.

public override void ParseXml(XmlElement xmlElement, EbicsVersion nVersion)

Parameters

xmlElement XmlElement
nVersion EbicsVersion