//----------------------------------------------------------------------------------
// Add bank payment or deposit to database.
//
// $from_account - bank account id
// $items - transaction cart (line amounts in bank account's currency); negative for deposit
// $person_type_id - defines type of $person_id identifiers
// $person_id - supplier/customer/other id
// $person_detail_id - customer branch id or not used
// $settled_amount - settled amount in AR/AP (if applicable) in customer/supplier currency (always non-negative number)
//
// returns an array of (inserted trans type, trans no)
//
// FIXME -revise code for update case
//
function write_bank_transaction($trans_type, $trans_no, $from_account, $items, $date_,
$person_type_id, $person_id, $person_detail_id, $ref, $check_no, $source_ref , $memo_ , $use_transaction=true, $settled_amount=null)
{
global $Refs, $SysPrefs;
// we can only handle type 1 (payment)and type 2 (deposit)
if ($trans_type != ST_BANKPAYMENT && $trans_type != ST_BANKDEPOSIT)
display_db_error("Invalid type ($trans_type) sent to add_bank_transaction");
$do_exchange_variance = false;
$exchanged = false;
if ($use_transaction)
begin_transaction();
$args = func_get_args(); if (count($args) < 13) $args[] = true;
$args = (object)array_combine(array('trans_type', 'trans_no', 'from_account', 'items', 'date_',
'person_type_id', 'person_id', 'person_detail_id', 'ref','check_no','source_ref', 'memo_', 'use_transaction', 'settled_amount'),
$args);
hook_db_prewrite($args, $trans_type);
$aid = 0;
if ($trans_no) {
$old_trans = $trans_no;
$Refs->restore_last($trans_type, $trans_no);
$aid = has_attachment($trans_type, $trans_no);
} else
$old_trans = false;
$currency = get_bank_account_currency($from_account);
$bank_gl_account = get_bank_gl_account($from_account);
// the gl items are already inversed/negated for type 2 (deposit)
$total_amount = $items->gl_items_total();
if ($person_type_id == PT_CUSTOMER)
{
// we need to add a customer transaction record
// convert to customer currency
if (!isset($settled_amount)) // leaved for backward/ext compatibility
$cust_amount = exchange_from_to(abs($total_amount), $currency, get_customer_currency($person_id), $date_);
else
$cust_amount = $settled_amount;
if ($trans_type == ST_BANKPAYMENT)
$cust_amount = -$cust_amount;
$trans_no = write_customer_trans($trans_type, 0, $person_id, $person_detail_id, $date_,
$ref,$check_no,$source_ref, $cust_amount);
if ($old_trans)
move_trans_attachments($trans_type, $old_trans, $trans_no);
}
elseif ($person_type_id == PT_SUPPLIER)
{
// we need to add a supplier transaction record
// convert to supp currency
if (!isset($settled_amount)) // leaved for for backward/ext compatibility
$supp_amount = exchange_from_to(abs($total_amount), $currency, get_supplier_currency($person_id), $date_);
else
$supp_amount = $settled_amount;
if ($trans_type == ST_BANKPAYMENT)
$supp_amount = -$supp_amount;
$trans_no = write_supp_trans($trans_type, 0, $person_id, $date_, '',
$ref, "", $supp_amount, 0, 0);
if ($old_trans)
move_trans_attachments($trans_type, $old_trans, $trans_no);
}
else
{
$trans_no = get_next_trans_no($trans_type);
$do_exchange_variance = $SysPrefs->auto_currency_revaluation();
if ($do_exchange_variance)
$trans_no1 = get_next_trans_no(ST_JOURNAL);
}
if ($aid != 0)
{
$row = get_attachment($aid);
update_attachment($aid, $row['type_no'], $trans_no, $row['description'],
$row['filename'], $row['unique_name'], $row['filesize'], $row['filetype']);
}
// do the source account postings
add_bank_trans($trans_type, $trans_no, $from_account, $ref, $check_no, $source_ref,
$date_, -$total_amount,
$person_type_id, $person_id,
$currency,
"Cannot insert a source bank transaction");
$total = 0;
foreach ($items->gl_items as $gl_item)
{
$is_bank_to = is_bank_account($gl_item->code_id);
if ($trans_type == ST_BANKPAYMENT AND $is_bank_to)
{
// we don't allow payments to go to a bank account. use transfer for this !
display_db_error("invalid payment entered. Cannot pay to another bank account", "");
}
// do the destination account postings
$total += add_gl_trans($trans_type, $trans_no, $date_, $gl_item->code_id,
$gl_item->dimension_id, $gl_item->dimension2_id, $gl_item->reference,
$gl_item->amount, $currency, $person_type_id, $person_id);
if ($is_bank_to)
{
add_bank_trans($trans_type, $trans_no, $is_bank_to, $ref, $check_no,$source_ref,
$date_, $gl_item->amount,
$person_type_id, $person_id, $currency,
"Cannot insert a destination bank transaction");
if ($do_exchange_variance)
{
add_exchange_variation($trans_no1, $date_, $is_bank_to, $gl_item->code_id,
$currency, $person_type_id, $person_id);
}
}
// store tax details if the gl account is a tax account
$amount = $gl_item->amount;
$ex_rate = get_exchange_rate_from_home_currency($currency, $date_);
add_gl_tax_details($gl_item->code_id, $trans_type, $trans_no, -$amount,
$ex_rate, $date_, $memo_);
}
// do the source account postings
add_gl_trans($trans_type, $trans_no, $date_, $bank_gl_account, 0, 0, $memo_,
-$total, null, $person_type_id, $person_id);
if ($do_exchange_variance)
{
if ($exchanged || add_exchange_variation($trans_no1, $date_, $from_account, $bank_gl_account,
$currency, $person_type_id, $person_id))
{
$ref1 = $Refs->get_next(ST_JOURNAL, null, $date_);
$Refs->save(ST_JOURNAL, $trans_no1, $ref1);
add_audit_trail(ST_JOURNAL, $trans_no1, $date_);
}
}
add_comments($trans_type, $trans_no, $date_, $memo_);
$Refs->save($trans_type, $trans_no, $ref, $check_no);
add_audit_trail($trans_type, $trans_no, $date_);
// old transaction can be voided only after new transaction is entered,
// otherwise the operation could fail for cash accounts due to temporary negative balance
if ($old_trans)
{
$msg = void_transaction($trans_type, $old_trans, Today(), _("Document reentered."));
if ($msg)
{
display_error($msg);
return false;
}
}
$args->trans_no = $trans_no;
hook_db_postwrite($args, $trans_type);
if ($use_transaction)
commit_transaction();
return array($trans_type, $trans_no);
}
