Transaction API
holds rows and other important data
rowArray[] will contain TransactionRowObjects
referenceNum, ledger, date, journal, payeepayer, remembered, memo
will contain the elements: 'rowDate', 'memo', 'subEntity', 'accountNum', 'subAccountNum', 'dorc', 'amount', 'cleared'
defaults:
Methods:
isValid
int new (ledger, date, journal, payeepayer, remembered, memo, rowObjects[])
needs minimum of ledger, date, journal, TransactionRowObject
use array index in rowObjects[] as counter for rows
returns 1 or 0 if there is a problem
Transaction Module functions
ref new (dbiw)
takes a DBIWrapper instance as its only parameter
instantiates a new instance of a Transaction object whose function is to be able to work with TransactionObjects to
write them to the database
read them from the database
update values in the database
bool insertTransaction (TransactionObject)
inserts the entry transaction object into the journal_entry_tb and debitcredit_tb tables
bool updateTransaction (referenceNum, TransactionObject)
modifies the journal_entry_tb and debitcredit_tb transaction to update the values to the ones contained in the TransactionObject
TransactionObject getTransaction (referenceNum)
retrieves the data from the journal_entry_tb and the debitcredit_tb tables for the referenceNum
fills in and returns a transactionObject
bool deleteTransaction (referenceNum)
deletes the transaction referenced by referenceNum from both the journal_entry_tb and debitcredit_tb tables.
closeOut (ledger, date, accountHash[], excessAccount) [stub]
accountHash holds the accounts for retained earnings; indexes = account numbers; values = percentages in case of partnership, corporation, llc
excessAccount: the account to place extra cents and leftovers from closing out and distributing to partners
Copyright (c) 2001 HLR
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.1;
A copy of the license is available at
http://www.gnu.org/licenses/licenses.html#FDL.
Updated: $Id: transactionAPI.html,v 1.1.1.1 2001/08/09 19:02:36 moreejt Exp $