---

balance.h File Reference

HBCI::Balance, HBCI::AccountBalance, and their C wrappers HBCI_Balance, HBCI_AccountBalance. More...

#include <openhbci/date.h>
#include <openhbci/value.h>
#include <string>

Go to the source code of this file.

Namespaces
namespace	HBCI
HBCI_Balance functions
int	HBCI_Balance_isDebit (const HBCI_Balance *b)
	Returns true if the value is a debit (i.e. positive).
const HBCI_Value *	HBCI_Balance_value (const HBCI_Balance *b)
	Returns the value of this balance.
const HBCI_Date *	HBCI_Balance_date (const HBCI_Balance *b)
const HBCI_Time *	HBCI_Balance_time (const HBCI_Balance *b)
HBCI_AccountBalance functions
const char *	HBCI_AccountBalance_currency (const HBCI_AccountBalance *b)
	Returns the ISO-4217 currency string of this account balance.
const HBCI_Balance *	HBCI_AccountBalance_bookedBalance (const HBCI_AccountBalance *b)
	Returns the booked Balance.
const HBCI_Balance *	HBCI_AccountBalance_notedBalance (const HBCI_AccountBalance *b)
	Returns the noted Balance (which is probably more up-to-date than the booked balance).
const HBCI_Value *	HBCI_AccountBalance_bankLine (const HBCI_AccountBalance *b)
	Returns the bank line (limit value) for this account.
const HBCI_Value *	HBCI_AccountBalance_disposable (const HBCI_AccountBalance *b)
	Returns the amount that is still at your disposal in this account.
const HBCI_Value *	HBCI_AccountBalance_disposed (const HBCI_AccountBalance *b)
	Returns the amount that is already disposed.
const HBCI_Date *	HBCI_AccountBalance_date (const HBCI_AccountBalance *b)
const HBCI_Time *	HBCI_AccountBalance_time (const HBCI_AccountBalance *b)
Typedefs
typedef HBCI::Balance	HBCI_Balance
typedef HBCI::AccountBalance	HBCI_AccountBalance

---

Detailed Description

HBCI::Balance, HBCI::AccountBalance, and their C wrappers HBCI_Balance, HBCI_AccountBalance.

---

Typedef Documentation

typedef struct HBCI::AccountBalance HBCI_AccountBalance

typedef struct HBCI::Balance HBCI_Balance

---

Function Documentation

const HBCI_Value* HBCI_AccountBalance_bankLine (  const HBCI_AccountBalance *    b )

Returns the bank line (limit value) for this account. I.e. the money your balance is allowed to go negative.

const HBCI_Balance* HBCI_AccountBalance_bookedBalance (  const HBCI_AccountBalance *    b )

Returns the booked Balance. The booked balance is the balance including all transactions that are booked, i.e. that are "really" executed.

const char* HBCI_AccountBalance_currency (  const HBCI_AccountBalance *    b )

Returns the ISO-4217 currency string of this account balance.

const HBCI_Date* HBCI_AccountBalance_date (  const HBCI_AccountBalance *    b )

Returns the Date when this balance was created.

const HBCI_Value* HBCI_AccountBalance_disposable (  const HBCI_AccountBalance *    b )

Returns the amount that is still at your disposal in this account. If the difference between your current balance (whether noted or booked depends on the conditions of your bank) and the bank line value results in a positive amount, then you have money left at your disposal. (Which is [hopefully] the usual case.)

const HBCI_Value* HBCI_AccountBalance_disposed (  const HBCI_AccountBalance *    b )

Returns the amount that is already disposed. FIXME: exakt meaning still unknown. hmm, we will se when first data arrive, i don't know yet

const HBCI_Balance* HBCI_AccountBalance_notedBalance (  const HBCI_AccountBalance *    b )

Returns the noted Balance (which is probably more up-to-date than the booked balance). The noted balance includes all transactions from the booked, plus those transactions which the bank has noted for execution but are not yet "really" executed.

const HBCI_Time* HBCI_AccountBalance_time (  const HBCI_AccountBalance *    b )

Returns the Time when this balance was created.

const HBCI_Date* HBCI_Balance_date (  const HBCI_Balance *    b )

Returns the Date of this balance. Returns the Date when this balance was valid/computed/fixed.

int HBCI_Balance_isDebit (  const HBCI_Balance *    b )

Returns true if the value is a debit (i.e. positive). If the value of this balance is a debit, then this method returns true. Usually this means that your account has a positive amount of money in it, i.e. the bank owes you money. However, for some account types (which are probably not-so-common for private homebanking), in accountant-speak a "debit" can also mean that you owe money to the bank. Please take the written statements of the bank as a reference: If the bank calls your balance a "debit", then this method returns true -- so eventually the interpretation is up to you.

const HBCI_Time* HBCI_Balance_time (  const HBCI_Balance *    b )

Returns the Time of day of this balance.

const HBCI_Value* HBCI_Balance_value (  const HBCI_Balance *    b )

Returns the value of this balance.

---