Payment terms related functions moved to separate file, common function for calculati...
[fa-stable.git] / sales / includes / cart_class.inc
index 633093675fd722258faec739f32f4d3a0a2f153a..b35b25f4591d85b84cecfdb298f6930b4d490ef6 100644 (file)
@@ -21,7 +21,7 @@ iv)  a delivery note
 include_once($path_to_root . "/inventory/includes/inventory_db.inc");
 include_once($path_to_root . "/taxes/tax_calc.inc");
 
-class cart
+class Cart
 {
        var $trans_type; // invoice, order, quotation, delivery note ...
        var $trans_no = array();// array (num1=>ver1,..) or 0 for new
@@ -61,24 +61,34 @@ class cart
 
        var $tax_group_id;
        var $tax_group_name;
-       var $tax_group_array = null; // saves db queries
        var $price_factor;       // ditto for price calculations
 
-       var     $pos;                   // user assigned POS (contains cash accont number/name)
-       var $cash_discount;     // not used as of FA 2.1
+       var     $pos;                   // user assigned POS
+       var $cash_account;
+       var $account_name;
        var $dimension_id;
        var $dimension2_id;
        var $payment;
        var $payment_terms; // cached payment terms
        var $credit;
-       
+       // prepayment mode:
+       var $prepaid=false;     // true for documents issued in prepayment mode
+       var $prep_amount=0;     // prepayment required for SO, invoiced amount for prepaiament invoice
+       var $sum_paid;          // sum of all allocated prepayments both to order and related invoices
+       var $alloc;             // sum of payments allocated to this document
+       var $prepayments = array(); // allocation records for this document
+       var $ex_rate;
+
+       var $fixed_asset = false;
+
        //-------------------------------------------------------------------------
        //
        //  $trans_no==0 => open new/direct document
-       //  $trans_no!=0 && $prep_child==false => update with parent constarints for reedition
-       //  $trans_no!=0 && $prep_child==true => prepare for child doc entry
+       //  $trans_no!=0 && $prepare_child==false => update with parent constarints for reedition
+       //  $trans_no!=0 && $prepare_child==true => prepare for child doc entry
+       //      $prepare_child is set to ST_SALESINVOICE for prepayment invoices
        //
-       function Cart($type, $trans_no=0, $prep_child=false) {
+       function __construct($type, $trans_no=0, $prepare_child=false) {
                /*Constructor function initialises a new shopping cart */
                $this->line_items = array();
                $this->sales_type = "";
@@ -89,27 +99,54 @@ class cart
                $this->dimension_id = 0;
                $this->dimension2_id = 0;
                $this->pos = get_sales_point(user_pos());
-               $this->read($type, $trans_no, $prep_child);
+               $this->read($type, $trans_no, $prepare_child);
                $this->cart_id = uniqid('');
        }
-       
+
+       /*
+               Optional sorting items by stock_id.
+       */
+       function _cmp_lines($a, $b)
+       {
+               return strcmp($a->stock_id, $b->stock_id);
+       }
+
+       /*
+               Returns items array optionally sorted by item code.
+       */
+       function get_items()
+       {
+               global $SysPrefs;
+
+               $items = $this->line_items;
+               if (@$SysPrefs->sort_sales_items)
+                       uasort($items, array($this, '_cmp_lines'));
+
+               return $items;
+       }
        //
        //      Prepare cart to new child document entry, just after initial parent doc read.
        //
-       function prepare_child()
+       function prepare_child($type)
        {
                global $Refs;
 
-               $type = get_child_type($this->trans_type);
+               if ($type === true)
+                       $type = get_child_type($this->trans_type);
 
                $this->trans_type = $type;
-               $this->reference = $Refs->get_next($this->trans_type);
+               $this->reference = $Refs->get_next($this->trans_type, null, array('date' => $this->document_date,
+                       'customer' => $this->customer_id, 'branch' => $this->Branch));
+               if ($type == ST_CUSTCREDIT)
+                   $this->src_date = $this->document_date;
+
                $this->document_date = new_doc_date();
 
                for($line_no = 0; $line_no < count($this->line_items); $line_no++) {
                        $line = &$this->line_items[$line_no];
                        $line->src_id = $line->id; // save src line ids for update
-                       $line->qty_dispatched = $type == ST_CUSTCREDIT ? '0' : $line->quantity - $line->qty_done;
+                       $line->qty_dispatched = $type == ST_CUSTCREDIT ? '0' : 
+                                (($this->prepaid && $type == ST_SALESINVOICE) ? $line->quantity : $line->quantity - $line->qty_done);
                        $line->qty_old = 0;
                }
                unset($line);
@@ -121,12 +158,9 @@ class cart
                        $this->dimension2_id = $cust['dimension2_id'];
                }
                if ($type == ST_SALESINVOICE) {
-                       $this->due_date = get_invoice_duedate($this->payment, $this->document_date);
+                       $this->due_date = get_payment_due_date($this->payment, $this->document_date);
                }
 
-               if ($type == ST_CUSTCREDIT)
-                   $this->src_date = $this->document_date;
-
                $this->src_docs = $this->trans_no;
                $this->trans_no = 0;
        }
@@ -146,6 +180,11 @@ class cart
                while (($line_no < count($this->line_items)) && ($srcline = db_fetch($srcdetails))) {
                        $line = &$this->line_items[$line_no];
                        $src_docs[] = $src_type == ST_SALESORDER ?  $srcline['order_no'] : $srcline['debtor_trans_no'];
+                       while($srcline['id'] != $line->src_id) // Logic : This will increment the line_items array till sales_order line is matched.
+                       {       // Fixes Delivery note bug : Parent constraints not working if sales order line deleted after delivery 
+                       $line_no++;
+                       $line = &$this->line_items[$line_no];
+                       }
                        if ($srcline['id'] == $line->src_id) {
                                if ($this->trans_type == ST_SALESINVOICE)
                                        $line->src_no = $srcline['debtor_trans_no'];
@@ -166,7 +205,7 @@ class cart
        //-------------------------------------------------------------------------
        // Reading document into cart
        //
-       function read($type, $trans_no=0, $prep_child=false) {
+       function read($type, $trans_no=0, $prepare_child=false) {
 
                global $SysPrefs, $Refs;
 
@@ -176,63 +215,65 @@ class cart
                        if ($type == ST_SALESORDER || $type == ST_SALESQUOTE) { // sales order || sales quotation
                                read_sales_order($trans_no[0], $this, $type);
                        } else {        // other type of sales transaction
-                                       read_sales_trans($type, $trans_no, $this); 
-                                       if ($this->order_no) { // free hand credit notes have no order_no
-                                               $sodata = get_sales_order_header($this->order_no, ST_SALESORDER);
-                                               $this->cust_ref = $sodata["customer_ref"];
-                                       // currently currency is hard linked to debtor account
-                                       //      $this->customer_currency = $sodata["curr_code"];
-                                               $this->delivery_to = $sodata["deliver_to"];
-                                               $this->delivery_address = $sodata["delivery_address"];
-                                       // child transaction reedition - update with parent info unless it is freehand
-                                       if (!$prep_child) // this is read for view/reedition
-                                               $this->set_parent_constraints($sodata, $trans_no[0]);
-                                       }
+                               read_sales_trans($type, $trans_no, $this);
+                               $this->prepayments = get_payments_for($trans_no[0], $type, $this->customer_id);
+                               $this->update_payments();
+                               if ($this->order_no) { // free hand credit notes have no order_no
+                                       $sodata = get_sales_order_header($this->order_no, ST_SALESORDER);
+                                       $this->cust_ref = $sodata["customer_ref"];
+                               // currently currency is hard linked to debtor account
+                                       $this->delivery_to = $sodata["deliver_to"];
+                                       $this->delivery_address = $sodata["delivery_address"];
+                               // child transaction reedition - update with parent info unless it is freehand
+                               if (!$this->is_prepaid() && !$prepare_child) // this is read for view/reedition
+                                       $this->set_parent_constraints($sodata, $trans_no[0]);
+                               }
                        }
                        // convert document into child and prepare qtys for entry
-                       if ($prep_child)
-                               $this->prepare_child();
+                       if ($prepare_child)
+                               $this->prepare_child($prepare_child);
 
                } else { // new document
-                               $this->trans_type = $type;
-                               $this->trans_no = 0;
-                               $this->customer_currency = get_company_currency();
-                               // set new sales document defaults here
-                               if (get_global_customer() != ALL_TEXT)
-                                 $this->customer_id = get_global_customer();
-                               else
-                                 $this->customer_id = '';
-                               $this->document_date = new_doc_date();
-                               if (!is_date_in_fiscalyear($this->document_date))
-                                       $this->document_date = end_fiscalyear();
-                               $this->reference = $Refs->get_next($this->trans_type);
-                               if ($type != ST_SALESORDER && $type != ST_SALESQUOTE) // Added 2.1 Joe Hunt 2008-11-12
+                       $this->trans_type = $type;
+                       $this->trans_no = 0;
+                       $this->customer_currency = get_company_currency();
+                       // set new sales document defaults here
+                       if (get_global_customer() != ALL_TEXT)
+                         $this->customer_id = get_global_customer();
+                       else
+                         $this->customer_id = '';
+                       $this->document_date = new_doc_date();
+                       if (!is_date_in_fiscalyear($this->document_date))
+                               $this->document_date = end_fiscalyear();
+                       $this->reference = $Refs->get_next($this->trans_type, null, array('date' => Today(),
+                               'customer' => $this->customer_id));
+                       if ($type != ST_SALESORDER && $type != ST_SALESQUOTE) // Added 2.1 Joe Hunt 2008-11-12
+                       {
+                               $dim = get_company_pref('use_dimension');
+                               if ($dim > 0)
                                {
-                                       $dim = get_company_pref('use_dimension');
-                                       if ($dim > 0)
+                                       if ($this->customer_id == '')
+                                               $this->dimension_id = 0;
+                                       else
+                                       {
+                                               $cust = get_customer($this->customer_id);
+                                               $this->dimension_id = $cust['dimension_id'];
+                                       }       
+                                       if ($dim > 1)
                                        {
                                                if ($this->customer_id == '')
-                                                       $this->dimension_id = 0;
+                                                       $this->dimension2_id = 0;
                                                else
-                                               {
-                                                       $cust = get_customer($this->customer_id);
-                                                       $this->dimension_id = $cust['dimension_id'];
-                                               }       
-                                               if ($dim > 1)
-                                               {
-                                                       if ($this->customer_id == '')
-                                                               $this->dimension2_id = 0;
-                                                       else
-                                                               $this->dimension2_id = $cust['dimension2_id'];
-                                               }               
+                                                       $this->dimension2_id = $cust['dimension2_id'];
                                        }               
-                               }       
-                               if ($type == ST_SALESINVOICE) {
-                                       $this->due_date =
-                                               get_invoice_duedate($this->payment, $this->document_date);
-                               } else
-                                       $this->due_date =
-                                               add_days($this->document_date, $SysPrefs->default_delivery_required_by());
+                               }               
+                       }       
+                       if ($type == ST_SALESINVOICE) {
+                               $this->due_date =
+                                       get_payment_due_date($this->payment, $this->document_date);
+                       } else
+                               $this->due_date =
+                                       add_days($this->document_date, $SysPrefs->default_delivery_required_by());
                }
                $this->credit = get_current_cust_credit($this->customer_id);
        }
@@ -241,13 +282,28 @@ class cart
        // Writing new/modified sales document to database.
        // Makes parent documents for direct delivery/invoice by recurent call.
        // $policy - 0 or 1:  writeoff/return for IV, back order/cancel for DN
-       function write($policy=0) { 
+       function write($policy=0) {
+
+               global $SysPrefs, $Refs;
+               
                begin_transaction(); // prevents partial database changes in case of direct delivery/invoice
-               if (count($this->src_docs) == 0 && ($this->trans_type == ST_SALESINVOICE || $this->trans_type == ST_CUSTDELIVERY)) {
+               if ($this->reference != 'auto' && $this->trans_no == 0 && !is_new_reference($this->reference, $this->trans_type))
+               {
+                       if (!empty($SysPrefs->prefs['ref_no_auto_increase']))
+                               $this->reference = $Refs->get_next($this->trans_type, null, array('date' => Today()));
+                       if (!is_new_reference($this->reference, $this->trans_type))     
+                       {
+                               commit_transaction();
+                               return -1;
+                       }       
+               }
+               if (count($this->src_docs) == 0 && ($this->trans_type == ST_SALESINVOICE || $this->trans_type == ST_CUSTDELIVERY) && !$this->is_prepaid()) {
                        // this is direct document - first add parent
                        $ref = $this->reference;
                        $date = $this->document_date;
                        $due_date = $this->due_date;
+                       $dimension_id = $this->dimension_id;
+                       $dimension2_id = $this->dimension2_id;
                        $this->trans_type = get_parent_type($this->trans_type);
 
                        $this->reference = 'auto'; 
@@ -258,13 +314,10 @@ class cart
                        $this->document_date = $date;
                        $this->reference = $ref;
                        $this->due_date = $due_date;
+                       $this->dimension_id = $dimension_id;
+                       $this->dimension2_id = $dimension2_id;
                }
                $this->reference = @html_entity_decode($this->reference, ENT_QUOTES);
-               if ($this->reference != 'auto' && $this->trans_no == 0 && !is_new_reference($this->reference, $this->trans_type))
-               {
-                       commit_transaction();
-                       return -1;
-               }       
                $this->Comments = @html_entity_decode($this->Comments, ENT_QUOTES);
                foreach($this->line_items as $lineno => $line) {
                        $this->line_items[$lineno]->stock_id = @html_entity_decode($line->stock_id, ENT_QUOTES);
@@ -290,7 +343,7 @@ class cart
                return $ret;
        }
 
-       function set_customer($customer_id, $customer_name, $currency, $discount, $payment, $cdiscount=0)
+       function set_customer($customer_id, $customer_name, $currency, $discount, $payment)
        {
                $this->customer_name = $customer_name;
                $this->customer_id = $customer_id;
@@ -298,9 +351,8 @@ class cart
                $this->customer_currency = $currency;
                $this->payment = $payment;
                $this->payment_terms = get_payment_terms($payment);
-               $this->cash_discount = $cdiscount;
 
-               if ($this->payment_terms['cash_sale']) {
+               if ($this->payment_terms['type'] == PTT_CASH) {
                        $this->Location = $this->pos['pos_location'];
                        $this->location_name = $this->pos['location_name'];
                }
@@ -313,7 +365,6 @@ class cart
                $this->phone = $phone;
                $this->email = $email;
                $this->tax_group_id = $tax_group_id;
-               $this->tax_group_array = get_tax_group_items_as_array($tax_group_id);
        }
 
        function set_sales_type($sales_type, $sales_name, $tax_included=0, $factor=0)
@@ -339,13 +390,14 @@ class cart
                        $this->freight_cost = $freight_cost;
        }
 
-       function add_to_cart($line_no, $stock_id, $qty, $price, $disc, $qty_done=0, $standard_cost=0, $description=null, $id=0, $src_no=0,
+       function add_to_cart($line_no, $stock_id, $qty, $price, $disc, $qty_done=0, $unit_cost=0, $description=null, $id=0, $src_no=0,
                $src_id=0)
        {
                $line = new line_details($stock_id, $qty, $price, $disc,
-                       $qty_done,  $standard_cost, $description, $id, $src_no, $src_id);
+                       $qty_done,  $unit_cost, $description, $id, $src_no, $src_id);
 
                if ($line->valid) {
+                       $line->cart = $this;
                        $this->line_items[$line_no] = $line;
                        return 1;
                } else
@@ -448,12 +500,27 @@ class cart
                return 0;
        }
 
+       /*
+               Split line value to cost and taxes.
+               Stores calculated amounts in $line->gl_amounts arrays.
+       */
+       function split_line_values()
+       {
+               // split nominal line values
+               foreach ($this->line_items as $line)
+                       $line->split_item_value();
+       }
+
        function get_taxes($shipping_cost=null)
        {
                $items = array();
                $prices = array();
-               if($shipping_cost==null)
-                       $shipping_cost = $this->freight_cost;
+               if ($this->ship_via != '') {
+                       if ($shipping_cost == null)
+                               $shipping_cost = $this->freight_cost;
+                       $items[] = $this->ship_via;
+                       $prices[] = $shipping_cost;
+               }
 
                foreach ($this->line_items as $ln_itm) {
                        $items[] = $ln_itm->stock_id;
@@ -462,8 +529,7 @@ class cart
                                $ln_itm->line_price()* (1 - $ln_itm->discount_percent)),  user_price_dec());
                }
 
-               $taxes = get_tax_for_items($items, $prices, $shipping_cost,
-                 $this->tax_group_id, $this->tax_included,  $this->tax_group_array);
+               $taxes = get_tax_for_items($this->trans_type, $items, $prices, $this->tax_group_id, $this->tax_included);
 
     // Adjustment for swiss franken, we always have 5 rappen = 1/20 franken
     if ($this->customer_currency == 'CHF') {
@@ -486,21 +552,9 @@ class cart
 
        function get_shipping_tax()
        {
+               $freight = split_item_price($this->ship_via, $this->freight_cost, $this->tax_group_id, $this->tax_included, $this->trans_type);
 
-               $tax_items = get_shipping_tax_as_array();
-               $tax_rate = 0;
-               if ($tax_items != null) {
-                       foreach ($tax_items as $item_tax) {
-                               $index = $item_tax['tax_type_id'];
-                               if (isset($this->tax_group_array[$index]['rate'])) {
-                                       $tax_rate += $item_tax['rate'];
-                               }
-                       }
-               }
-               if($this->tax_included)
-                       return round($this->freight_cost*$tax_rate/($tax_rate+100),  user_price_dec());
-               else
-                       return round($this->freight_cost*$tax_rate/100,  user_price_dec());
+               return $freight['Tax'];
        }
        /*
                Returns transaction value including all taxes
@@ -518,6 +572,86 @@ class cart
 
                return $total;
        }
+
+       /*
+               Checks cart quantities on document_date.
+               Returns array of stock_ids which stock quantities would go negative on some day.
+       */
+       function check_qoh($date=null, $location=null)
+       {
+               $low_stock = array();
+               // check only for customer delivery and direct sales invoice 
+               if (!($this->trans_type == ST_CUSTDELIVERY || ($this->trans_type == ST_SALESINVOICE && $this->trans_no==0)))
+                       return $low_stock;
+
+               // collect quantities by stock_id
+               $qtys = array();
+               foreach ($this->line_items as $line_no => $line_item)
+               {
+                       if (has_stock_holding($line_item->mb_flag))
+                       {
+                               if (!$this->trans_no) // new delivery
+                                       $qtys[$line_item->stock_id]['qty'] = $line_item->qty_dispatched + @$qtys[$line_item->stock_id]['qty'];
+                               else    // DN modification: check change in quantity
+                                       $qtys[$line_item->stock_id]['qty'] = ($line_item->qty_dispatched-$line_item->qty_old) + @$qtys[$line_item->stock_id]['qty'];
+                               $qtys[$line_item->stock_id]['line'] = $line_no;
+                       }
+               }
+
+               foreach($qtys as $stock_id => $sum)
+               {
+                       if (check_negative_stock($stock_id, -$sum['qty'], $location ? $location : $this->Location, $date ? $date : $this->document_date))
+                               $low_stock[] = $stock_id;
+               }
+
+               return $low_stock;
+       }
+
+       /*
+               Returns true for documents issued in prepayment cycle.
+       */
+       function is_prepaid()
+       {
+               return $this->prepaid; 
+       }
+       /*
+               Order is ready for delivery in prepament mode.
+       */
+       function is_released()
+       {
+               return floatcmp($this->sum_paid, $this->prep_amount) >= 0;
+       }
+
+       /*
+               Check whether order has been already invoiced/send or not.
+       */
+       function is_started()
+       {
+               if ($this->trans_no==0)
+                       return false;
+               $order_no = array_keys($this->trans_no);
+
+               return  is_sales_order_started(reset($order_no));
+       }
+
+       /*
+               Check payment terms and prepayments selected for this invoice,
+               and updates     partial/final invoice value respectively.
+       */
+       function update_payments()
+       {
+               $remainder = prepaid_invoice_remainder($this->order_no);
+
+               // recalculate prepaid part from payments
+               if ($this->payment_terms['type'] == PTT_PREPAY)
+               {       // this is partial invoice for selected prepayments made.
+                       $paid = 0;
+                       foreach($this->prepayments as $payment)
+                               $paid += $payment['amt'];
+                       $this->prep_amount = $this->trans_no ? $paid : min($remainder, $paid);
+               } else  // this is final invoice
+                       $this->prep_amount = $remainder;
+       }
 } /* end of class defintion */
 
 class line_details
@@ -534,9 +668,10 @@ class line_details
        var $price;
        var $discount_percent;
        
-       var $standard_cost;
+       var $unit_cost;
        var $descr_editable;
 
+       var $cart; // line context
        var $valid; // validation in constructor
        /*
                Line quantity properties in various cart create modes:
@@ -565,8 +700,8 @@ class line_details
        var $qty_old = 0;
 
 
-       function line_details ($stock_id, $qty, $prc, $disc_percent,
-               $qty_done, $standard_cost, $description, $id=0, $src_no=0, $src_id=0)
+       function __construct($stock_id, $qty, $prc, $disc_percent,
+               $qty_done, $unit_cost, $description, $id=0, $src_no=0, $src_id=0)
        {
        /* Constructor function to add a new LineDetail object with passed params */
 
@@ -585,7 +720,6 @@ class line_details
                        $this->item_description = $item_row["description"];
                else
                        $this->item_description = $description;
-               //$this->standard_cost = $item_row["material_cost"] + $item_row["labour_cost"] + $item_row["overhead_cost"];
                $this->tax_type = $item_row["tax_type_id"];
                $this->tax_type_name = $item_row["tax_type_name"];
                $this->stock_id = $stock_id;
@@ -594,7 +728,7 @@ class line_details
                $this->price = $prc;
                $this->discount_percent = $disc_percent;
                $this->qty_done = $qty_done;
-               $this->standard_cost = $standard_cost;
+               $this->unit_cost = $unit_cost;
                $this->valid = true;
        }
 
@@ -603,6 +737,20 @@ class line_details
        {
                return $this->price;
        }
+
+       function taxfree_charge_price()
+       {
+               $this->split_item_value();
+               return $this->gl_amounts['Net'];
+       }
+
+       /*
+               Splits item value to parts posted to GL.
+       */
+       function split_item_value()
+       {
+               return $this->gl_amounts = split_item_price($this->stock_id, $this->price*$this->quantity, $this->cart->tax_group_id, $this->cart->tax_included, 
+                       $this->cart->trans_type);
+       }
 }
 
-?>