gl/includes/db/gl_db_trans.inc

   1 <?php
   2 /**********************************************************************
   3     Copyright (C) FrontAccounting, LLC.
   4         Released under the terms of the GNU General Public License, GPL,
   5         as published by the Free Software Foundation, either version 3
   6         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/gpl-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 (".db_escape($type).", ".db_escape($trans_id).", '$date',
  54                 ".db_escape($account).", ".db_escape($dimension).", "
  55                 .db_escape($dimension2).", ".db_escape($memo_).", "
  56                 .db_escape($amount_in_home_currency);
  57
  58         if ($person_type_id != null)
  59                 $sql .= ", ".db_escape($person_type_id).", ". db_escape($person_id);
  60
  61         $sql .= ") ";
  62
  63         if ($err_msg == "")
  64                 $err_msg = "The GL transaction could not be inserted";
  65
  66         db_query($sql, $err_msg);
  67         return $amount_in_home_currency;
  68 }
  69
  70 //--------------------------------------------------------------------------------
  71
  72 // GL Trans for standard costing, always home currency regardless of person
  73 // $date_ is display date (non-sql)
  74 // $amount is in HOME currency
  75
  76 function add_gl_trans_std_cost($type, $trans_id, $date_, $account, $dimension, $dimension2,
  77         $memo_, $amount, $person_type_id=null, $person_id=null, $err_msg="")
  78 {
  79         if ($amount != 0)
  80                 return add_gl_trans($type, $trans_id, $date_, $account, $dimension, $dimension2, $memo_,
  81                         $amount, null, $person_type_id, $person_id, $err_msg);
  82         else
  83                 return 0;
  84 }
  85
  86 // Function for even out rounding problems
  87 function add_gl_balance($type, $trans_id, $date_, $amount, $person_type_id=null, $person_id=null)
  88 {
  89         $amount = round2($amount, user_price_dec());
  90         if ($amount != 0)
  91                 return add_gl_trans($type, $trans_id, $date_, get_company_pref('exchange_diff_act'), 0, 0, "",
  92                         $amount, null, $person_type_id, $person_id, "The balanced GL transaction could not be inserted");
  93         else
  94                 return 0;
  95 }
  96
  97 //--------------------------------------------------------------------------------
  98
  99 function get_gl_transactions($from_date, $to_date, $trans_no=0,
 100         $account=null, $dimension=0, $dimension2=0, $filter_type=null,
 101         $amount_min=null, $amount_max=null)
 102 {
 103         $from = date2sql($from_date);
 104         $to = date2sql($to_date);
 105
 106         $sql = "SELECT ".TB_PREF."gl_trans.*, "
 107                 .TB_PREF."chart_master.account_name FROM ".TB_PREF."gl_trans, "
 108                 .TB_PREF."chart_master
 109                 WHERE ".TB_PREF."chart_master.account_code=".TB_PREF."gl_trans.account
 110                 AND tran_date >= '$from'
 111                 AND tran_date <= '$to'";
 112         if ($trans_no > 0)
 113                 $sql .= " AND ".TB_PREF."gl_trans.type_no LIKE ".db_escape('%'.$trans_no);
 114
 115         if ($account != null)
 116                 $sql .= " AND ".TB_PREF."gl_trans.account = ".db_escape($account);
 117
 118         if ($dimension != 0)
 119                 $sql .= " AND ".TB_PREF."gl_trans.dimension_id = ".($dimension<0?0:db_escape($dimension));
 120
 121         if ($dimension2 != 0)
 122                 $sql .= " AND ".TB_PREF."gl_trans.dimension2_id = ".($dimension2<0?0:db_escape($dimension2));
 123
 124         if ($filter_type != null AND is_numeric($filter_type))
 125                 $sql .= " AND ".TB_PREF."gl_trans.type= ".db_escape($filter_type);
 126
 127         if ($amount_min != null)
 128                 $sql .= " AND ABS(".TB_PREF."gl_trans.amount) >= ABS(".db_escape($amount_min).")";
 129
 130         if ($amount_max != null)
 131                 $sql .= " AND ABS(".TB_PREF."gl_trans.amount) <= ABS(".db_escape($amount_max).")";
 132
 133         $sql .= " ORDER BY tran_date, counter";
 134
 135         return db_query($sql, "The transactions for could not be retrieved");
 136 }
 137
 138
 139 //--------------------------------------------------------------------------------
 140
 141 function get_gl_trans($type, $trans_id)
 142 {
 143         $sql = "SELECT ".TB_PREF."gl_trans.*, "
 144                 .TB_PREF."chart_master.account_name FROM "
 145                         .TB_PREF."gl_trans, ".TB_PREF."chart_master
 146                 WHERE ".TB_PREF."chart_master.account_code=".TB_PREF."gl_trans.account
 147                 AND ".TB_PREF."gl_trans.type=".db_escape($type)
 148                 ." AND ".TB_PREF."gl_trans.type_no=".db_escape($trans_id);
 149
 150         return db_query($sql, "The gl transactions could not be retrieved");
 151 }
 152
 153 //--------------------------------------------------------------------------------
 154
 155 function get_gl_wo_cost_trans($trans_id, $person_id=-1)
 156 {
 157         $sql = "SELECT ".TB_PREF."gl_trans.*, ".TB_PREF."chart_master.account_name FROM "
 158                 .TB_PREF."gl_trans, ".TB_PREF."chart_master
 159                 WHERE ".TB_PREF."chart_master.account_code=".TB_PREF."gl_trans.account
 160                 AND ".TB_PREF."gl_trans.type=".ST_WORKORDER
 161                 ." AND ".TB_PREF."gl_trans.type_no=".db_escape($trans_id)."
 162                 AND ".TB_PREF."gl_trans.person_type_id=".PT_WORKORDER;
 163         if ($person_id != -1)
 164                 $sql .= " AND ".TB_PREF."gl_trans.person_id=".db_escape($person_id);
 165         $sql .= " AND amount < 0";
 166
 167         return db_query($sql, "The gl transactions could not be retrieved");
 168 }
 169
 170 function get_gl_balance_from_to($from_date, $to_date, $account, $dimension=0, $dimension2=0)
 171 {
 172         $from = date2sql($from_date);
 173         $to = date2sql($to_date);
 174
 175     $sql = "SELECT SUM(amount) FROM ".TB_PREF."gl_trans
 176                 WHERE account='$account'";
 177         if ($from_date != "")
 178                 $sql .= "  AND tran_date > '$from'";
 179         if ($to_date != "")
 180                 $sql .= "  AND tran_date < '$to'";
 181         if ($dimension != 0)
 182                 $sql .= " AND dimension_id = ".($dimension<0?0:db_escape($dimension));
 183         if ($dimension2 != 0)
 184                 $sql .= " AND dimension2_id = ".($dimension2<0?0:db_escape($dimension2));
 185
 186         $result = db_query($sql, "The starting balance for account $account could not be calculated");
 187
 188         $row = db_fetch_row($result);
 189         return $row[0];
 190 }
 191
 192 //--------------------------------------------------------------------------------
 193
 194 function get_gl_trans_from_to($from_date, $to_date, $account, $dimension=0, $dimension2=0)
 195 {
 196         $from = date2sql($from_date);
 197         $to = date2sql($to_date);
 198
 199     $sql = "SELECT SUM(amount) FROM ".TB_PREF."gl_trans
 200                 WHERE account='$account'";
 201         if ($from_date != "")
 202                 $sql .= " AND tran_date >= '$from'";
 203         if ($to_date != "")
 204                 $sql .= " AND tran_date <= '$to'";
 205         if ($dimension != 0)
 206                 $sql .= " AND dimension_id = ".($dimension<0?0:db_escape($dimension));
 207         if ($dimension2 != 0)
 208                 $sql .= " AND dimension2_id = ".($dimension2<0?0:db_escape($dimension2));
 209
 210         $result = db_query($sql, "Transactions for account $account could not be calculated");
 211
 212         $row = db_fetch_row($result);
 213         return $row[0];
 214 }
 215
 216 //----------------------------------------------------------------------------------------------------
 217 function get_balance($account, $dimension, $dimension2, $from, $to, $from_incl=true, $to_incl=true)
 218 {
 219         $sql = "SELECT SUM(IF(amount >= 0, amount, 0)) as debit,
 220                 SUM(IF(amount < 0, -amount, 0)) as credit, SUM(amount) as balance
 221                 FROM ".TB_PREF."gl_trans,".TB_PREF."chart_master,"
 222                         .TB_PREF."chart_types, ".TB_PREF."chart_class
 223                 WHERE ".TB_PREF."gl_trans.account=".TB_PREF."chart_master.account_code AND "
 224                 .TB_PREF."chart_master.account_type=".TB_PREF."chart_types.id
 225                 AND ".TB_PREF."chart_types.class_id=".TB_PREF."chart_class.cid AND";
 226
 227         if ($account != null)
 228                 $sql .= " account=".db_escape($account)." AND";
 229         if ($dimension != 0)
 230                 $sql .= " dimension_id = ".($dimension<0?0:db_escape($dimension))." AND";
 231         if ($dimension2 != 0)
 232                 $sql .= " dimension2_id = ".($dimension2<0?0:db_escape($dimension2))." AND";
 233         $from_date = date2sql($from);
 234         if ($from_incl)
 235                 $sql .= " tran_date >= '$from_date'  AND";
 236         else
 237                 $sql .= " tran_date > IF(ctype>0 AND ctype<".CL_INCOME.", '0000-00-00', '$from_date') AND";
 238         $to_date = date2sql($to);
 239         if ($to_incl)
 240                 $sql .= " tran_date <= '$to_date' ";
 241         else
 242                 $sql .= " tran_date < '$to_date' ";
 243
 244         $result = db_query($sql,"No general ledger accounts were returned");
 245
 246         return db_fetch($result);
 247 }
 248
 249 //--------------------------------------------------------------------------------
 250
 251 function get_budget_trans_from_to($from_date, $to_date, $account, $dimension=0, $dimension2=0)
 252 {
 253
 254         $from = date2sql($from_date);
 255         $to = date2sql($to_date);
 256
 257         $sql = "SELECT SUM(amount) FROM ".TB_PREF."budget_trans
 258                 WHERE account=".db_escape($account);
 259         if ($from_date != "")
 260                 $sql .= " AND tran_date >= '$from' ";
 261         if ($to_date != "")
 262                 $sql .= " AND tran_date <= '$to' ";
 263         if ($dimension != 0)
 264                 $sql .= " AND dimension_id = ".($dimension<0?0:db_escape($dimension));
 265         if ($dimension2 != 0)
 266                 $sql .= " AND dimension2_id = ".($dimension2<0?0:db_escape($dimension2));
 267         $result = db_query($sql,"No budget accounts were returned");
 268
 269         $row = db_fetch_row($result);
 270         return $row[0];
 271 }
 272
 273 //--------------------------------------------------------------------------------
 274 //      Stores journal/bank transaction tax details if applicable
 275 //
 276 function add_gl_tax_details($gl_code, $trans_type, $trans_no, $amount, $ex_rate, $date, $memo)
 277 {
 278         $tax_type = is_tax_account($gl_code);
 279         if(!$tax_type) return;  // $gl_code is not tax account
 280
 281         $tax = get_tax_type($tax_type);
 282         //if ($gl_code == $tax['sales_gl_code'])
 283         //      $amount = -$amount;
 284         // we have to restore net amount as we cannot know the base amount
 285         if ($tax['rate'] == 0) {
 286 //              display_warning(_("You should not post gl transactions
 287 //                      to tax account with     zero tax rate."));
 288                 $net_amount = 0;
 289         } else {
 290                 // calculate net amount
 291                 $net_amount = $amount/$tax['rate']*100;
 292         }
 293
 294         add_trans_tax_details($trans_type, $trans_no, $tax['id'], $tax['rate'], 0,
 295                 $amount, $net_amount, $ex_rate, $date, $memo);
 296
 297 }
 298
 299 //--------------------------------------------------------------------------------
 300 //
 301 //      Store transaction tax details for fiscal purposes with 'freezed'
 302 //      actual tax type rate.
 303 //
 304 function add_trans_tax_details($trans_type, $trans_no, $tax_id, $rate, $included,
 305         $amount, $net_amount, $ex_rate, $tran_date, $memo)
 306 {
 307
 308         $sql = "INSERT INTO ".TB_PREF."trans_tax_details
 309                 (trans_type, trans_no, tran_date, tax_type_id, rate, ex_rate,
 310                         included_in_price, net_amount, amount, memo)
 311                 VALUES (".db_escape($trans_type)."," . db_escape($trans_no).",'"
 312                                 .date2sql($tran_date)."',".db_escape($tax_id).","
 313                                 .db_escape($rate).",".db_escape($ex_rate).",".($included ? 1:0).","
 314                                 .db_escape($net_amount).","
 315                                 .db_escape($amount).",".db_escape($memo).")";
 316
 317         db_query($sql, "Cannot save trans tax details");
 318
 319 }
 320 //----------------------------------------------------------------------------------------
 321
 322 function get_trans_tax_details($trans_type, $trans_no)
 323 {
 324         $sql = "SELECT ".TB_PREF."trans_tax_details.*, "
 325                 .TB_PREF."tax_types.name AS tax_type_name
 326                 FROM ".TB_PREF."trans_tax_details,".TB_PREF."tax_types
 327                 WHERE trans_type = ".db_escape($trans_type)."
 328                 AND trans_no = ".db_escape($trans_no)."
 329                 AND (net_amount != 0 OR amount != 0)
 330                 AND ".TB_PREF."tax_types.id = ".TB_PREF."trans_tax_details.tax_type_id";
 331
 332         return db_query($sql, "The transaction tax details could not be retrieved");
 333 }
 334
 335 //----------------------------------------------------------------------------------------
 336
 337 function void_trans_tax_details($type, $type_no)
 338 {
 339         $sql = "UPDATE ".TB_PREF."trans_tax_details SET amount=0, net_amount=0
 340                 WHERE trans_no=".db_escape($type_no)
 341                 ." AND trans_type=".db_escape($type);
 342
 343         db_query($sql, "The transaction tax details could not be voided");
 344 }
 345
 346 function get_tax_summary($from, $to)
 347 {
 348         $fromdate = date2sql($from);
 349         $todate = date2sql($to);
 350
 351         $sql = "SELECT
 352                                 SUM(IF(trans_type=".ST_CUSTCREDIT." || trans_type=".ST_SUPPINVOICE.",-1,1)*
 353                                 IF(trans_type=".ST_BANKDEPOSIT." || trans_type=".ST_SALESINVOICE." || trans_type=".ST_CUSTCREDIT.", net_amount*ex_rate,0)) net_output,
 354                                 SUM(IF(trans_type=".ST_CUSTCREDIT." || trans_type=".ST_SUPPINVOICE.",-1,1)*
 355                                 IF(trans_type=".ST_BANKDEPOSIT." || trans_type=".ST_SALESINVOICE." || trans_type=".ST_CUSTCREDIT.", amount*ex_rate,0)) payable,
 356                                 SUM(IF(trans_type=".ST_CUSTCREDIT." || trans_type=".ST_SUPPINVOICE.",-1,1)*
 357                                 IF(trans_type=".ST_BANKDEPOSIT." || trans_type=".ST_SALESINVOICE." || trans_type=".ST_CUSTCREDIT.", 0, net_amount*ex_rate)) net_input,
 358                                 SUM(IF(trans_type=".ST_CUSTCREDIT." || trans_type=".ST_SUPPINVOICE.",-1,1)*
 359                                 IF(trans_type=".ST_BANKDEPOSIT." || trans_type=".ST_SALESINVOICE." || trans_type=".ST_CUSTCREDIT.", 0, amount*ex_rate)) collectible,
 360                                 taxrec.rate,
 361                                 ttype.id,
 362                                 ttype.name
 363                 FROM ".TB_PREF."tax_types ttype,
 364                          ".TB_PREF."trans_tax_details taxrec
 365                 WHERE taxrec.tax_type_id=ttype.id
 366                         AND taxrec.trans_type != ".ST_CUSTDELIVERY."
 367                         AND taxrec.tran_date >= '$fromdate'
 368                         AND taxrec.tran_date <= '$todate'
 369                 GROUP BY ttype.id";
 370 //display_error($sql);
 371     return db_query($sql,"Cannot retrieve tax summary");
 372 }
 373
 374 //--------------------------------------------------------------------------------
 375 // Write/update journal entries.
 376 //
 377 function write_journal_entries(&$cart, $reverse, $use_transaction=true)
 378 {
 379         global $Refs;
 380
 381         $date_ = $cart->tran_date;
 382         $ref   = $cart->reference;
 383         $memo_ = $cart->memo_;
 384         $trans_type = $cart->trans_type;
 385         $new = $cart->order_id == 0;
 386
 387         if ($new)
 388             $cart->order_id = get_next_trans_no($trans_type);
 389
 390     $trans_id = $cart->order_id;
 391
 392         if ($use_transaction)
 393                 begin_transaction();
 394
 395         if(!$new)
 396                 void_journal_trans($trans_type, $trans_id, false);
 397
 398         foreach ($cart->gl_items as $journal_item)
 399         {
 400                 // post to first found bank account using given gl acount code.
 401                 $is_bank_to = is_bank_account($journal_item->code_id);
 402
 403                 add_gl_trans($trans_type, $trans_id, $date_, $journal_item->code_id,
 404                         $journal_item->dimension_id, $journal_item->dimension2_id,
 405                         $journal_item->reference, $journal_item->amount);
 406         if ($is_bank_to)
 407         {
 408                 add_bank_trans($trans_type, $trans_id, $is_bank_to, $ref,
 409                         $date_, $journal_item->amount,  0, "", get_company_currency(),
 410                         "Cannot insert a destination bank transaction");
 411         }
 412                 // store tax details if the gl account is a tax account
 413                 add_gl_tax_details($journal_item->code_id,
 414                         ($journal_item->amount < 0.0 ? ST_BANKDEPOSIT : ST_BANKPAYMENT), $trans_id, -$journal_item->amount, 1, $date_, $memo_);
 415         }
 416
 417         if ($new) {
 418                 add_comments($trans_type, $trans_id, $date_, $memo_);
 419                 $Refs->save($trans_type, $trans_id, $ref);
 420         } else {
 421                 update_comments($trans_type, $trans_id, null, $memo_);
 422                 $Refs->update($trans_type, $trans_id, $ref);
 423         }
 424
 425         add_audit_trail($trans_type, $trans_id, $date_);
 426
 427         if ($reverse)
 428         {
 429         //$reversingDate = date(user_date_display(),
 430         //      Mktime(0,0,0,get_month($date_)+1,1,get_year($date_)));
 431         $reversingDate = begin_month(add_months($date_, 1));
 432
 433         $trans_id_reverse = get_next_trans_no($trans_type);
 434
 435         foreach ($cart->gl_items as $journal_item)
 436         {
 437                         $is_bank_to = is_bank_account($journal_item->code_id);
 438
 439                 add_gl_trans($trans_type, $trans_id_reverse, $reversingDate,
 440                         $journal_item->code_id, $journal_item->dimension_id, $journal_item->dimension2_id,
 441                         $journal_item->reference, -$journal_item->amount);
 442                 if ($is_bank_to)
 443                 {
 444                         add_bank_trans($trans_type, $trans_id_reverse, $is_bank_to, $ref,
 445                                 $reversingDate, -$journal_item->amount,
 446                                 0, "", get_company_currency(),
 447                                 "Cannot insert a destination bank transaction");
 448                 }
 449                         // store tax details if the gl account is a tax account
 450                         add_gl_tax_details($journal_item->code_id,
 451                                 ($journal_item->amount < 0.0 ? ST_BANKDEPOSIT : ST_BANKPAYMENT), $trans_id, $journal_item->amount, 1, $reversingDate, $memo_);
 452         }
 453
 454         add_comments($trans_type, $trans_id_reverse, $reversingDate, $memo_);
 455
 456         $Refs->save($trans_type, $trans_id_reverse, $ref);
 457                 add_audit_trail($trans_type, $trans_id_reverse, $reversingDate);
 458         }
 459
 460         if ($use_transaction)
 461                 commit_transaction();
 462
 463         return $trans_id;
 464 }
 465
 466 //--------------------------------------------------------------------------------------------------
 467
 468 function exists_gl_trans($type, $trans_id)
 469 {
 470         $sql = "SELECT type_no FROM ".TB_PREF."gl_trans WHERE type=".db_escape($type)
 471                 ." AND type_no=".db_escape($trans_id);
 472         $result = db_query($sql, "Cannot retreive a gl transaction");
 473
 474     return (db_num_rows($result) > 0);
 475 }
 476
 477 //--------------------------------------------------------------------------------------------------
 478
 479 function void_gl_trans($type, $trans_id, $nested=false)
 480 {
 481         if (!$nested)
 482                 begin_transaction();
 483
 484         $sql = "UPDATE ".TB_PREF."gl_trans SET amount=0 WHERE type=".db_escape($type)
 485         ." AND type_no=".db_escape($trans_id);
 486
 487         db_query($sql, "could not void gl transactions for type=$type and trans_no=$trans_id");
 488
 489         if (!$nested)
 490                 commit_transaction();
 491 }
 492
 493 //----------------------------------------------------------------------------------------
 494
 495 function void_journal_trans($type, $type_no, $use_transaction=true)
 496 {
 497         if ($use_transaction)
 498                 begin_transaction();
 499
 500         void_bank_trans($type, $type_no, true);
 501 //      void_gl_trans($type, $type_no, true);    // this is done above
 502 //      void_trans_tax_details($type, $type_no); // ditto
 503
 504         if ($use_transaction)
 505                 commit_transaction();
 506 }
 507
 508 ?>