Class EbicsOrderCamt

Basic implementation for EBICS orders that return CAMT data, e.g. C52, C53, and C54.

Inheritance
System.Object
EbicsOrder
EbicsOrderCamt
EbicsOrderC52
EbicsOrderC53
EbicsOrderC54
EbicsOrderC5N
EbicsOrderSwift
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.EBICS
Assembly: Subsembly.EBICS.Core.dll
Syntax
public class EbicsOrderCamt : EbicsOrder

Constructors

EbicsOrderCamt(String, DateTime, DateTime)

Declaration
public EbicsOrderCamt(string sOrderType, DateTime tFrom, DateTime tTo)
Parameters
Type Name Description
System.String sOrderType

The EBICS order type, such as C52, C53, or C54. For Switzerland this may be Z52, Z53, or Z54. Or any other order type that downloads a ZIP file with CAMT documents.
System.DateTime tFrom

Start date of the optional date range. If this is DateTime.MinValue, then no date range will be included.
System.DateTime tTo

End date of the optional date range. If this is DateTime.MinValue, then the end date DateTime.Today will be used.
See Also

Properties

CamtDocuments

Iterates over all CAMT documents that have been downloaded.

Declaration
public virtual IEnumerable<EbicsOrderCamtDocument> CamtDocuments { get; }
Property Value
Type Description
System.Collections.Generic.IEnumerable<EbicsOrderCamtDocument>

Methods

CreateOrderC52(String, DateTime)

Creates an EbicsOrder for downlading the CAMT 052 data.

Declaration
public static EbicsOrderCamt CreateOrderC52(string sOrderType = null, DateTime tFromDate = default(DateTime))
Parameters
Type Name Description
System.String sOrderType

The Order Type that shall be used by the Order for downlading the CAMT 052 data. This is used to select the derived EbicsOrderCamt instance and will also be set in the OrderType of the returned instance. If this is null, then the default "C52" order type will be used.
System.DateTime tFromDate

The starting date for downloading the CAMT 052 data. This should be either DateTime.MinValue, in order to get and consume the latest data, or DateTime.Today, in order to repeatedly get the currently pending data.
Returns
Type Description
EbicsOrderCamt

Returns an appropriately derived EbicsOrderCamt instance for downloading CAMT 052 data with the given order type.
Remarks

Currently the following values for sOrderType will create instances of these classes.

Order TypesInstantiated Class
C52, Z52EbicsOrderC52
VMK, ZK4EbicsOrderVMK

Any other order type will create the default EbicsOrderC52 implementation.

Exceptions
Type Condition
System.ArgumentException

The parameter sOrderType was not a valid order type string.

CreateOrderC53(String, DateTime, DateTime)

Creates an EbicsOrder for downlading the CAMT 053 data.

Declaration
public static EbicsOrderCamt CreateOrderC53(string sOrderType = null, DateTime tFromDate = default(DateTime), DateTime tToDate = default(DateTime))
Parameters
Type Name Description
System.String sOrderType

The Order Type that shall be used by the Order for downlading the CAMT 053 data. This is used to select the derived EbicsOrderCamt instance and will also be set in the OrderType of the returned instance. If this is null, then the default "C53" order type will be used.
System.DateTime tFromDate

Optional starting date for the statement download request.
System.DateTime tToDate

Optional ending date for the statement download request.
Returns
Type Description
EbicsOrderCamt

Returns an appropriately derived EbicsOrderCamt instance for downloading CAMT 053 data with the given order type.
Remarks

Currently the following values for sOrderType are allowed and will create instances of these classes.

Order TypesInstantiated Class
C53, Z53EbicsOrderC53
STA, ZK3EbicsOrderSTA

Any other order type will create the default EbicsOrderC53 implementation.

Exceptions
Type Condition
System.ArgumentException

The parameter sOrderType was not a valid order type string.

CreateOrderC54(String, DateTime)

Creates an EbicsOrder for downlading the CAMT 054 data.

Declaration
public static EbicsOrderCamt CreateOrderC54(string sOrderType = null, DateTime tFromDate = default(DateTime))
Parameters
Type Name Description
System.String sOrderType

The Order Type that shall be used by the Order for downlading the CAMT 054 data. This is used to select the derived EbicsOrderCamt instance and will also be set in the OrderType of the returned instance. If this is null, then the default "C54" order type will be used.
System.DateTime tFromDate

Optional starting date for the statement download request.
Returns
Type Description
EbicsOrderCamt

Returns an appropriately derived EbicsOrderCamt instance for downloading CAMT 054 data with the given order type.
Remarks

Currently the following values for sOrderType are allowed and will create instances of these classes.

Order TypesInstantiated Class
C54, Z54EbicsOrderC54

Any other order type will create the default EbicsOrderC54 implementation.

Exceptions
Type Condition
System.ArgumentException

The parameter sOrderType was not a valid order type string.

GetOrderTypesC52()

Gets an array of order types that are supported by CreateOrderC52(String, DateTime).

Declaration
public static string[] GetOrderTypesC52()
Returns
Type Description
System.String[]

GetOrderTypesC53()

Gets an array of order types that are supported by CreateOrderC53(String, DateTime, DateTime).

Declaration
public static string[] GetOrderTypesC53()
Returns
Type Description
System.String[]

GetOrderTypesC54()

Gets an array of order types that are supported by CreateOrderC54(String, DateTime).

Declaration
public static string[] GetOrderTypesC54()
Returns
Type Description
System.String[]

See Also