Class FinAcctMvmtsSpecifiedPeriodBuilder

Builder for account movements inquiries (HKKAZ).

Inheritance
System.Object
FinOrderBuilder
FinAcctMvmtsSpecifiedPeriodBuilder
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.FinTS
Assembly: Subsembly.FinTS.Core.dll
Syntax
public class FinAcctMvmtsSpecifiedPeriodBuilder : FinOrderBuilder
Remarks

The name of this class is based on the FinTS 4.0 XML Tag-name of that same order type, which is <AcctMvmtsSpecifiedPeriod>.

Constructors

FinAcctMvmtsSpecifiedPeriodBuilder(FinContact)

Creates a single account movements inquiry builder for the given bank parameter data.

Declaration
public FinAcctMvmtsSpecifiedPeriodBuilder(FinContact aContact)
Parameters
Type Name Description
FinContact aContact

Contact data of a fully initialised and synchronised contact for which to create the FinAcctMvmtsSpecifiedPeriodBuilder instance.

Properties

AcctMvmtDataCutoff

Number of days that account movement data is stored at the bank.

Declaration
public int AcctMvmtDataCutoff { get; }
Property Value
Type Description
System.Int32

AllAcctAllowed

True if all accounts may be requested in one order.

Declaration
public bool AllAcctAllowed { get; }
Property Value
Type Description
System.Boolean

MaxEntriesAllowed

True if the request parameter MaxEntries may be set.

Declaration
public bool MaxEntriesAllowed { get; }
Property Value
Type Description
System.Boolean

Methods

Build(FinAcct, Boolean, SwiftDate, SwiftDate, Int32, String)

Builds an account movements inquiry request from the given parameters.

Declaration
public FinAcctMvmtsSpecifiedPeriod Build(FinAcct aOrderAcct, bool fAllAcct, SwiftDate aStartDate, SwiftDate aEndDate, int nMaxNoEntries, string sScrollRef)
Parameters
Type Name Description
FinAcct aOrderAcct

The ordering customers account information. This must be specified as a valid ordering customers account, even if the the flag fAllAcct is true. Furthermore, this account must be enabled for account movements inquiry orders.
System.Boolean fAllAcct

Indicates whether the account movements of all accounts of the customer that owns the ordering account shall be returned (true), or whether only the balance of the given ordering account shall be returned. Should always be false.
SwiftDate aStartDate

Optional starting date. Must not be older than today minus AcctMvmtDataCutoff days.
SwiftDate aEndDate

Optional ending date. Must be after or equal to aStartDate (if given).
System.Int32 nMaxNoEntries

Optional max number of entries to return. Must only be specified when MaxEntriesAllowed is true. Must be zero, otherwise.
System.String sScrollRef

Optional scroll reference from a previous inquiry.
Returns
Type Description
FinAcctMvmtsSpecifiedPeriod

Initialised instance of FinAcctMvmtsSpecifiedPeriod that is ready to be executed.
Exceptions
Type Condition
System.InvalidOperationException

Thrown if the bank does not support this order type.
See Also

Build(FinAcct, DateTime, DateTime)

Builds an account movements inquiry request from the given parameters.

Declaration
public FinAcctMvmtsSpecifiedPeriod Build(FinAcct aOrderAcct, DateTime tStartDate, DateTime tEndDate)
Parameters
Type Name Description
FinAcct aOrderAcct
System.DateTime tStartDate

Optional starting date. Should not be older than today minus AcctMvmtDataCutoff days, and should not be a future date. Use the value DateTime.MinValue to omit a starting date from the order. The date given will be converted to a German date using ConvertToGermanTime(DateTime) to ensure that it matches the time zone of the server.
System.DateTime tEndDate

Optional ending date. Should be after or equal to tStartDate (if given). This should not be a future date. Use the value DateTime.MinValue to omit an ending date from the order and thus retrieve all current and future statement entries. The date given will be converted to a German date using ConvertToGermanTime(DateTime) to ensure that it matches the time zone of the server.
Returns
Type Description
FinAcctMvmtsSpecifiedPeriod
Exceptions
Type Condition
System.InvalidOperationException

Thrown if the bank does not support this order type.
System.ArgumentNullException

Thrown if the parameter aOrderAcct is null.