Class EbicsOrderCamt

Namespace

Subsembly.EBICS

Assembly

Subsembly.EBICS.Core.dll

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

public class EbicsOrderCamt : EbicsOrder

Inheritance

object

EbicsOrder

EbicsOrderCamt

Derived

EbicsOrderC52

EbicsOrderC53

EbicsOrderC54

EbicsOrderC5N

EbicsOrderSwift

Inherited Members

EbicsOrder.CreateNextOrderID()

EbicsOrder.Service

EbicsOrder.OrderType

EbicsOrder.AdminOrderType

EbicsOrder.Upload

EbicsOrder.TransferType

EbicsOrder.OrderID

EbicsOrder.OrderAttribute

EbicsOrder.OrderParams

EbicsOrder.AdditionalOrderInfo

EbicsOrder.AuthorisationLevel

EbicsOrder.OrderSignatures

EbicsOrder.OrderData

EbicsOrder.TechnicalReturnCode

EbicsOrder.BusinessReturnCode

EbicsOrder.Success

EbicsOrder.NoData

EbicsOrder.SuccessOrNoData

EbicsOrder.ErrorClass

EbicsOrder.Transaction

EbicsOrder.TransactionTraceText

EbicsOrder.TransactionID

EbicsOrder.TransactionState

EbicsOrder.Sign(EbicsContact, IEbicsSecurityMedium)

EbicsOrder.ProcessResponseOrderData(EbicsVersion)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

EbicsOrderCamt(string, DateTime, DateTime)

public EbicsOrderCamt(string sOrderType, DateTime tFrom, DateTime tTo)

Parameters

sOrderType string

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.

tFrom DateTime

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

tTo DateTime

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

See Also

EbicsOrderC52

EbicsOrderC53

EbicsOrderC54

Properties

CamtDocuments

Iterates over all CAMT documents that have been downloaded.

public virtual IEnumerable<EbicsOrderCamtDocument> CamtDocuments { get; }

Property Value

IEnumerable<EbicsOrderCamtDocument>

Methods

CreateOrderC52(string, DateTime)

Creates an EbicsOrder for downlading the CAMT 052 data.

public static EbicsOrderCamt CreateOrderC52(string sOrderType = null, DateTime tFromDate = default)

Parameters

sOrderType string

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.

tFromDate DateTime

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

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 Types	Instantiated Class
C52, Z52	EbicsOrderC52
VMK, ZK4	EbicsOrderVMK

Any other order type will create the default EbicsOrderC52 implementation.

Exceptions

ArgumentException

The parameter sOrderType was not a valid order type string.

CreateOrderC53(string, DateTime, DateTime)

Creates an EbicsOrder for downlading the CAMT 053 data.

public static EbicsOrderCamt CreateOrderC53(string sOrderType = null, DateTime tFromDate = default, DateTime tToDate = default)

Parameters

sOrderType string

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.

tFromDate DateTime

Optional starting date for the statement download request.

tToDate DateTime

Optional ending date for the statement download request.

Returns

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 Types	Instantiated Class
C53, Z53	EbicsOrderC53
STA, ZK3	EbicsOrderSTA

Any other order type will create the default EbicsOrderC53 implementation.

Exceptions

ArgumentException

The parameter sOrderType was not a valid order type string.

CreateOrderC54(string, DateTime)

Creates an EbicsOrder for downlading the CAMT 054 data.

public static EbicsOrderCamt CreateOrderC54(string sOrderType = null, DateTime tFromDate = default)

Parameters

sOrderType string

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.

tFromDate DateTime

Optional starting date for the statement download request.

Returns

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 Types	Instantiated Class
C54, Z54	EbicsOrderC54

Any other order type will create the default EbicsOrderC54 implementation.

Exceptions

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).

public static string[] GetOrderTypesC52()

Returns

string[]

GetOrderTypesC53()

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

public static string[] GetOrderTypesC53()

Returns

string[]

GetOrderTypesC54()

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

public static string[] GetOrderTypesC54()

Returns

string[]

See Also

EbicsOrderC52

EbicsOrderC53

EbicsOrderC54

EbicsOrderSTA

EbicsOrderVMK