sales/includes/cart_class.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 /* Definition of the cart class
  13 this class can hold all the information for:
  14
  15 i)   a sales order
  16 ii)  an invoice
  17 iii) a credit note
  18 iv)  a delivery note
  19 */
  20
  21 include_once($path_to_root . "/inventory/includes/inventory_db.inc");
  22 include_once($path_to_root . "/taxes/tax_calc.inc");
  23
  24 class cart
  25 {
  26         var $trans_type; // invoice, order, quotation, delivery note ...
  27         var $trans_no = array();// array (num1=>ver1,..) or 0 for new
  28         var $so_type = 0;               // for sales order: simple=0 template=1
  29         var $cart_id;           // used to detect multi-tab edition conflits
  30         var $line_items;  //array of objects of class line_details
  31
  32         var $src_docs = array();        // array of arrays(num1=>ver1,...) or 0 for no src
  33         var $src_date;                  // src document date (for info only)
  34
  35         var $document_date;
  36         var $due_date;
  37         var $sales_type; // set to the customer's sales type
  38         var $sales_type_name; // set to customer's sales type name
  39         var $tax_included;
  40
  41         var $customer_currency; // set to the customer's currency
  42         var $default_discount; // set to the customer's discount %
  43         var $customer_name;
  44         var $customer_id;
  45         var $Branch;
  46         var $email;
  47
  48         var $deliver_to;
  49         var $delivery_address;
  50         var $phone;
  51
  52         var $cust_ref;
  53         var $reference;
  54         var $Comments;
  55         var $Location;
  56         var $location_name;
  57         var $order_no;          // the original order number
  58
  59         var $ship_via;
  60         var $freight_cost = 0;
  61
  62         var $tax_group_id;
  63         var $tax_group_name;
  64         var $tax_group_array = null; // saves db queries
  65         var $price_factor;       // ditto for price calculations
  66
  67         var     $pos;                   // user assigned POS
  68         var $cash_account;
  69         var $account_name;
  70         var $cash_discount;     // not used as of FA 2.1
  71         var $dimension_id;
  72         var $dimension2_id;
  73         var $payment;
  74         var $payment_terms; // cached payment terms
  75         var $credit;
  76         // prepayment mode:
  77         var $prepaid;           // true for documents issued in prepayment mode
  78         var $prep_amount;       // prepayment required for SO, invoiced amount for prepaiament invoice
  79         var $sum_paid;          // sum of all allocated prepayments both to order and related invoices
  80         var $alloc;             // sum of payments allocated to this document
  81         var $prepayments = array(); // allocation records for this document
  82         var $ex_rate;
  83
  84         var $fixed_asset = false;
  85
  86         //-------------------------------------------------------------------------
  87         //
  88         //  $trans_no==0 => open new/direct document
  89         //  $trans_no!=0 && $prepare_child==false => update with parent constarints for reedition
  90         //  $trans_no!=0 && $prepare_child==true => prepare for child doc entry
  91         //      $prepare_child is set to ST_SALESINVOICE for prepayment invoices
  92         //
  93         function Cart($type, $trans_no=0, $prepare_child=false) {
  94                 /*Constructor function initialises a new shopping cart */
  95                 $this->line_items = array();
  96                 $this->sales_type = "";
  97                 if ($type == ST_SALESQUOTE)
  98                         $this->trans_type = $type;
  99                 else
 100                         $this->trans_type = ST_SALESORDER;
 101                 $this->dimension_id = 0;
 102                 $this->dimension2_id = 0;
 103                 $this->pos = get_sales_point(user_pos());
 104                 $this->read($type, $trans_no, $prepare_child);
 105                 $this->cart_id = uniqid('');
 106         }
 107
 108         /*
 109                 Optional sorting items by stock_id.
 110         */
 111         function _cmp_lines($a, $b)
 112         {
 113                 return strcmp($a->stock_id, $b->stock_id);
 114         }
 115
 116         /*
 117                 Returns items array optionally sorted by item code.
 118         */
 119         function get_items()
 120         {
 121                 global $SysPrefs;
 122
 123                 $items = $this->line_items;
 124                 if (@$SysPrefs->sort_sales_items)
 125                         uasort($items, array($this, '_cmp_lines'));
 126
 127                 return $items;
 128         }
 129         //
 130         //      Prepare cart to new child document entry, just after initial parent doc read.
 131         //
 132         function prepare_child($type)
 133         {
 134                 global $Refs;
 135
 136                 if ($type === true)
 137                         $type = get_child_type($this->trans_type);
 138
 139                 $this->trans_type = $type;
 140                 $this->reference = $Refs->get_next($this->trans_type, null, array('date' => $this->document_date,
 141                         'customer' => $this->customer_id, 'branch' => $this->Branch));
 142                 if ($type == ST_CUSTCREDIT)
 143                     $this->src_date = $this->document_date;
 144
 145                 $this->document_date = new_doc_date();
 146
 147                 for($line_no = 0; $line_no < count($this->line_items); $line_no++) {
 148                         $line = &$this->line_items[$line_no];
 149                         $line->src_id = $line->id; // save src line ids for update
 150                         $line->qty_dispatched = $type == ST_CUSTCREDIT ? '0' :
 151                                  (($this->prepaid && $type == ST_SALESINVOICE) ? $line->quantity : $line->quantity - $line->qty_done);
 152                         $line->qty_old = 0;
 153                 }
 154                 unset($line);
 155
 156                 if ($type == ST_CUSTDELIVERY) {
 157                         $this->order_no = key($this->trans_no);
 158                         $cust = get_customer($this->customer_id);
 159                         $this->dimension_id = $cust['dimension_id'];
 160                         $this->dimension2_id = $cust['dimension2_id'];
 161                 }
 162                 if ($type == ST_SALESINVOICE) {
 163                         $this->due_date = get_invoice_duedate($this->payment, $this->document_date);
 164                 }
 165
 166                 $this->src_docs = $this->trans_no;
 167                 $this->trans_no = 0;
 168         }
 169
 170         //
 171         //      Prepares transaction for reedition updating with parent transaction data
 172         //
 173         function set_parent_constraints($sodata, $src_no) {
 174
 175                 $srcdetails = get_sales_parent_lines($this->trans_type, $src_no);
 176                 $src_type = get_parent_type($this->trans_type);
 177
 178                 // calculate & save: qtys on other docs and free qtys on src doc
 179                 $line_no = 0; $src_docs = array();
 180                 // Loop speed optimisation below depends on fact
 181                 // that child line_items contains subset of parent lines in _the_same_ order !
 182                 while (($line_no < count($this->line_items)) && ($srcline = db_fetch($srcdetails))) {
 183                         $line = &$this->line_items[$line_no];
 184                         $src_docs[] = $src_type == ST_SALESORDER ?  $srcline['order_no'] : $srcline['debtor_trans_no'];
 185                         while($srcline['id'] != $line->src_id) // Logic : This will increment the line_items array till sales_order line is matched.
 186                         {       // Fixes Delivery note bug : Parent constraints not working if sales order line deleted after delivery
 187                         $line_no++;
 188                         $line = &$this->line_items[$line_no];
 189                         }
 190                         if ($srcline['id'] == $line->src_id) {
 191                                 if ($this->trans_type == ST_SALESINVOICE)
 192                                         $line->src_no = $srcline['debtor_trans_no'];
 193                                 $line->qty_old = $line->qty_dispatched = $line->quantity;
 194                                 $line->quantity += $srcline['quantity'] -
 195                                         ($src_type==ST_SALESORDER ? $srcline['qty_sent'] : $srcline['qty_done']); // add free qty on src doc
 196                                 $line_no++;
 197                         }
 198                 }
 199
 200                 if ($src_type == ST_SALESORDER || $src_type == 0) {
 201                         $this->src_docs = array( $sodata['order_no']=>$sodata['version']);
 202                 } else {
 203                         // get src_data from debtor_trans
 204                         $this->src_docs = get_customer_trans_version($src_type, array_unique($src_docs));
 205                 }
 206         }
 207         //-------------------------------------------------------------------------
 208         // Reading document into cart
 209         //
 210         function read($type, $trans_no=0, $prepare_child=false) {
 211
 212                 global $SysPrefs, $Refs;
 213
 214                 if (!is_array($trans_no)) $trans_no = array($trans_no);
 215
 216                 if ($trans_no[0]) { // read old transaction
 217                         if ($type == ST_SALESORDER || $type == ST_SALESQUOTE) { // sales order || sales quotation
 218                                 read_sales_order($trans_no[0], $this, $type);
 219                         } else {        // other type of sales transaction
 220                                 read_sales_trans($type, $trans_no, $this);
 221                                 $this->prepayments = get_payments_for($trans_no[0], $type);
 222                                 if ($this->order_no) { // free hand credit notes have no order_no
 223                                         $sodata = get_sales_order_header($this->order_no, ST_SALESORDER);
 224                                         $this->cust_ref = $sodata["customer_ref"];
 225                                 // currently currency is hard linked to debtor account
 226                                         $this->delivery_to = $sodata["deliver_to"];
 227                                         $this->delivery_address = $sodata["delivery_address"];
 228                                 // child transaction reedition - update with parent info unless it is freehand
 229                                 if (!$this->is_prepaid() && !$prepare_child) // this is read for view/reedition
 230                                         $this->set_parent_constraints($sodata, $trans_no[0]);
 231                                 }
 232                         }
 233                         // convert document into child and prepare qtys for entry
 234                         if ($prepare_child)
 235                                 $this->prepare_child($prepare_child);
 236
 237                 } else { // new document
 238                         $this->trans_type = $type;
 239                         $this->trans_no = 0;
 240                         $this->customer_currency = get_company_currency();
 241                         // set new sales document defaults here
 242                         if (get_global_customer() != ALL_TEXT)
 243                           $this->customer_id = get_global_customer();
 244                         else
 245                           $this->customer_id = '';
 246                         $this->document_date = new_doc_date();
 247                         if (!is_date_in_fiscalyear($this->document_date))
 248                                 $this->document_date = end_fiscalyear();
 249                         $this->reference = $Refs->get_next($this->trans_type, null, array('date' => Today(),
 250                                 'customer' => $this->customer_id));
 251                         if ($type != ST_SALESORDER && $type != ST_SALESQUOTE) // Added 2.1 Joe Hunt 2008-11-12
 252                         {
 253                                 $dim = get_company_pref('use_dimension');
 254                                 if ($dim > 0)
 255                                 {
 256                                         if ($this->customer_id == '')
 257                                                 $this->dimension_id = 0;
 258                                         else
 259                                         {
 260                                                 $cust = get_customer($this->customer_id);
 261                                                 $this->dimension_id = $cust['dimension_id'];
 262                                         }
 263                                         if ($dim > 1)
 264                                         {
 265                                                 if ($this->customer_id == '')
 266                                                         $this->dimension2_id = 0;
 267                                                 else
 268                                                         $this->dimension2_id = $cust['dimension2_id'];
 269                                         }
 270                                 }
 271                         }
 272                         if ($type == ST_SALESINVOICE) {
 273                                 $this->due_date =
 274                                         get_invoice_duedate($this->payment, $this->document_date);
 275                         } else
 276                                 $this->due_date =
 277                                         add_days($this->document_date, $SysPrefs->default_delivery_required_by());
 278                 }
 279                 $this->credit = get_current_cust_credit($this->customer_id);
 280         }
 281
 282         //-------------------------------------------------------------------------
 283         // Writing new/modified sales document to database.
 284         // Makes parent documents for direct delivery/invoice by recurent call.
 285         // $policy - 0 or 1:  writeoff/return for IV, back order/cancel for DN
 286         function write($policy=0) {
 287
 288                 begin_transaction(); // prevents partial database changes in case of direct delivery/invoice
 289                 if ($this->reference != 'auto' && $this->trans_no == 0 && !is_new_reference($this->reference, $this->trans_type))
 290                 {
 291                         commit_transaction();
 292                         return -1;
 293                 }
 294                 if (count($this->src_docs) == 0 && ($this->trans_type == ST_SALESINVOICE || $this->trans_type == ST_CUSTDELIVERY) && !$this->is_prepaid()) {
 295                         // this is direct document - first add parent
 296                         $ref = $this->reference;
 297                         $date = $this->document_date;
 298                         $due_date = $this->due_date;
 299                         $dimension_id = $this->dimension_id;
 300                         $dimension2_id = $this->dimension2_id;
 301                         $this->trans_type = get_parent_type($this->trans_type);
 302
 303                         $this->reference = 'auto';
 304                         $trans_no = $this->write(1);
 305
 306                         // re-read parent document converting it to child
 307                         $this->read($this->trans_type, $trans_no, true);
 308                         $this->document_date = $date;
 309                         $this->reference = $ref;
 310                         $this->due_date = $due_date;
 311                         $this->dimension_id = $dimension_id;
 312                         $this->dimension2_id = $dimension2_id;
 313                 }
 314                 $this->reference = @html_entity_decode($this->reference, ENT_QUOTES);
 315                 $this->Comments = @html_entity_decode($this->Comments, ENT_QUOTES);
 316                 foreach($this->line_items as $lineno => $line) {
 317                         $this->line_items[$lineno]->stock_id = @html_entity_decode($line->stock_id, ENT_QUOTES);
 318                         $this->line_items[$lineno]->item_description = @html_entity_decode($line->item_description, ENT_QUOTES);
 319                 }
 320                 switch($this->trans_type) {
 321                         case ST_SALESINVOICE:
 322                                 $ret = write_sales_invoice($this); break;
 323                         case ST_CUSTCREDIT:
 324                                 $ret = write_credit_note($this, $policy); break;
 325                         case ST_CUSTDELIVERY:
 326                                 $ret = write_sales_delivery($this, $policy); break;
 327                         case ST_SALESORDER:
 328                         case ST_SALESQUOTE:
 329                                 if ($this->trans_no==0) // new document
 330                                         $ret = add_sales_order($this);
 331                                 else
 332                                         $ret = update_sales_order($this);
 333                 }
 334
 335                 commit_transaction();
 336
 337                 return $ret;
 338         }
 339
 340         function set_customer($customer_id, $customer_name, $currency, $discount, $payment, $cdiscount=0)
 341         {
 342                 $this->customer_name = $customer_name;
 343                 $this->customer_id = $customer_id;
 344                 $this->default_discount = $discount;
 345                 $this->customer_currency = $currency;
 346                 $this->payment = $payment;
 347                 $this->payment_terms = get_payment_terms($payment);
 348                 $this->cash_discount = $cdiscount;
 349
 350                 if ($this->payment_terms['cash_sale']) {
 351                         $this->Location = $this->pos['pos_location'];
 352                         $this->location_name = $this->pos['location_name'];
 353                 }
 354                 $this->credit = get_current_cust_credit($customer_id);
 355         }
 356
 357         function set_branch($branch_id, $tax_group_id, $tax_group_name, $phone='', $email='')
 358         {
 359                 $this->Branch = $branch_id;
 360                 $this->phone = $phone;
 361                 $this->email = $email;
 362                 $this->tax_group_id = $tax_group_id;
 363                 $this->tax_group_array = get_tax_group_items_as_array($tax_group_id);
 364         }
 365
 366         function set_sales_type($sales_type, $sales_name, $tax_included=0, $factor=0)
 367         {
 368             $this->sales_type = $sales_type;
 369             $this->sales_type_name = $sales_name;
 370             $this->tax_included = $tax_included;
 371             $this->price_factor = $factor;
 372         }
 373
 374         function set_location($id, $name)
 375         {
 376                 $this->Location = $id;
 377                 $this->location_name = $name;
 378         }
 379
 380         function set_delivery($shipper, $destination, $address, $freight_cost=null)
 381         {
 382                 $this->ship_via = $shipper;
 383                 $this->deliver_to = $destination;
 384                 $this->delivery_address = $address;
 385                 if (isset($freight_cost))
 386                         $this->freight_cost = $freight_cost;
 387         }
 388
 389         function add_to_cart($line_no, $stock_id, $qty, $price, $disc, $qty_done=0, $standard_cost=0, $description=null, $id=0, $src_no=0,
 390                 $src_id=0)
 391         {
 392                 $line = new line_details($stock_id, $qty, $price, $disc,
 393                         $qty_done,  $standard_cost, $description, $id, $src_no, $src_id);
 394
 395                 if ($line->valid) {
 396                         $this->line_items[$line_no] = $line;
 397                         return 1;
 398                 } else
 399                         display_error(_("You have to enter valid stock code or nonempty description"));
 400                 return 0;
 401         }
 402
 403         function update_cart_item($line_no, $qty, $price, $disc, $description="")
 404         {
 405                 if ($description != "")
 406                         $this->line_items[$line_no]->item_description = $description;
 407                 $this->line_items[$line_no]->quantity = $qty;
 408                 $this->line_items[$line_no]->qty_dispatched = $qty;
 409                 $this->line_items[$line_no]->price = $price;
 410                 $this->line_items[$line_no]->discount_percent = $disc;
 411         }
 412
 413         function update_add_cart_item_qty($line_no, $qty)
 414         {
 415                 $this->line_items[$line_no]->quantity += $qty;
 416         }
 417
 418         function remove_from_cart($line_no)
 419         {
 420                 array_splice($this->line_items, $line_no, 1);
 421         }
 422
 423         function clear_items()
 424         {
 425                 unset($this->line_items);
 426                 $this->line_items = array();
 427                 $this->sales_type = "";
 428                 $this->trans_no = 0;
 429                 $this->customer_id = $this->order_no = 0;
 430         }
 431
 432         function count_items()
 433         {
 434                 $counter=0;
 435                 foreach ($this->line_items as $line) {
 436                         if ($line->quantity!=$line->qty_done) $counter++;
 437                 }
 438                 return $counter;
 439         }
 440
 441         function get_items_total()
 442         {
 443                 $total = 0;
 444
 445                 foreach ($this->line_items as $ln_itm) {
 446                         $price = $ln_itm->line_price();
 447                         $total += round($ln_itm->quantity * $price * (1 - $ln_itm->discount_percent),
 448                            user_price_dec());
 449                 }
 450                 return $total;
 451         }
 452
 453         function get_items_total_dispatch()
 454         {
 455                 $total = 0;
 456
 457                 foreach ($this->line_items as $ln_itm) {
 458                         $price = $ln_itm->line_price();
 459                         $total += round(($ln_itm->qty_dispatched * $price * (1 - $ln_itm->discount_percent)),
 460                            user_price_dec());
 461                 }
 462                 return $total;
 463         }
 464
 465         function has_items_dispatch()
 466         {
 467                 foreach ($this->line_items as $ln_itm) {
 468                         if ($ln_itm->qty_dispatched > 0)
 469                                 return true;
 470                 }
 471                 return false;
 472         }
 473
 474         function any_already_delivered()
 475         {
 476                 /* Checks if there have been any line item processed */
 477
 478                 foreach ($this->line_items as $stock_item) {
 479                         if ($stock_item->qty_done !=0) {
 480                                 return 1;
 481                         }
 482                 }
 483
 484                 return 0;
 485
 486         }
 487
 488         function some_already_delivered($line_no)
 489         {
 490                 /* Checks if there have been deliveries of a specific line item */
 491                 if (isset($this->line_items[$line_no]) &&
 492                         $this->line_items[$line_no]->qty_done != 0) {
 493                         return 1;
 494                 }
 495                 return 0;
 496         }
 497
 498         function get_taxes($shipping_cost=null)
 499         {
 500                 $items = array();
 501                 $prices = array();
 502                 if($shipping_cost==null)
 503                         $shipping_cost = $this->freight_cost;
 504
 505                 foreach ($this->line_items as $ln_itm) {
 506                         $items[] = $ln_itm->stock_id;
 507                         $prices[] = round(((
 508                                 $this->trans_type==ST_SALESORDER ?      $ln_itm->quantity : $ln_itm->qty_dispatched) *
 509                                 $ln_itm->line_price()* (1 - $ln_itm->discount_percent)),  user_price_dec());
 510                 }
 511
 512                 $taxes = get_tax_for_items($items, $prices, $shipping_cost,
 513                         $this->tax_group_id, $this->tax_included,  $this->tax_group_array);
 514
 515     // Adjustment for swiss franken, we always have 5 rappen = 1/20 franken
 516     if ($this->customer_currency == 'CHF') {
 517                         $val = $taxes['1']['Value'];
 518                         $val1 = (floatval((intval(round(($val*20),0)))/20));
 519                         $taxes['1']['Value'] = $val1;
 520                 }
 521                 return $taxes;
 522         }
 523
 524
 525         function get_tax_free_shipping()
 526         {
 527
 528                 if ($this->tax_included==0)
 529                         return $this->freight_cost;
 530                 else
 531                         return ($this->freight_cost - $this->get_shipping_tax());
 532         }
 533
 534         function get_shipping_tax()
 535         {
 536
 537                 $tax_items = get_shipping_tax_as_array($this->tax_group_id);
 538                 $tax_rate = 0;
 539                 if ($tax_items != null) {
 540                         foreach ($tax_items as $item_tax) {
 541                                 $index = $item_tax['tax_type_id'];
 542                                 if (isset($this->tax_group_array[$index]['rate'])) {
 543                                         $tax_rate += $item_tax['rate'];
 544                                 }
 545                         }
 546                 }
 547                 if($this->tax_included)
 548                         return round($this->freight_cost*$tax_rate/($tax_rate+100),  user_price_dec());
 549                 else
 550                         return round($this->freight_cost*$tax_rate/100,  user_price_dec());
 551         }
 552         /*
 553                 Returns transaction value including all taxes
 554         */
 555         function get_trans_total() {
 556
 557                 $total = $this->get_items_total() + $this->freight_cost;
 558                 $dec = user_price_dec();
 559                 if (!$this->tax_included ) {
 560                         $total += $this->get_shipping_tax();
 561                         $taxes = $this->get_taxes();
 562                         foreach($taxes as $tax)
 563                                 $total += round($tax['Value'], $dec);
 564                 }
 565
 566                 return $total;
 567         }
 568
 569         /*
 570                 Checks cart quantities on document_date.
 571                 Returns array of stock_ids which stock quantities would go negative on some day.
 572         */
 573         function check_qoh($date=null, $location=null)
 574         {
 575                 $low_stock = array();
 576                 // check only for customer delivery and direct sales invoice
 577                 if (!($this->trans_type == ST_CUSTDELIVERY || ($this->trans_type == ST_SALESINVOICE && $this->trans_no==0)))
 578                         return $low_stock;
 579
 580                 // collect quantities by stock_id
 581                 $qtys = array();
 582                 foreach ($this->line_items as $line_no => $line_item)
 583                 {
 584                         if (has_stock_holding($line_item->mb_flag))
 585                         {
 586                                 if (!$this->trans_no) // new delivery
 587                                         $qtys[$line_item->stock_id]['qty'] = $line_item->qty_dispatched + @$qtys[$line_item->stock_id]['qty'];
 588                                 else    // DN modification: check change in quantity
 589                                         $qtys[$line_item->stock_id]['qty'] = ($line_item->qty_dispatched-$line_item->qty_old) + @$qtys[$line_item->stock_id]['qty'];
 590                                 $qtys[$line_item->stock_id]['line'] = $line_no;
 591                         }
 592                 }
 593
 594                 foreach($qtys as $stock_id => $sum)
 595                 {
 596                         if (check_negative_stock($stock_id, -$sum['qty'], $location ? $location : $this->Location, $date ? $date : $this->document_date))
 597                                 $low_stock[] = $stock_id;
 598                 }
 599
 600                 return $low_stock;
 601         }
 602
 603         /*
 604                 Returns true for documents issued in prepayment cycle.
 605         */
 606         function is_prepaid()
 607         {
 608                 return $this->prepaid;
 609         }
 610         /*
 611                 Order is ready for delivery in prepament mode.
 612         */
 613         function is_released()
 614         {
 615                 return floatcmp($this->sum_paid, $this->prep_amount) >= 0;
 616         }
 617
 618         /*
 619                 Check whether order has been already invoiced/send or not.
 620         */
 621         function is_started()
 622         {
 623                 if ($this->trans_no==0)
 624                         return false;
 625                 $order_no = array_keys($this->trans_no);
 626
 627                 return  is_sales_order_started(reset($order_no));
 628         }
 629
 630         /*
 631                 Check payment terms and prepayments selected for this invoice,
 632                 and updates     partial/final invoice value respectively.
 633         */
 634         function update_payments()
 635         {
 636                 $remainder = prepaid_invoice_remainder($this->order_no);
 637
 638                 // recalculate prepaid part from payments
 639                 if ($this->payment_terms['days_before_due'] == -1)
 640                 {       // this is partial invoice for selected prepayments made.
 641                         $paid = 0;
 642                         foreach($this->prepayments as $payment)
 643                                 $paid += $payment['amt'];
 644                         $this->prep_amount = $this->trans_no ? $paid : min($remainder, $paid);
 645                 } else  // this is final invoice
 646                         $this->prep_amount = $remainder;
 647         }
 648 } /* end of class defintion */
 649
 650 class line_details
 651 {
 652         var $id;
 653         var $stock_id;
 654         var $item_description;
 655         var $units;
 656         var $mb_flag;
 657         var $tax_type;
 658         var $tax_type_name;
 659         var $src_no;    // number of src doc for this line
 660         var $src_id;
 661         var $price;
 662         var $discount_percent;
 663
 664         var $standard_cost;
 665         var $descr_editable;
 666
 667         var $valid; // validation in constructor
 668         /*
 669                 Line quantity properties in various cart create modes:
 670
 671                 view:
 672                 $quantity - quantity on current document
 673                 $qty_done - quantity processed on all child documents
 674                 $qty_dispatched - not used
 675                 $qty_old - not used
 676
 677                 edit:
 678                 $quantity - free parent quantity including this doc (= max allowed quantity)
 679                 $qty_done - qty processed on child documents (= min allowed qty)
 680                 $qty_dispatched - quantity currently selected to process
 681                 $qty_old - quantity processed on this document before reedition
 682
 683                 new child entry (view parent followed by prepare_child() call):
 684                 $quantity - max allowed quantity (get from parent)
 685                 $qty_done - qty processed on other child documents
 686                 $qty_dispatched - quantity currently selected to process
 687                 $qty_old - 0; not used
 688         */
 689         var $quantity;
 690         var $qty_done;
 691         var $qty_dispatched;
 692         var $qty_old = 0;
 693
 694
 695         function line_details ($stock_id, $qty, $prc, $disc_percent,
 696                 $qty_done, $standard_cost, $description, $id=0, $src_no=0, $src_id=0)
 697         {
 698         /* Constructor function to add a new LineDetail object with passed params */
 699
 700                 $this->id = $id;
 701                 $this->src_no = $src_no;
 702                 $this->src_id = $src_id;
 703                 $item_row = get_item($stock_id);
 704
 705                 if (!$item_row)
 706                         return;
 707
 708                 $this->mb_flag = $item_row["mb_flag"];
 709                 $this->units = $item_row["units"];
 710                 $this->descr_editable = $item_row["editable"];
 711                 if ($description == null || !$this->descr_editable)
 712                         $this->item_description = $item_row["description"];
 713                 else
 714                         $this->item_description = $description;
 715                 $this->tax_type = $item_row["tax_type_id"];
 716                 $this->tax_type_name = $item_row["tax_type_name"];
 717                 $this->stock_id = $stock_id;
 718                 $this->quantity = $qty;
 719                 $this->qty_dispatched = $qty;
 720                 $this->price = $prc;
 721                 $this->discount_percent = $disc_percent;
 722                 $this->qty_done = $qty_done;
 723                 $this->standard_cost = $standard_cost;
 724                 $this->valid = true;
 725         }
 726
 727         // get unit price as stated on document
 728         function line_price()
 729         {
 730                 return $this->price;
 731         }
 732 }
 733