gl/includes/db/gl_db_trans.inc

   1 <?php
   2 /**********************************************************************
   3     Copyright (C) FrontAccounting, LLC.
   4         Released under the terms of the GNU Affero General Public License,
   5         AGPL, as published by the Free Software Foundation, either version
   6         3 of the License, or (at your option) any later version.
   7     This program is distributed in the hope that it will be useful,
   8     but WITHOUT ANY WARRANTY; without even the implied warranty of
   9     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  10     See the License here <http://www.gnu.org/licenses/agpl-3.0.html>.
  11 ***********************************************************************/
  12 //--------------------------------------------------------------------------------
  13
  14 // Base function for adding a GL transaction
  15 // $date_ is display date (non-sql)
  16 // $amount is in $currency currency
  17 // if $currency is not set, then defaults to no conversion
  18
  19 function add_gl_trans($type, $trans_id, $date_, $account, $dimension, $dimension2, $memo_,
  20         $amount, $currency=null, $person_type_id=null, $person_id=null, $err_msg="", $rate=0)
  21 {
  22         global $use_audit_trail;
  23
  24         $date = date2sql($date_);
  25         if ($currency != null)
  26         {
  27                 if ($rate == 0)
  28                         $amount_in_home_currency = to_home_currency($amount, $currency, $date_);
  29                 else
  30                         $amount_in_home_currency = round2($amount * $rate,  user_price_dec());
  31         }
  32         else
  33                 $amount_in_home_currency = round2($amount, user_price_dec());
  34         if ($dimension == null || $dimension < 0)
  35                 $dimension = 0;
  36         if ($dimension2 == null || $dimension2 < 0)
  37                 $dimension2 = 0;
  38         if (isset($use_audit_trail) && $use_audit_trail)
  39         {
  40                 if ($memo_ == "" || $memo_ == null)
  41                         $memo_ = $_SESSION["wa_current_user"]->username;
  42                 else
  43                         $memo_ = $_SESSION["wa_current_user"]->username . " - " . $memo_;
  44         }
  45         $sql = "INSERT INTO ".TB_PREF."gl_trans ( type, type_no, tran_date,
  46                 account, dimension_id, dimension2_id, memo_, amount";
  47
  48         if ($person_type_id != null)
  49                 $sql .= ", person_type_id, person_id";
  50
  51         $sql .= ") ";
  52
  53         $sql .= "VALUES ($type, $trans_id, '$date',
  54                 '$account', $dimension, $dimension2, ".db_escape($memo_).", $amount_in_home_currency";
  55
  56         if ($person_type_id != null)
  57                 $sql .= ", $person_type_id, ". db_escape($person_id);
  58
  59         $sql .= ") ";
  60
  61         if ($err_msg == "")
  62                 $err_msg = "The GL transaction could not be inserted";
  63
  64         db_query($sql, $err_msg);
  65         return $amount_in_home_currency;
  66 }
  67
  68 //--------------------------------------------------------------------------------
  69
  70 // GL Trans for standard costing, always home currency regardless of person
  71 // $date_ is display date (non-sql)
  72 // $amount is in HOME currency
  73
  74 function add_gl_trans_std_cost($type, $trans_id, $date_, $account, $dimension, $dimension2,
  75         $memo_, $amount, $person_type_id=null, $person_id=null, $err_msg="")
  76 {
  77         if ($amount != 0)
  78                 return add_gl_trans($type, $trans_id, $date_, $account, $dimension, $dimension2, $memo_,
  79                         $amount, null, $person_type_id, $person_id, $err_msg);
  80         else
  81                 return 0;
  82 }
  83
  84 // Function for even out rounding problems
  85 function add_gl_balance($type, $trans_id, $date_, $amount, $person_type_id=null, $person_id=null)
  86 {
  87         $amount = round2($amount, user_price_dec());
  88         if ($amount != 0)
  89                 return add_gl_trans($type, $trans_id, $date_, get_company_pref('exchange_diff_act'), 0, 0, "",
  90                         $amount, null, $person_type_id, $person_id, "The balanced GL transaction could not be inserted");
  91         else
  92                 return 0;
  93 }
  94
  95 //--------------------------------------------------------------------------------
  96
  97 function get_gl_transactions($from_date, $to_date, $trans_no=0,
  98         $account=null, $dimension=0, $dimension2=0, $filter_type=null)
  99 {
 100         $from = date2sql($from_date);
 101         $to = date2sql($to_date);
 102
 103         $sql = "SELECT ".TB_PREF."gl_trans.*, ".TB_PREF."chart_master.account_name FROM ".TB_PREF."gl_trans, ".TB_PREF."chart_master
 104                 WHERE ".TB_PREF."chart_master.account_code=".TB_PREF."gl_trans.account
 105                 AND tran_date >= '$from'
 106                 AND tran_date <= '$to'";
 107         if ($trans_no > 0)
 108                 $sql .= " AND ".TB_PREF."gl_trans.type_no LIKE '%$trans_no'";
 109
 110         if ($account != null)
 111                 $sql .= " AND ".TB_PREF."gl_trans.account = '$account'";
 112
 113         if ($dimension > 0)
 114                 $sql .= " AND ".TB_PREF."gl_trans.dimension_id = $dimension";
 115
 116         if ($dimension2 > 0)
 117                 $sql .= " AND ".TB_PREF."gl_trans.dimension2_id = $dimension2";
 118
 119         if ($filter_type != null AND is_numeric($filter_type))
 120                 $sql .= " AND ".TB_PREF."gl_trans.type= $filter_type";
 121
 122         $sql .= " ORDER BY tran_date";
 123
 124         return db_query($sql, "The transactions for could not be retrieved");
 125 }
 126
 127
 128 //--------------------------------------------------------------------------------
 129
 130 function get_gl_trans($type, $trans_id)
 131 {
 132         $sql = "SELECT ".TB_PREF."gl_trans.*, ".TB_PREF."chart_master.account_name FROM ".TB_PREF."gl_trans, ".TB_PREF."chart_master
 133                 WHERE ".TB_PREF."chart_master.account_code=".TB_PREF."gl_trans.account
 134                 AND ".TB_PREF."gl_trans.type=$type AND ".TB_PREF."gl_trans.type_no=$trans_id";
 135
 136         return db_query($sql, "The gl transactions could not be retrieved");
 137 }
 138
 139 //--------------------------------------------------------------------------------
 140
 141 function get_gl_balance_from_to($from_date, $to_date, $account, $dimension=0, $dimension2=0)
 142 {
 143         $from = date2sql($from_date);
 144         $to = date2sql($to_date);
 145
 146     $sql = "SELECT SUM(amount) FROM ".TB_PREF."gl_trans
 147                 WHERE account='$account'";
 148         if ($from_date != "")
 149                 $sql .= "  AND tran_date > '$from'";
 150         if ($to_date != "")
 151                 $sql .= "  AND tran_date < '$to'";
 152         if ($dimension > 0)
 153                 $sql .= " AND dimension_id = $dimension";
 154         if ($dimension2 > 0)
 155                 $sql .= " AND dimension2_id = $dimension2";
 156
 157         $result = db_query($sql, "The starting balance for account $account could not be calculated");
 158
 159         $row = db_fetch_row($result);
 160         return $row[0];
 161 }
 162
 163 //--------------------------------------------------------------------------------
 164
 165 function get_gl_trans_from_to($from_date, $to_date, $account, $dimension=0, $dimension2=0)
 166 {
 167         $from = date2sql($from_date);
 168         $to = date2sql($to_date);
 169
 170     $sql = "SELECT SUM(amount) FROM ".TB_PREF."gl_trans
 171                 WHERE account='$account'";
 172         if ($from_date != "")
 173                 $sql .= " AND tran_date >= '$from'";
 174         if ($to_date != "")
 175                 $sql .= " AND tran_date <= '$to'";
 176         if ($dimension > 0)
 177                 $sql .= " AND dimension_id = $dimension";
 178         if ($dimension2 > 0)
 179                 $sql .= " AND dimension2_id = $dimension2";
 180
 181         $result = db_query($sql, "Transactions for account $account could not be calculated");
 182
 183         $row = db_fetch_row($result);
 184         return $row[0];
 185 }
 186
 187 //--------------------------------------------------------------------------------
 188
 189 function get_budget_trans_from_to($from_date, $to_date, $account, $dimension=0, $dimension2=0)
 190 {
 191
 192         $from = date2sql($from_date);
 193         $to = date2sql($to_date);
 194
 195         $sql = "SELECT SUM(amount) FROM ".TB_PREF."budget_trans
 196                 WHERE account='$account' ";
 197         if ($from_date != "")
 198                 $sql .= " AND tran_date >= '$from' ";
 199         if ($to_date != "")
 200                 $sql .= " AND tran_date <= '$to' ";
 201         if ($dimension > 0)
 202                 $sql .= " AND dimension_id = $dimension";
 203         if ($dimension2 > 0)
 204                 $sql .= " AND dimension2_id = $dimension2";
 205         $result = db_query($sql,"No budget accounts were returned");
 206
 207         $row = db_fetch_row($result);
 208         return $row[0];
 209 }
 210
 211 //--------------------------------------------------------------------------------
 212 //      Stores journal/bank transaction tax details if applicable
 213 //
 214 function add_gl_tax_details($gl_code, $trans_type, $trans_no, $amount, $date, $memo)
 215 {
 216         $tax_type = is_tax_account($gl_code);
 217         if(!$tax_type) return;  // $gl_code is not tax account
 218
 219         $tax = get_tax_type($tax_type);
 220         if ($gl_code == $tax['sales_gl_code'])
 221                 $amount = -$amount;
 222         // we have to restore net amount as we cannot know the base amount
 223         if ($tax['rate'] == 0) {
 224 //              display_warning(_("You should not post gl transactions
 225 //                      to tax account with     zero tax rate."));
 226                 $net_amount = 0;
 227         } else {
 228                 // calculate net amount
 229                 $net_amount = $amount/$tax['rate']*100;
 230         }
 231         add_trans_tax_details($trans_type, $trans_no, $tax['id'], $tax['rate'], 0,
 232                 $amount, $net_amount, $date, $memo);
 233
 234 }
 235
 236 //--------------------------------------------------------------------------------
 237 //
 238 //      Store transaction tax details for fiscal purposes with 'freezed'
 239 //      actual tax type rate.
 240 //
 241 function add_trans_tax_details($trans_type, $trans_no, $tax_id, $rate, $included,
 242         $amount, $net_amount, $tran_date, $memo)
 243 {
 244         $sql = "INSERT INTO ".TB_PREF."trans_tax_details
 245                 (trans_type, trans_no, tran_date, tax_type_id, rate,
 246                         included_in_price, net_amount, amount, memo)
 247                 VALUES (".db_escape($trans_type)."," . db_escape($trans_no).",'"
 248                                 .date2sql($tran_date)."',".db_escape($tax_id).","
 249                                 .$rate.",".($included ? 1:0).",".db_escape($net_amount).","
 250                                 .db_escape($amount).",".db_escape($memo).")";
 251
 252         db_query($sql, "Cannot save trans tax details");
 253
 254 }
 255 //----------------------------------------------------------------------------------------
 256
 257 function get_trans_tax_details($trans_type, $trans_no)
 258 {
 259         $sql = "SELECT ".TB_PREF."trans_tax_details.*, ".TB_PREF."tax_types.name AS tax_type_name
 260                 FROM ".TB_PREF."trans_tax_details,".TB_PREF."tax_types
 261                 WHERE trans_type = $trans_type
 262                 AND trans_no = $trans_no
 263                 AND amount != 0
 264                 AND ".TB_PREF."tax_types.id = ".TB_PREF."trans_tax_details.tax_type_id";
 265
 266         return db_query($sql, "The transaction tax details could not be retrieved");
 267 }
 268
 269 //----------------------------------------------------------------------------------------
 270
 271 function void_trans_tax_details($type, $type_no)
 272 {
 273         $sql = "UPDATE ".TB_PREF."trans_tax_details SET amount=0, net_amount=0
 274                 WHERE trans_no=$type_no
 275                 AND trans_type=$type";
 276
 277         db_query($sql, "The transaction tax details could not be voided");
 278 }
 279
 280 //--------------------------------------------------------------------------------
 281 function add_journal_entries($items, $date_, $ref, $reverse, $memo_=null)
 282 {
 283         begin_transaction();
 284
 285         $trans_type = systypes::journal_entry();
 286         $trans_id = get_next_trans_no($trans_type);
 287
 288         foreach ($items as $journal_item)
 289         {
 290                 // post to first found bank account using given gl acount code.
 291                 $is_bank_to = is_bank_account($journal_item->code_id);
 292
 293                 add_gl_trans($trans_type, $trans_id, $date_, $journal_item->code_id,
 294                         $journal_item->dimension_id, $journal_item->dimension2_id,
 295                         $journal_item->reference, $journal_item->amount);
 296         if ($is_bank_to)
 297         {
 298                 add_bank_trans($trans_type, $trans_id, $is_bank_to, $ref,
 299                         $date_, $journal_item->amount,
 300                         0, "", get_company_currency(),
 301                         "Cannot insert a destination bank transaction");
 302         }
 303                 // store tax details if the gl account is a tax account
 304                 add_gl_tax_details($journal_item->code_id,
 305                         $trans_type, $trans_id, -$journal_item->amount, $date_, $memo_);
 306         }
 307
 308         add_comments($trans_type, $trans_id, $date_, $memo_);
 309
 310         references::save($trans_type, $trans_id, $ref);
 311
 312         if ($reverse)
 313         {
 314
 315         //$reversingDate = date(user_date_display(),
 316         //      Mktime(0,0,0,get_month($date_)+1,1,get_year($date_)));
 317         $reversingDate = begin_month(add_months($date_, 1));
 318
 319         $trans_id_reverse = get_next_trans_no($trans_type);
 320
 321         foreach ($items as $journal_item)
 322         {
 323                         $is_bank_to = is_bank_account($journal_item->code_id);
 324
 325                 add_gl_trans($trans_type, $trans_id_reverse, $reversingDate,
 326                         $journal_item->code_id, $journal_item->dimension_id, $journal_item->dimension2_id,
 327                         $journal_item->reference, -$journal_item->amount);
 328                 if ($is_bank_to)
 329                 {
 330                         add_bank_trans($trans_type, $trans_id_reverse, $is_bank_to, $ref,
 331                                 $reversingDate, $journal_item->amount,
 332                                 0, "", get_company_currency(),
 333                                 "Cannot insert a destination bank transaction");
 334                 }
 335                         // store tax details if the gl account is a tax account
 336                         add_gl_tax_details($journal_item->code_id,
 337                                 $trans_type, $trans_id, $journal_item->amount, $date, $memo_);
 338         }
 339
 340         add_comments($trans_type, $trans_id_reverse, $reversingDate, $memo_);
 341
 342         references::save($trans_type, $trans_id_reverse, $ref);
 343         }
 344
 345         commit_transaction();
 346
 347         return $trans_id;
 348 }
 349
 350 //--------------------------------------------------------------------------------------------------
 351
 352 function exists_gl_trans($type, $trans_id)
 353 {
 354         $sql = "SELECT type_no FROM ".TB_PREF."gl_trans WHERE type=$type AND type_no=$trans_id";
 355         $result = db_query($sql, "Cannot retreive a gl transaction");
 356
 357     return (db_num_rows($result) > 0);
 358 }
 359
 360 //--------------------------------------------------------------------------------------------------
 361
 362 function void_gl_trans($type, $trans_id, $nested=false)
 363 {
 364         if (!$nested)
 365                 begin_transaction();
 366
 367         $sql = "UPDATE ".TB_PREF."gl_trans SET amount=0 WHERE type=$type AND type_no=$trans_id";
 368
 369         db_query($sql, "could not void gl transactions for type=$type and trans_no=$trans_id");
 370
 371         if (!$nested)
 372                 commit_transaction();
 373 }
 374
 375 //----------------------------------------------------------------------------------------
 376
 377 function void_journal_trans($type, $type_no)
 378 {
 379         begin_transaction();
 380
 381         void_gl_trans($type, $type_no, true);
 382         void_bank_trans($type, $type_no,true);
 383         void_trans_tax_details($type, $type_no);
 384
 385         commit_transaction();
 386 }
 387
 388 ?>