ibilling.client
Class AccountTransaction

java.lang.Object
  ibilling.client.ClientObject
      ibilling.client.AccountActivity
          ibilling.client.AccountTransaction

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

AssetTransaction, RevenueTransaction

public abstract class AccountTransaction
extends AccountActivity

Represents financial transaction posted to CustomerAccount. All financial transaction have fixed amount, carry balance and affect CustomerAccount's overall balance. Examples of AccountTransaction are payment, invoice, credit, refund.

Invoice, Void and Refund - increase CustomerAccount balance
Payment, Credit and Reversal - decrease CustomerAccount balance

Since:

1.0

See Also:

Serialized Form

Field Summary

private AccountTransaction	adjustmentTransaction Reference to a transaction that reversed this transaction.
private java.lang.Integer	amount Initial (fixed) amount of the transaction.
private java.lang.Integer	balance Current balance of the transaction.
private java.lang.String	creatorCode Optional free-hand code, can be used to identify creator of the transaction (usually in external client system).
private java.util.Date	dueDate Date when the transaction becomes effective (applied to CustomerAccount).
private java.lang.String	note Optional text note (description).
private java.lang.String	sellerCode Optional free-hand code, can be used to identify seller associated with the transaction (usually in external client system).
private static long	serialVersionUID The Constant serialVersionUID.
private java.lang.String	shiftCode Optional free-hand code, can be used to identify POS shift that generated this transaction (usually in external client system).
private java.lang.Integer	taxAmount Amount of the tax (part of amount).
private java.lang.String	terminalCode Optional free-hand code, can be used to identify POS terminal that generated this transaction (usually in external client system).

Constructor Summary

AccountTransaction()
Instantiates a new account transaction.

AccountTransaction(java.lang.Integer amount, java.lang.Integer balance, java.lang.String note, java.util.Date createDate, java.lang.String creatorCode, java.lang.String sellerCode, java.lang.String shiftCode, java.lang.String terminalCode, java.lang.Integer taxAmount, java.util.Date dueDate, AccountTransaction adjustmentTransaction)
Instantiates a new account transaction.

Method Summary

AccountTransaction	getAdjustmentTransaction() Gets the adjustment transaction.
java.lang.Integer	getAmount() Gets the amount.
java.lang.Integer	getBalance() Gets the balance.
java.lang.String	getCreatorCode() Gets the creator code.
java.util.Date	getDueDate() Gets the due date.
java.lang.String	getNote() Gets the note.
java.lang.String	getSellerCode() Gets the seller code.
java.lang.String	getShiftCode() Gets the shift code.
java.lang.Integer	getTaxAmount() Gets the tax amount.
java.lang.String	getTerminalCode() Gets the terminal code.
(package private) void	setAdjustmentTransaction(AccountTransaction adjustmentTransaction) Sets the adjustment transaction.
void	setAmount(java.lang.Integer amount) Set a value to amount.
(package private) void	setBalance(java.lang.Integer balance) Set a value to balance.
void	setCreatorCode(java.lang.String creatorCode) Set a value to creatorCode.
void	setDueDate(java.util.Date dueDate) Set a value to dueDate.
void	setNote(java.lang.String note) Set a value to note.
void	setSellerCode(java.lang.String sellerCode) Set a value to sellerCode.
void	setShiftCode(java.lang.String shiftCode) Set a value to shiftCode.
void	setTaxAmount(java.lang.Integer taxAmount) Sets the tax amount.
void	setTerminalCode(java.lang.String terminalCode) Set a value to terminalCode.

Methods inherited from class ibilling.client.AccountActivity

getAccountActivityType, getCustomerAccount, setAccountActivityType, setCustomerAccount, type

Methods inherited from class ibilling.client.ClientObject

getClientProperty, getCode, getCreateDate, getId, getMerchantAccountCode, getRefId, hasClientProperty, setClientProperty, setCode, setCreateDate, setId, setMerchantAccountCode, setRefId

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

serialVersionUID

private static final long serialVersionUID

The Constant serialVersionUID.

See Also:

Constant Field Values

amount

private java.lang.Integer amount

Initial (fixed) amount of the transaction.

balance

private java.lang.Integer balance

Current balance of the transaction.

note

private java.lang.String note

Optional text note (description).

creatorCode

private java.lang.String creatorCode

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

sellerCode

private java.lang.String sellerCode

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

shiftCode

private java.lang.String shiftCode

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

terminalCode

private java.lang.String terminalCode

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

taxAmount

private java.lang.Integer taxAmount

Amount of the tax (part of amount).

dueDate

private java.util.Date dueDate

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

adjustmentTransaction

private AccountTransaction adjustmentTransaction

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

Constructor Detail

AccountTransaction

AccountTransaction()

Instantiates a new account transaction.

AccountTransaction

AccountTransaction(java.lang.Integer amount,
                   java.lang.Integer balance,
                   java.lang.String note,
                   java.util.Date createDate,
                   java.lang.String creatorCode,
                   java.lang.String sellerCode,
                   java.lang.String shiftCode,
                   java.lang.String terminalCode,
                   java.lang.Integer taxAmount,
                   java.util.Date dueDate,
                   AccountTransaction adjustmentTransaction)

Instantiates a new account transaction.

Parameters:

amount - the amount

balance - the balance

note - the note

createDate - the create date

creatorCode - the creator code

sellerCode - the seller code

shiftCode - the shift code

terminalCode - the terminal code

taxAmount - the tax amount

dueDate - the due date

adjustmentTransaction - the adjustment transaction

Method Detail

getAmount

public java.lang.Integer getAmount()

Gets the amount.

Returns:

Returns the amount

setAmount

public void setAmount(java.lang.Integer amount)

Set a value to amount.

Parameters:

amount - the amount

getBalance

public java.lang.Integer getBalance()

Gets the balance.

Returns:

Returns the balance

setBalance

void setBalance(java.lang.Integer balance)

Set a value to balance.

Parameters:

balance - the balance

getNote

public java.lang.String getNote()

Gets the note.

Returns:

Returns the note

setNote

public void setNote(java.lang.String note)

Set a value to note.

Parameters:

note - the note

getCreatorCode

public java.lang.String getCreatorCode()

Gets the creator code.

Returns:

Returns the creatorCode

setCreatorCode

public void setCreatorCode(java.lang.String creatorCode)

Set a value to creatorCode.

Parameters:

creatorCode - the creator code

getSellerCode

public java.lang.String getSellerCode()

Gets the seller code.

Returns:

Returns the sellerCode

setSellerCode

public void setSellerCode(java.lang.String sellerCode)

Set a value to sellerCode.

Parameters:

sellerCode - the seller code

getShiftCode

public java.lang.String getShiftCode()

Gets the shift code.

Returns:

Returns the shiftCode

setShiftCode

public void setShiftCode(java.lang.String shiftCode)

Set a value to shiftCode.

Parameters:

shiftCode - the shift code

getTerminalCode

public java.lang.String getTerminalCode()

Gets the terminal code.

Returns:

Returns the terminalCode

setTerminalCode

public void setTerminalCode(java.lang.String terminalCode)

Set a value to terminalCode.

Parameters:

terminalCode - the terminal code

getTaxAmount

public java.lang.Integer getTaxAmount()

Gets the tax amount.

Returns:

the tax amount

setTaxAmount

public void setTaxAmount(java.lang.Integer taxAmount)

Sets the tax amount.

Parameters:

taxAmount - the new tax amount

getAdjustmentTransaction

public AccountTransaction getAdjustmentTransaction()

Gets the adjustment transaction.

Returns:

the adjustment transaction

setAdjustmentTransaction

void setAdjustmentTransaction(AccountTransaction adjustmentTransaction)

Sets the adjustment transaction.

Parameters:

adjustmentTransaction - the new adjustment transaction

getDueDate

public java.util.Date getDueDate()

Gets the due date.

Returns:

Returns the dueDate

setDueDate

public void setDueDate(java.util.Date dueDate)

Set a value to dueDate.

Parameters:

dueDate - the due date