sales/includes/sales_db.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 include_once($path_to_root . "/includes/banking.inc");
  13 include_once($path_to_root . "/includes/inventory.inc");
  14 include_once($path_to_root . "/includes/db/allocations_db.inc");
  15 include_once($path_to_root . "/sales/includes/db/sales_order_db.inc");
  16 include_once($path_to_root . "/sales/includes/db/sales_credit_db.inc");
  17 include_once($path_to_root . "/sales/includes/db/sales_invoice_db.inc");
  18 include_once($path_to_root . "/sales/includes/db/sales_delivery_db.inc");
  19 include_once($path_to_root . "/sales/includes/db/sales_types_db.inc");
  20 include_once($path_to_root . "/sales/includes/db/sales_points_db.inc");
  21 include_once($path_to_root . "/sales/includes/db/sales_groups_db.inc");
  22 include_once($path_to_root . "/sales/includes/db/recurrent_invoices_db.inc");
  23 include_once($path_to_root . "/sales/includes/db/custalloc_db.inc");
  24 include_once($path_to_root . "/sales/includes/db/cust_trans_db.inc");
  25 include_once($path_to_root . "/sales/includes/db/cust_trans_details_db.inc");
  26 include_once($path_to_root . "/sales/includes/db/payment_db.inc");
  27 include_once($path_to_root . "/sales/includes/db/branches_db.inc");
  28 include_once($path_to_root . "/sales/includes/db/customers_db.inc");
  29
  30 //----------------------------------------------------------------------------------------
  31 // add a debtor-related gl transaction
  32 // $date_ is display date (non-sql)
  33 // $amount is in CUSTOMER'S currency
  34
  35 function add_gl_trans_customer($type, $type_no, $date_, $account, $dimension, $dimension2,
  36         $amount, $customer_id, $rate=0)
  37 {
  38         return add_gl_trans($type, $type_no, $date_, $account, $dimension, $dimension2, "", $amount,
  39                 get_customer_currency($customer_id),
  40                 PT_CUSTOMER, $customer_id, $rate);
  41 }
  42
  43 //----------------------------------------------------------------------------------------
  44
  45 function get_calculated_price($stock_id, $add_pct)
  46 {
  47         $avg = get_unit_cost($stock_id);
  48         if ($avg == 0)
  49                 return 0;
  50         return round2($avg * (1 + $add_pct / 100), user_price_dec());
  51 }
  52
  53 function round_to_nearest($price, $round_to)
  54 {
  55         if ($price == 0)
  56                 return 0;
  57         $pow = pow(10, user_price_dec());
  58         if ($pow >= $round_to)
  59                 $mod = ($pow % $round_to);
  60         else
  61                 $mod = ($round_to % $pow);
  62         if ($mod != 0)
  63                 $price = ceil($price) - ($pow - $round_to) / $pow;
  64         else
  65         $price = ceil($price * ($pow / $round_to)) / ($pow / $round_to);
  66     return $price;
  67
  68 }
  69
  70 function get_price ($stock_id, $currency, $sales_type_id, $factor=null, $date=null)
  71 {
  72         if ($date == null)
  73             $date = new_doc_date();
  74
  75         if ($factor === null)
  76         {
  77                 $myrow = get_sales_type($sales_type_id);
  78                 $factor = $myrow['factor'];
  79         }
  80
  81         $add_pct = get_company_pref('add_pct');
  82         $base_id = get_base_sales_type();
  83     $home_curr = get_company_currency();
  84         //      AND (sales_type_id = $sales_type_id     OR sales_type_id = $base_id)
  85         $sql = "SELECT price, curr_abrev, sales_type_id
  86                 FROM ".TB_PREF."prices
  87                 WHERE stock_id = ".db_escape($stock_id)."
  88                         AND (curr_abrev = ".db_escape($currency)." OR curr_abrev = ".db_escape($home_curr).")";
  89
  90         $result = db_query($sql, "There was a problem retrieving the pricing information for the part $stock_id for customer");
  91         $num_rows = db_num_rows($result);
  92         $rate = round2(get_exchange_rate_from_home_currency($currency, $date),
  93             user_exrate_dec());
  94         $round_to = get_company_pref('round_to');
  95         $prices = array();
  96         while($myrow = db_fetch($result))
  97         {
  98             $prices[$myrow['sales_type_id']][$myrow['curr_abrev']] = $myrow['price'];
  99         }
 100         $price = false;
 101         if (isset($prices[$sales_type_id][$currency]))
 102         {
 103             $price = $prices[$sales_type_id][$currency];
 104         }
 105         elseif (isset($prices[$base_id][$currency]))
 106         {
 107             $price = $prices[$base_id][$currency] * $factor;
 108         }
 109         elseif (isset($prices[$sales_type_id][$home_curr]))
 110         {
 111             $price = $prices[$sales_type_id][$home_curr] / $rate;
 112         }
 113         elseif (isset($prices[$base_id][$home_curr]))
 114         {
 115             $price = $prices[$base_id][$home_curr] * $factor / $rate;
 116         }
 117         elseif ($num_rows == 0 && $add_pct != -1)
 118         {
 119                 $price = get_calculated_price($stock_id, $add_pct);
 120                 if ($currency != $home_curr)
 121                         $price /= $rate;
 122                 if ($factor != 0)
 123                         $price *= $factor;
 124         }
 125         if ($price === false)
 126                 return 0;
 127         elseif ($round_to != 1)
 128                 return round_to_nearest($price, $round_to);
 129         else
 130                 return round2($price, user_price_dec());
 131 }
 132 //----------------------------------------------------------------------------------------
 133 //
 134 //      Get price for given item or kit.
 135 //  When $std==true price is calculated as a sum of all included stock items,
 136 //      otherwise all prices set for kits and items are accepted.
 137 //
 138 function get_kit_price($item_code, $currency, $sales_type_id, $factor=null,
 139         $date=null, $std = false)
 140 {
 141         $kit_price = 0.00;
 142         if (!$std) {
 143                 $kit_price = get_price( $item_code, $currency, $sales_type_id,
 144                         $factor, $date);
 145
 146                 if ($kit_price !== 0) {
 147                         return $kit_price;
 148                 }
 149         }
 150         // no price for kit found, get total value of all items
 151         $kit = get_item_kit($item_code);
 152
 153         while($item = db_fetch($kit)) {
 154                 if ($item['item_code'] != $item['stock_id']) {
 155                         // foreign/kit code
 156                         $kit_price += $item['quantity'] * get_kit_price( $item['stock_id'],
 157                                 $currency, $sales_type_id, $factor, $date, $std);
 158
 159                 } else {
 160                         // stock item
 161                         $kit_price += $item['quantity'] * get_price( $item['stock_id'],
 162                                 $currency, $sales_type_id, $factor, $date);
 163                 }
 164         }
 165         return $kit_price;
 166 }
 167
 168 //--------------------------------------------------------------------------------------------------
 169 function update_parent_line($doc_type, $line_id, $qty_dispatched, $auto=false)
 170 {
 171         $doc_type = get_parent_type($doc_type);
 172
 173         $qty_dispatched = (float)$qty_dispatched;
 174
 175         if ($doc_type == 0)
 176                 return false;
 177         else {
 178                 if ($doc_type==ST_SALESORDER || $doc_type==ST_SALESQUOTE)
 179                 {
 180                         $sql = "UPDATE ".TB_PREF."sales_order_details
 181                                 SET qty_sent = qty_sent + $qty_dispatched";
 182                         if ($auto)
 183                                 $sql .= ", quantity = quantity + $qty_dispatched";
 184                         $sql .= " WHERE id=".db_escape($line_id);
 185                 }
 186                 else
 187                         $sql = "UPDATE ".TB_PREF."debtor_trans_details
 188                                 SET qty_done = qty_done + $qty_dispatched
 189                                 WHERE id=".db_escape($line_id);
 190         }
 191         db_query($sql, "The parent document detail record could not be updated");
 192         return true;
 193 }
 194
 195 //--------------------------------------------------------------------------------------------------
 196 // find inventory location for given transaction
 197 //
 198 function get_location(&$cart)
 199 {
 200         $sql = "SELECT location.*
 201                 FROM ".TB_PREF."stock_moves move,"
 202                         .TB_PREF."locations location".
 203                 " WHERE type=".db_escape($cart->trans_type).
 204                 " AND trans_no=".key($cart->trans_no).
 205                 " AND qty!=0 ".
 206                 " AND location.loc_code=move.loc_code";
 207
 208         $result = db_query($sql, 'Retreiving inventory location');
 209
 210         if (db_num_rows($result)) {
 211                 return db_fetch($result);
 212         }
 213         return null;
 214 }
 215 //--------------------------------------------------------------------------------------------------
 216 // Generic read debtor transaction into cart
 217 //
 218 //      $trans_no - array of trans nums; special case trans_no==0 - new doc
 219 //
 220 function read_sales_trans($doc_type, $trans_no, &$cart)
 221 {
 222         if (!is_array($trans_no) && $trans_no)
 223                 $trans_no = array($trans_no);
 224
 225         $cart->trans_type = $doc_type;
 226         if (!$trans_no) { // new document
 227                 $cart->trans_no = $trans_no;
 228         } else {
 229                 // read header data from first document
 230                 $myrow = get_customer_trans($trans_no[0],$doc_type);
 231                 if (count_array($trans_no)>1)
 232                         $cart->trans_no = get_customer_trans_version($doc_type, $trans_no);
 233                 else
 234                         $cart->trans_no = array($trans_no[0]=>$myrow["version"]);
 235
 236                 $cart->set_sales_type($myrow["tpe"], $myrow["sales_type"], $myrow["tax_included"],0);
 237
 238                 $cart->set_customer($myrow["debtor_no"], $myrow["DebtorName"],
 239                         $myrow["curr_code"], $myrow["discount"], $myrow["payment_terms"]);
 240
 241                 $cart->set_branch($myrow["branch_code"], $myrow["tax_group_id"],
 242                         $myrow["tax_group_name"]);
 243
 244                 $cart->reference = $myrow["reference"];
 245                 $cart->prepaid = $myrow["prepaid"];
 246                 $cart->order_no = $myrow["order_"];
 247                 $cart->due_date = sql2date($myrow["due_date"]);
 248                 $cart->document_date = sql2date($myrow["tran_date"]);
 249                 $cart->dimension_id = $myrow['dimension_id']; // added 2.1 Joe Hunt 2008-11-12
 250                 $cart->dimension2_id = $myrow['dimension2_id'];
 251                 $cart->Comments = '';
 252                 foreach ( $trans_no as $trans ) {
 253                         $cart->Comments .= get_comments_string($doc_type,$trans);
 254                 }
 255
 256                 // FIX this should be calculated sum() for multiply parents
 257
 258                 $cart->set_delivery($myrow["ship_via"], $myrow["br_name"],
 259                 $myrow["br_address"], $myrow["ov_freight"]);
 260
 261                 $location = 0;
 262                 $myrow = get_location($cart); // find location from movement
 263
 264                 if($myrow!=null) {
 265                         $cart->set_location($myrow['loc_code'], $myrow['location_name']);
 266                 }
 267
 268                 $result = get_customer_trans_details($doc_type,$trans_no);
 269                 if (db_num_rows($result) > 0) {
 270                         for($line_no=0; $myrow = db_fetch($result); $line_no++) {
 271                                 $cart->add_to_cart($line_no, $myrow["stock_id"],$myrow["quantity"],
 272                                         $myrow["unit_price"], $myrow["discount_percent"],
 273                                         $myrow["qty_done"], $myrow["unit_cost"],
 274                                         $myrow["StockDescription"],$myrow["id"], $myrow["debtor_trans_no"],
 275                                         @$myrow["src_id"]);
 276                         }
 277                 }
 278                 $cart->prepayments = get_payments_for($trans_no, $doc_type, $myrow["debtor_no"]);
 279
 280         } // !newdoc
 281
 282         return true;
 283 }
 284 //----------------------------------------------------------------------------------------
 285
 286 function get_sales_child_lines($trans_type, $trans_no, $lines=true)
 287 {
 288         if (!($ctype = get_child_type($trans_type)))
 289                 return false;
 290         if (!is_array($trans_no)) {
 291                 $trans_no = array($trans_no);
 292         }
 293
 294         $par_tbl = $trans_type == ST_SALESORDER ? "sales_order_details" : "debtor_trans_details";
 295         $par_no = $trans_type == ST_SALESORDER ? "trans.order_no" : "trans.debtor_trans_no";
 296
 297         foreach($trans_no as $n => $trans) {
 298                 $trans_no[$n] = db_escape($trans);
 299         }
 300         $sql = "SELECT child.*
 301                         FROM
 302                                 ".TB_PREF."debtor_trans_details child
 303                         LEFT JOIN ".TB_PREF."$par_tbl trans
 304                                 ON child.src_id=trans.id AND child.debtor_trans_type=$ctype
 305                         WHERE $par_no IN(". implode(',', array_values($trans_no)).")";
 306
 307         if (!$lines)
 308                 $sql .= " GROUP BY child.debtor_trans_no";
 309
 310         $sql .= " ORDER BY child.debtor_trans_no";
 311
 312         return db_query($sql, "can't retrieve child trans");
 313 }
 314
 315 function get_sales_child_numbers($trans_type, $trans_no)
 316 {
 317         $trans = array();
 318         $res = get_sales_child_lines($trans_type, $trans_no, false);
 319         while ($line = db_fetch($res)) {
 320                 $trans[] = $line['debtor_trans_no'];
 321         }
 322         return $trans;
 323 }
 324
 325 function get_sales_parent_lines($trans_type, $trans_no, $lines=true)
 326 {
 327         $partype = get_parent_type($trans_type);
 328
 329         if (!$partype)
 330                 return false;
 331
 332         $par_tbl = $partype == ST_SALESORDER ? "sales_order_details" : "debtor_trans_details";
 333         $par_no = $partype == ST_SALESORDER ? "parent.order_no" : "parent.debtor_trans_no";
 334         $sql = "SELECT parent.*
 335                         FROM
 336                                 ".TB_PREF."$par_tbl parent
 337                         LEFT JOIN ".TB_PREF."debtor_trans_details trans
 338                                 ON trans.src_id=parent.id
 339                         WHERE
 340                                 trans.debtor_trans_type=".db_escape($trans_type)
 341                                 ." AND trans.debtor_trans_no=".db_escape($trans_no);
 342         if (!$lines)
 343                 $sql .= " GROUP BY $par_no";
 344
 345         $sql .= " ORDER BY $par_no";
 346
 347         return db_query($sql, "can't retrieve child trans");
 348
 349 }
 350
 351 function get_sales_parent_numbers($trans_type, $trans_no)
 352 {
 353         $trans = array();
 354         $res = get_sales_parent_lines($trans_type, $trans_no, false);
 355         while ($line = db_fetch($res))
 356                 $trans[] = $line[$trans_type==ST_CUSTDELIVERY ? 'order_no' : 'debtor_trans_no'];
 357         return $trans;
 358 }
 359
 360 //----------------------------------------------------------------------------------------
 361
 362 function get_sales_child_documents($trans_type, $trans_no)
 363 {
 364         // FIXME -  credit notes retrieved here should be those linked to invoices containing
 365         // at least one line from related invoice
 366
 367         if (!count_array($trans_no))
 368                 return false;
 369         $childs = get_sales_child_numbers($trans_type, $trans_no, false);
 370         if (!count_array($childs))
 371                 return false;
 372
 373         $sql = "SELECT * FROM ".TB_PREF."debtor_trans
 374                 WHERE type=".get_child_type($trans_type)." AND trans_no IN(". implode(',', array_values($childs)).")";
 375
 376         return db_query($sql,"The related credit notes could not be retreived");
 377 }
 378
 379 //-------------------------------- Backend interfaces -------------------------------------
 380
 381
 382 function write_sales_trans($cart, $policy = 0)
 383 {
 384         begin_transaction(__FUNCTION__, func_get_args());
 385         $result = $cart->write($policy);
 386         commit_transaction();
 387         return $result;
 388 }
 389
 390 function save_cust_payment($cart, $customer_id, $branch_id,
 391                 $bank_account, $trans_date, $ref, $amount, $memo, $charge, $bank_amount)
 392 {
 393         begin_transaction(__FUNCTION__, func_get_args());
 394
 395         $discount = 0;
 396         foreach($cart->allocs as $alloc)
 397                 if ($alloc->discount_confirmed)
 398                         $discount += $alloc->early_discount*$alloc->amount;
 399
 400         $payment_no = write_customer_payment($cart->trans_no, $customer_id, $branch_id,
 401                 $bank_account, $trans_date, $ref, $amount, $discount, $memo, 0, $charge, $bank_amount);
 402
 403         $cart->trans_no = $payment_no;
 404         $cart->date_ = $trans_date;
 405         $cart->write();
 406
 407         commit_transaction();
 408         return $payment_no;
 409 }
 410
 411 function create_recurrent_invoices($id, $from, $to, $date, $memo)
 412 {
 413         /*
 414                 whole invoiced time is <begin, end>
 415                 invoices are issued _after_ invoiced period is gone, eg:
 416                 begin 1.1
 417                 end   31.3
 418                 period:    invoice ready for issue since:
 419                 1.1-31.1 -  1.2
 420                 1.2-28.2 -  1.3
 421                 1.3-31.3 -  1.4
 422                 In example above, when end is set to 1.4 will generate additional invoice on 1.5 !
 423         */
 424         log_user();
 425
 426         $myrow = get_recurrent_invoice($id);
 427
 428         $invs = array();
 429         if (recurrent_invoice_ready($id, $date))
 430         {
 431
 432                 begin_transaction(__FUNCTION__, func_get_args());
 433                         if ($myrow['debtor_no'] == 0)
 434                         {
 435                                 $cust = get_cust_branches_from_group($myrow['group_no']);
 436                                 while ($row = db_fetch($cust))
 437                                 {
 438                                         $invs[] = create_template_invoice($row['debtor_no'], $row['branch_code'], $myrow['order_no'], $myrow['id'],
 439                                                 $date, $from, $to, $memo);
 440                                 }
 441                         }
 442                         else
 443                         {
 444                                 $invs[] = create_template_invoice($myrow['debtor_no'], $myrow['group_no'], $myrow['order_no'], $myrow['id'],
 445                                         $date, $from, $to, $memo);
 446                         }
 447                 commit_transaction();
 448         }
 449         return $invs;
 450 }
 451
 452 function write_recurrent_invoice($invoice_id, $description, $order_no, $debtor_no, $group_no,
 453         $days, $monthly, $begin, $end, $last_sent)
 454 {
 455         begin_transaction(__FUNCTION__, func_get_args());
 456
 457                 if ($invoice_id != -1)
 458         {
 459                 update_recurrent_invoice($invoice_id, $description, $order_no, $debtor_no, $group_no,
 460                                 $days, $monthly, $begin, $end);
 461                 if (isset($last_sent))
 462                                 update_last_sent_recurrent_invoice($invoice_id, $last_sent);
 463         }
 464         else
 465         {
 466                 add_recurrent_invoice($description, $order_no, $debtor_no, $group_no,
 467                         $days, $monthly, $begin, $end);
 468         }
 469         commit_transaction();
 470 }
 471
 472 function write_customer($customer_id, $name, $ref, $address, $tax_id, $curr_code, $dim1, $dim2, $credit_status,
 473          $payment_terms, $discount, $credit_limit, $sales_type, $notes, $inactive, $salesman, $area,
 474          $tax_group, $location, $ship_via, $bank_account, $phone, $phone2, $fax, $email)
 475 {
 476         global $SysPrefs;
 477
 478         begin_transaction(__FUNCTION__, func_get_args());
 479
 480         if ($customer_id) {
 481                 update_customer($customer_id, $name, $ref, $address, $tax_id, $curr_code, $dim1, $dim2, $credit_status,
 482                          $payment_terms, $discount/100, $credit_limit, $sales_type, $notes, $inactive);
 483
 484                 update_record_status($customer_id, $inactive, 'debtors_master', 'debtor_no');
 485
 486         } else {
 487                 add_customer($name, $ref, $address,     $tax_id, $curr_code, $dim1, $dim2, $credit_status, $payment_terms,
 488                         $discount / 100, $credit_limit, $sales_type, $notes);
 489
 490                 $customer_id = db_insert_id();
 491
 492                 if (isset($SysPrefs->auto_create_branch) && $SysPrefs->auto_create_branch == 1)
 493                 {
 494                 add_branch($customer_id, $name, $ref, $address, $salesman, $area, $tax_group, '',
 495                 get_company_pref('default_sales_discount_act'),
 496                 get_company_pref('debtors_act'),
 497                 get_company_pref('default_prompt_payment_act'),
 498                 $location, $address, 0, $ship_via, $notes, $bank_account);
 499
 500                 $selected_branch = db_insert_id();
 501
 502                         add_crm_person($ref, $name, '', $address, $phone, $phone2, $fax, $email, '', '');
 503
 504                         $pers_id = db_insert_id();
 505                         add_crm_contact('cust_branch', 'general', $selected_branch, $pers_id);
 506
 507                         add_crm_contact('customer', 'general', $customer_id, $pers_id);
 508                 }
 509         }
 510         commit_transaction();
 511
 512         return $customer_id;
 513 }
 514
 515 function write_cust_branch($id, $customer_id, $name, $ref, $br_address, $salesman, $area, $tax_group,
 516         $sales_act, $discount_act, $ar_act, $payment_discount_act, $location, $post_address, $group_no, $ship_via, $notes, $bank_act,
 517         $contact_name, $phone, $phone2,$fax, $email, $lang)
 518 {
 519
 520         begin_transaction(__FUNCTION__, func_get_args());
 521
 522         if ($id !== 0) {
 523                                 update_branch($customer_id, $id, $name, $ref, $br_address, $salesman, $area, $tax_group, $sales_act,
 524                                         $discount_act, $ar_act, $discount_act, $location, $post_address, $group_no,
 525                                         $ship_via, $notes, $bank_act);
 526         } else {
 527                                 add_branch($customer_id, $name, $ref, $br_address, $salesman, $area, $tax_group, $sales_act,
 528                                         $discount_act, $ar_act, $payment_discount_act, $location, $post_address, $group_no,
 529                                         $ship_via, $notes, $bank_act);
 530
 531                                 $branch_id = db_insert_id();
 532
 533                                 add_crm_person($contact_name, $contact_name, '', $post_address, $phone, $phone2, $fax, $email, $lang, '');
 534
 535                                 add_crm_contact('cust_branch', 'general', $branch_id, db_insert_id());
 536
 537         }
 538         commit_transaction();
 539 }
 540
 541 function write_cust_allocation($cart)
 542 {
 543         begin_transaction(__FUNCTION__, func_get_args());
 544                 $result = $cart->write();
 545         commit_transaction();
 546         return $result;
 547 }
 548