AB_Transaction (public)

This page describes the properties of AB_TRANSACTION This type contains all important information about transactions. All text fields are in UTF-8.

Local Account Info

This group contains information about the local account.

LocalCountry

This is the two-character country code according to ISO 3166-1 (Alpha-2). This is also used in DNS toplevel domain names. For Germany use "DE" (not case-sensitive).

Set this property with AB_Transaction_SetLocalCountry, get it with AB_Transaction_GetLocalCountry

LocalBankCode

This is the code of the local bank (i.e.

your

bank).

Set this property with AB_Transaction_SetLocalBankCode, get it with AB_Transaction_GetLocalBankCode

LocalBranchId

This is the branch id of the local bank (OFX only)

Set this property with AB_Transaction_SetLocalBranchId, get it with AB_Transaction_GetLocalBranchId

LocalAccountNumber

Set this property with AB_Transaction_SetLocalAccountNumber, get it with AB_Transaction_GetLocalAccountNumber

LocalSuffix

If your account has subaccounts which are distinguished by different suffixes, then this is that suffix. Otherwise it's empty. (HBCI only)

Set this property with AB_Transaction_SetLocalSuffix, get it with AB_Transaction_GetLocalSuffix

LocalIban

International Bank Account Number according to ECBS EBS 204.

Pos Meaning
0-1 Country code according to ISO 3166
2-3 Checksum
4-33 Country specific account info

Examples:

Set this property with AB_Transaction_SetLocalIban, get it with AB_Transaction_GetLocalIban

LocalName

Set this property with AB_Transaction_SetLocalName, get it with AB_Transaction_GetLocalName

Remote Account Info

This group contains information about the remote account.

RemoteCountry

This is the two-character ISO country code (as used in toplevel domains). For Germany use "DE".

Set this property with AB_Transaction_SetRemoteCountry, get it with AB_Transaction_GetRemoteCountry

RemoteBankName

Set this property with AB_Transaction_SetRemoteBankName, get it with AB_Transaction_GetRemoteBankName

RemoteBankLocation

Set this property with AB_Transaction_SetRemoteBankLocation, get it with AB_Transaction_GetRemoteBankLocation

RemoteBankCode

Set this property with AB_Transaction_SetRemoteBankCode, get it with AB_Transaction_GetRemoteBankCode

RemoteBranchId

This is the branch id of the remote bank (OFX only)

Set this property with AB_Transaction_SetRemoteBranchId, get it with AB_Transaction_GetRemoteBranchId

RemoteAccountNumber

Set this property with AB_Transaction_SetRemoteAccountNumber, get it with AB_Transaction_GetRemoteAccountNumber

RemoteSuffix

Set this property with AB_Transaction_SetRemoteSuffix, get it with AB_Transaction_GetRemoteSuffix

RemoteIban

International Bank Account Number according to ECBS EBS 204.

Pos Meaning
0-1 Country code according to ISO 3166
2-3 Checksum
4-33 Country specific account info

Examples:

Set this property with AB_Transaction_SetRemoteIban, get it with AB_Transaction_GetRemoteIban

RemoteName

Set this property with AB_Transaction_SetRemoteName, get it with AB_Transaction_GetRemoteName

UniqueId

This is a unique id assigned by the application. However, when adding a transaction to a job (like JobTransfer) this id is assigned by AqBanking to make sure that this id is unique across all applications.

Set this property with AB_Transaction_SetUniqueId, get it with AB_Transaction_GetUniqueId

Dates

ValutaDate

The date when the transaction was really executed (Datum Valuta/Wertstellung)

Set this property with AB_Transaction_SetValutaDate, get it with AB_Transaction_GetValutaDate

Date

The date when the transaction was booked (but sometimes it is unused). (Buchungsdatum)

Set this property with AB_Transaction_SetDate, get it with AB_Transaction_GetDate

Value

Value

Set this property with AB_Transaction_SetValue, get it with AB_Transaction_GetValue

Fees

Set this property with AB_Transaction_SetFees, get it with AB_Transaction_GetFees

Info Which Is Not Supported by All Backends

This group contains information which differ between backends.

Some of this information might not even be supported by every backends.

TextKey

A numerical transaction code, defined for all kinds of different actions. (Textschluessel)

For a normal transfer you should set it to 51. For debit notes the values 04 or 05 may be used. For other values please refer to your credit institute. (HBCI only)

Set this property with AB_Transaction_SetTextKey, get it with AB_Transaction_GetTextKey

TransactionKey

this is the transaction id that tells you more about the type of transaction (3 character code) (Buchungsschluessel) (HBCI only)

Set this property with AB_Transaction_SetTransactionKey, get it with AB_Transaction_GetTransactionKey

CustomerReference

Reference string, if the customer (you) has specified one. (E.g. the cheque number.) Otherwise "NONREF" or empty (Kundenreferenz)

Set this property with AB_Transaction_SetCustomerReference, get it with AB_Transaction_GetCustomerReference

BankReference

Reference string for this transaction given by the bank, if it has given one. Otherwise empty. (Bankreferenz)

Set this property with AB_Transaction_SetBankReference, get it with AB_Transaction_GetBankReference

TransactionCode

A 3 digit numerical transaction code, defined for all kinds of different actions. (Geschaeftsvorfallcode)

Set this property with AB_Transaction_SetTransactionCode, get it with AB_Transaction_GetTransactionCode

TransactionText

Transaction text (e.g. STANDING ORDER) (Buchungstext)

Set this property with AB_Transaction_SetTransactionText, get it with AB_Transaction_GetTransactionText

Primanota

Set this property with AB_Transaction_SetPrimanota, get it with AB_Transaction_GetPrimanota

FiId

This is an id optionally assigned by the Financial Institute. It is mostly used by OFX.

Set this property with AB_Transaction_SetFiId, get it with AB_Transaction_GetFiId

Purpose

This string list contains the purpose of the transaction. Every entry of this list represents a single purpose line.

Set this property with AB_Transaction_SetPurpose, get it with AB_Transaction_GetPurpose

Category

This string list contains the categories this transaction belongs to. This element is not used by AqBanking itself but some im/exporter plugins may choose to use these.

Set this property with AB_Transaction_SetCategory, get it with AB_Transaction_GetCategory

Additional Information for Standing Orders

This group contains information which is used with standing orders. It is not needed for other usage of this type.

Period

This variable contains the execution period (e.g. whether a standing order is to be executed weekly or monthly etc).

Set this property with AB_Transaction_SetPeriod, get it with AB_Transaction_GetPeriod

Cycle

The standing order is executed every

cycle

x

period

. So if

period

is

weekly

and

cycle

is

2

then the standing order is executed every 2 weeks.

Set this property with AB_Transaction_SetCycle, get it with AB_Transaction_GetCycle

ExecutionDay

The execution day. The meaning of this variable depends on the content of

period

:

Set this property with AB_Transaction_SetExecutionDay, get it with AB_Transaction_GetExecutionDay

FirstExecutionDate

The date when the standing order is to be executed for the first time.

Set this property with AB_Transaction_SetFirstExecutionDate, get it with AB_Transaction_GetFirstExecutionDate

LastExecutionDate

The date when the standing order is to be executed for the last time.

Set this property with AB_Transaction_SetLastExecutionDate, get it with AB_Transaction_GetLastExecutionDate

NextExecutionDate

The date when the standing order is to be executed next (this field is only interesting when retrieving the list of currently active standing orders)

Set this property with AB_Transaction_SetNextExecutionDate, get it with AB_Transaction_GetNextExecutionDate

Additional Information for Transfers

This group contains information which is used with all kinds of transfers. It is setup by the function AB_Banking_GatherResponses for transfers but not used by AqBanking otherwise.

Type

This variable contains the type of transfer (transfer, debit note etc).

Set this property with AB_Transaction_SetType, get it with AB_Transaction_GetType

SubType

This variable contains the sub-type of transfer.

Set this property with AB_Transaction_SetSubType, get it with AB_Transaction_GetSubType

Status

This variable contains the status of the transfer (accepted, rejected, pending). etc).

Set this property with AB_Transaction_SetStatus, get it with AB_Transaction_GetStatus

Charge

Specify who is to be charged for the transaction.

Set this property with AB_Transaction_SetCharge, get it with AB_Transaction_GetCharge

Additional Information for Foreign Transfers

This group contains information which is used with transfers to other countries in the world. It is used by backends and applications but not by AqBanking itself.

RemoteAddrStreet

Set this property with AB_Transaction_SetRemoteAddrStreet, get it with AB_Transaction_GetRemoteAddrStreet

RemoteAddrZipcode

Set this property with AB_Transaction_SetRemoteAddrZipcode, get it with AB_Transaction_GetRemoteAddrZipcode

RemoteAddrCity

Set this property with AB_Transaction_SetRemoteAddrCity, get it with AB_Transaction_GetRemoteAddrCity

RemotePhone

Set this property with AB_Transaction_SetRemotePhone, get it with AB_Transaction_GetRemotePhone

Additional Information for Investment Transfers

This group contains information which is used with investment/stock transfers. It is used by backends and applications but not by AqBanking itself.

UnitId

Set this property with AB_Transaction_SetUnitId, get it with AB_Transaction_GetUnitId

UnitIdNameSpace

Set this property with AB_Transaction_SetUnitIdNameSpace, get it with AB_Transaction_GetUnitIdNameSpace

Units

Set this property with AB_Transaction_SetUnits, get it with AB_Transaction_GetUnits

UnitPrice

Set this property with AB_Transaction_SetUnitPrice, get it with AB_Transaction_GetUnitPrice

Commission

Set this property with AB_Transaction_SetCommission, get it with AB_Transaction_GetCommission


Generated on Sun Jun 22 00:25:13 2008 for aqbanking by  doxygen 1.5.6