Class DtazvBuilder

Simple utility class for easy building of German DTA files and records.

Inheritance
object
DtazvBase
DtazvBuilder
Inherited Members
Namespace: Subsembly.Dtazv
Assembly: Subsembly.Sepa.dll
Syntax
public class DtazvBuilder : DtazvBase

Constructors

DtazvBuilder(int)

Contructs a DtazvBuilder instance with a suggested initial capacity.

Declaration
public DtazvBuilder(int nCapacity)
Parameters
Type Name Description
int nCapacity

The suggested initial capacity. This should be chosen according to the expected resulting data size.
Exceptions
Type Condition
ArgumentOutOfRangeException

The parameter nCapacity is less than zero.

Properties

Size

Provides the byte size of the DTA data collected so far.

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

Methods

AppendRecordQ(string, string, DtazvNameAndAddress, DateTime, int, DateTime)

Appends a complete DTAZV record Q to this DTA data buffer.

Declaration
public void AppendRecordQ(string sBankCode, string sCustomerNumber, DtazvNameAndAddress aInitiator, DateTime tBuildDate, int nDailySeqNo, DateTime tScheduleDate)
Parameters
Type Name Description
string sBankCode

The bank code of the bank that shall receive the DTAZV.
string sCustomerNumber

The customer number, usually the 10 digit account number of the ordering customer account.
DtazvNameAndAddress aInitiator

The name of the initiator of this DTAZV order, perhaps including the address in additional lines. This must not be null or an empty string.
DateTime tBuildDate
int nDailySeqNo
DateTime tScheduleDate
Exceptions
Type Condition
ArgumentNullException

The parameter aOrderingCustAcct or sOrderingCustName was null.
ArgumentException

The parameter sOrderingCustName was an empty string, or a required property of the given aOrderingCustAcct was not set.

AppendRecordT(SepaCreditTransferPaymentInformation, SepaCreditTransferTransactionInformation)

Appends a complete DTAZV record T for a simple international remittance.

Declaration
public void AppendRecordT(SepaCreditTransferPaymentInformation aPmtInf, SepaCreditTransferTransactionInformation aTxInf)
Parameters
Type Name Description
SepaCreditTransferPaymentInformation aPmtInf
SepaCreditTransferTransactionInformation aTxInf

AppendRecordZ()

Adds the final DTAZV record Z.

Declaration
public void AppendRecordZ()
Remarks

The required check values are taken from the current values of the properties TotalValue and TotalCount.

GenerateDTAZV(SepaDocument, string, string)

Generates a complete DTAZV from a SEPA PAIN 001 document.

Declaration
public static DtazvBuilder GenerateDTAZV(SepaDocument aSepaDoc, string sBankCode, string sCustomerNumber)
Parameters
Type Name Description
SepaDocument aSepaDoc

The SEPA PAIN 001 document.
string sBankCode

The bank code of the bank that shall receive the DTAZV.
string sCustomerNumber

The customer number, usually the 10 digit account number of the ordering customer account.
Returns
Type Description
DtazvBuilder

A new DtazvBuilder instance that holds the complete DTAZV including a header record Q, a remittance record T for each payment, and a final record Z.
Exceptions
Type Condition
ArgumentNullException

The parameter aSepaDoc was null.
ArgumentException

The given SEPA document was not a CreditTransferPaymentInitiation.

  • or - The SEPA document did not contain any payments.

ToBytes()

Convert the collected DTA data to a byte array.

Declaration
public byte[] ToBytes()
Returns
Type Description
byte[]

This method returns the complete collected data as a DTA conforming byte array.

ToString()

Declaration
public override string ToString()
Returns
Type Description
string
Overrides