Class FinCamtStatementBuilder

Builder for an account statement inquiry using CAMT 052 format (HKCAZ).

Inheritance
System.Object
FinOrderBuilder
FinCamtStatementBuilder
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 FinCamtStatementBuilder : FinOrderBuilder

Constructors

FinCamtStatementBuilder(FinContact)

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

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

Contact data of a fully initialised and synchronised contact for which to create the FinCamtStatementBuilder 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

SupportedCamtFormats

Array of supported CAMT formats. This is never null and should never be empty.

Declaration
public string[] SupportedCamtFormats { get; }
Property Value
Type Description
System.String[]

Methods

Build(FinAcct, SwiftDate, SwiftDate)

Builds a CAMT statement inquiry request from the given parameters.

Declaration
public FinCamtStatement Build(FinAcct aOrderAcct, SwiftDate aStartDate, SwiftDate aEndDate)
Parameters
Type Name Description
FinAcct aOrderAcct

The ordering customers account information. This must be specified as a valid ordering customers account.
SwiftDate aStartDate

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

Optional ending date. Must be after or equal to aStartDate (if given).
Returns
Type Description
FinCamtStatement

Initialised instance of FinCamtStatement 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 a CAMT statement inquiry request from the given parameters.

Declaration
public FinCamtStatement 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
FinCamtStatement

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

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

Thrown if the parameter aOrderAcct is null.