Class FinSepaStoBuilder

Base class for all builders for creating, modifying, and deleting plain and instant SEPA standing orders.

Inheritance
object
FinOrderBuilder
FinSepaOrderBuilder
FinSepaStoBuilder
FinSepaCancelStoBuilder
FinSepaModifyInstPaymtStoBuilder
FinSepaModifyStoBuilder
FinSepaSetupInstPaymtStoBuilder
FinSepaSetupStoBuilder
Inherited Members
Namespace: Subsembly.FinTS
Assembly: Subsembly.FinTS.Core.dll
Syntax
public abstract class FinSepaStoBuilder : FinSepaOrderBuilder
Remarks

The set up a standing order, the base class Build methods cannot be used. Instead one of the Build methods of this class must be used.

Constructors

FinSepaStoBuilder(FinContact)

Declaration
protected FinSepaStoBuilder(FinContact aContact)
Parameters
Type Name Description
FinContact aContact

Properties

AmtModifiable

Declaration
public bool AmtModifiable { get; }
Property Value
Type Description
bool

ExecDayModifiable

Declaration
public bool ExecDayModifiable { get; }
Property Value
Type Description
bool

ExecTimeModifiable

Declaration
public bool ExecTimeModifiable { get; }
Property Value
Type Description
bool

FirstScheduledDateMod

Declaration
public bool FirstScheduledDateMod { get; }
Property Value
Type Description
bool

LastScheduledDateModif

Declaration
public bool LastScheduledDateModif { get; }
Property Value
Type Description
bool

MaxScheduledModifications

Max number of scheduled modifications. May be zero if no scheduling of modifications is supported.

Declaration
public int MaxScheduledModifications { get; }
Property Value
Type Description
int

MonthDaysAvailable

Allowed execution days of a month.

Declaration
public string MonthDaysAvailable { get; }
Property Value
Type Description
string
Remarks

The return value is a string of digits, two digits for each allowed execution day. The values "97", "98", and "99" indicate ultimo minus two, ultimo minus one, and ultimo. The value "31" is not allowed and is returned as "99" instead. For example, the string "011015202599" indicates that execution is alowed on the first, 10th, 15th, 20th, 25th and on the last day of a month.

The value is null, if this parameter is not applicable to the derived builder type.

OrderDataRequired

If true then the complete original order data must be submitted with the request.

Declaration
public bool OrderDataRequired { get; }
Property Value
Type Description
bool

PayeeAcctModifiable

Declaration
public bool PayeeAcctModifiable { get; }
Property Value
Type Description
bool

PayeeNameModifiable

Declaration
public bool PayeeNameModifiable { get; }
Property Value
Type Description
bool

PaymtPurposeModifiable

Declaration
public bool PaymtPurposeModifiable { get; }
Property Value
Type Description
bool

PeriodLenInMonths

Allowed monthly periods.

Declaration
public string PeriodLenInMonths { get; }
Property Value
Type Description
string
Remarks

The return value is a string of digits, two digits for each allowed period length. For example, the string "01030612" indicates that a a period of one, three, six or twelve months is allowed.

The value is null, if this parameter is not applicable to the derived builder type.

PeriodLenInWeeks

Allowed weekly periods.

Declaration
public string PeriodLenInWeeks { get; }
Property Value
Type Description
string

PeriodLenModifiable

Declaration
public bool PeriodLenModifiable { get; }
Property Value
Type Description
bool

PostdatedCancelPossible

Declaration
public bool PostdatedCancelPossible { get; }
Property Value
Type Description
bool

ScheduledDateSupported

Is it allowed to set a scheduled date in the order segment?

Declaration
public bool ScheduledDateSupported { get; }
Property Value
Type Description
bool

TimeUnitModifiable

Declaration
public bool TimeUnitModifiable { get; }
Property Value
Type Description
bool

WeekDaysAvailable

Allowed execution days of a week.

Declaration
public string WeekDaysAvailable { get; }
Property Value
Type Description
string

Methods

Build(FinAcct, SepaDocument, FinStoDetails)

Builds a SEPA standing order from the given SEPA document and details about the execution frequency.

Declaration
public FinSepaOrder Build(FinAcct aOrderAcct, SepaDocument aSepaDoc, FinStoDetails aDetails)
Parameters
Type Name Description
FinAcct aOrderAcct
SepaDocument aSepaDoc
FinStoDetails aDetails
Returns
Type Description
FinSepaOrder

Build(FinSepaSto)

Builds a SEPA standing order from the given SEPA standing order data.

Declaration
public FinSepaOrder Build(FinSepaSto aSepaSto)
Parameters
Type Name Description
FinSepaSto aSepaSto

This must be a FinSepaSto instance with the standing order data to build the order from. This must not be null.
Returns
Type Description
FinSepaOrder

The completely built and ready to execute FinSepaOrder.

GetPreferredExecTime(SwiftDate, SwiftTime)

Get the nearest preferred execution time after a given desired execution time.

Declaration
public SwiftTime GetPreferredExecTime(SwiftDate tExecDate, SwiftTime tExecTime)
Parameters
Type Name Description
SwiftDate tExecDate
SwiftTime tExecTime
Returns
Type Description
SwiftTime