Docs For Class AccountTransaction

Class AccountTransaction

Description

abstract:

Located in /AccountTransaction.php (line 18)

ClientObject
   |
   --AccountActivity
      |
      --AccountTransaction

Direct descendents

Class	Description
AssetTransaction
RevenueTransaction

Variable Summary

AccountTransaction $adjustmentTransaction

int $amount

int $balance

String $creatorCode

DateTime $dueDate

String $note

String $sellerCode

String $shiftCode

int $taxAmount

String $terminalCode

Method Summary

AccountTransaction __construct ([int $amount = null], [int $balance = null], [String $note = null], [DateTime $createDate = null], [String $creatorCode = null], [String $sellerCode = null], [String $shiftCode = null], [String $terminalCode = null], [int $taxAmount = null], [DateTime $dueDate = null], [AccountTransaction $adjustmenttransaction = null])

AccountTransaction getAdjustmentTransaction ()

int getAmount ()

int getBalance ()

String getCreatorCode ()

DateTime getDueDate ()

String getNote ()

String getSellerCode ()

String getShiftCode ()

int getTaxAmount ()

String getTerminalCode ()

void setAdjustmentTransaction (AccountTransaction $adjustmentTransaction)

void setAmount (int $amount)

void setBalance (int $balance)

void setCreatorCode (String $creatorCode)

void setDueDate (DateTime $dueDate)

void setNote (String $note)

void setSellerCode (String $sellerCode)

void setShiftCode (String $shiftCode)

void setTaxAmount (int $taxAmount)

void setTerminalCode (String $terminalCode)

Variables

AccountTransaction $adjustmentTransaction (line 66)

var: Reference to a transaction that reversed this transaction. Normally, Invoice or Fee can be reversed with Reversal, Payment or Claim with Void or Decline
access: private

int $amount (line 22)

var: Initial (fixed) amount of the transaction.
access: private

int $balance (line 26)

var: Current balance of the transaction.
access: private

String $creatorCode (line 35)

var: Optional free-hand code, can be used to identify creator of the transaction (usually in external client system).
access: private

DateTime $dueDate (line 60)

var: Date when the transaction becomes effective (applied to CustomerAccount). Before the due date, iBilling's balancing process will not apply any balance on the transaction
access: private

String $note (line 30)

var: Optional text note (description).
access: private

String $sellerCode (line 40)

var: Optional free-hand code, can be used to identify seller associated with the transaction (usually in external client system).
access: private

String $shiftCode (line 45)

var: Optional free-hand code, can be used to identify POS shift that generated this transaction (usually in external client system).
access: private

int $taxAmount (line 54)

var: Amount of the tax (part of amount).
access: protected

String $terminalCode (line 50)

var: Optional free-hand code, can be used to identify POS terminal that generated this transaction (usually in external client system).
access: private

Inherited Variables

Inherited from AccountActivity

AccountActivity::$accountActivityType
AccountActivity::$customerAccount

Inherited from ClientObject

ClientObject::$code
ClientObject::$createDate
ClientObject::$id
ClientObject::$merchantAccountCode
ClientObject::$_hashCode

Methods

Constructor __construct (line 82)

Instantiates a new account transaction.

int $amount: amount the amount
int $balance: balance the balance
String $note: note the note
DateTime $createDate: createDate the create date
String $creatorCode: creatorCode the creator code
String $sellerCode: sellerCode the seller code
String $shiftCode: shiftCode the shift code
String $terminalCode: terminalCode the terminal code
int $taxAmount: taxAmount the tax amount
DateTime $dueDate: dueDate the due date
AccountTransaction $adjustmenttransaction: adjustmenttransaction the adjustmenttransaction

Redefinition of:

AccountActivity::__construct(): Instantiates a new account activity.

Redefined in descendants as:

AssetTransaction::__construct() : Instantiates a new asset transaction.
RevenueTransaction::__construct() : Instantiates a new revenue transaction.

getAdjustmentTransaction (line 246)

Gets the adjustment transaction.

return: the adjustment transaction
access: public

AccountTransaction getAdjustmentTransaction ()

getAmount (line 101)

Gets the amount.

return: Returns the amount
access: public

int getAmount ()

getBalance (line 120)

Gets the balance.

return: Returns the balance
access: public

int getBalance ()

getCreatorCode (line 156)

Gets the creator code.

return: Returns the creatorCode
access: public

String getCreatorCode ()

getDueDate (line 264)

Gets the due date.

return: Returns the dueDate
access: public

DateTime getDueDate ()

getNote (line 138)

Gets the note.

return: Returns the note
access: public

String getNote ()

getSellerCode (line 174)

Gets the seller code.

return: Returns the sellerCode
access: public

String getSellerCode ()

getShiftCode (line 192)

Gets the shift code.

return: Returns the shiftCode
access: public

String getShiftCode ()

getTaxAmount (line 228)

Gets the tax amount.

return: the tax amount
access: public

int getTaxAmount ()

getTerminalCode (line 210)

Gets the terminal code.

return: Returns the terminalCode
access: public

String getTerminalCode ()

setAdjustmentTransaction (line 255)

Sets the adjustment transaction.

void setAdjustmentTransaction (AccountTransaction $adjustmentTransaction)

AccountTransaction $adjustmentTransaction: adjustmentTransaction the new adjustment transaction

setAmount (line 110)

Set a value to amount.

access: public

void setAmount (int $amount)

int $amount: amount the amount

setBalance (line 129)

Set a value to balance.

void setBalance (int $balance)

int $balance: balance the balance

setCreatorCode (line 165)

Set a value to creatorCode.

access: public

void setCreatorCode (String $creatorCode)

String $creatorCode: creatorCode the creator code

setDueDate (line 273)

Set a value to dueDate.

access: public

void setDueDate (DateTime $dueDate)

DateTime $dueDate: dueDate the due date

setNote (line 147)

Set a value to note.

access: public

void setNote (String $note)

String $note: note the note

setSellerCode (line 183)

Set a value to sellerCode.

access: public

void setSellerCode (String $sellerCode)

String $sellerCode: sellerCode the seller code

setShiftCode (line 201)

Set a value to shiftCode.

access: public

void setShiftCode (String $shiftCode)

String $shiftCode: shiftCode the shift code

setTaxAmount (line 237)

Sets the tax amount.

access: public

void setTaxAmount (int $taxAmount)

int $taxAmount: taxAmount the new tax amount

Redefined in descendants as:

AssetTransaction::setTaxAmount()

setTerminalCode (line 219)

Set a value to terminalCode.

access: public

void setTerminalCode (String $terminalCode)

String $terminalCode: terminalCode the terminal code

Inherited Methods

Inherited From AccountActivity

AccountActivity::__construct()
AccountActivity::getAccountActivityType()
AccountActivity::getCustomerAccount()
AccountActivity::setAccountActivityType()
AccountActivity::setCustomerAccount()
AccountActivity::type()

Inherited From ClientObject

ClientObject::getCode()
ClientObject::getCreateDate()
ClientObject::getId()
ClientObject::getMerchantAccountCode()
ClientObject::hashCode()
ClientObject::setCode()
ClientObject::setId()
ClientObject::setMerchantAccountCode()
ClientObject::type()

Documentation generated on Thu, 20 Mar 2008 16:22:07 -0400 by phpDocumentor 1.4.0