Class FinAcctMvmtsSpecifiedPeriodBuilder

Namespace
Subsembly.FinTS
Assembly
Subsembly.FinTS.Core.dll

Builder for account movements inquiries (HKKAZ).

public class FinAcctMvmtsSpecifiedPeriodBuilder : FinOrderBuilder
Inheritance
FinAcctMvmtsSpecifiedPeriodBuilder
Inherited Members

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.

public FinAcctMvmtsSpecifiedPeriodBuilder(FinContact aContact)

Parameters

aContact FinContact

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.

public int AcctMvmtDataCutoff { get; }

Property Value

int

AllAcctAllowed

True if all accounts may be requested in one order.

public bool AllAcctAllowed { get; }

Property Value

bool

MaxEntriesAllowed

True if the request parameter MaxEntries may be set.

public bool MaxEntriesAllowed { get; }

Property Value

bool

Methods

Build(FinAcct, bool, SwiftDate, SwiftDate, int, string)

Builds an account movements inquiry request from the given parameters.

public FinAcctMvmtsSpecifiedPeriod Build(FinAcct aOrderAcct, bool fAllAcct, SwiftDate aStartDate, SwiftDate aEndDate, int nMaxNoEntries, string sScrollRef)

Parameters

aOrderAcct FinAcct

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.

fAllAcct bool

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.

aStartDate SwiftDate

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

aEndDate SwiftDate

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

nMaxNoEntries int

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

sScrollRef string

Optional scroll reference from a previous inquiry.

Returns

FinAcctMvmtsSpecifiedPeriod

Initialised instance of FinAcctMvmtsSpecifiedPeriod that is ready to be executed.

Exceptions

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.

public FinAcctMvmtsSpecifiedPeriod Build(FinAcct aOrderAcct, DateTime tStartDate, DateTime tEndDate)

Parameters

aOrderAcct FinAcct
tStartDate DateTime

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.

tEndDate DateTime

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

FinAcctMvmtsSpecifiedPeriod

Exceptions

InvalidOperationException

Thrown if the bank does not support this order type.

ArgumentNullException

Thrown if the parameter aOrderAcct is null.