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:
21 include_once($path_to_root . "/inventory/includes/inventory_db.inc");
22 include_once($path_to_root . "/taxes/tax_calc.inc");
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
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)
37 var $sales_type; // set to the customer's sales type
38 var $sales_type_name; // set to customer's sales type name
41 var $customer_currency; // set to the customer's currency
42 var $default_discount; // set to the customer's discount %
49 var $delivery_address;
57 var $order_no; // the original order number
60 var $freight_cost = 0;
64 var $tax_group_array = null; // saves db queries
65 var $price_factor; // ditto for price calculations
67 var $pos; // user assigned POS
70 var $cash_discount; // not used as of FA 2.1
74 var $payment_terms; // cached payment terms
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
84 var $fixed_asset = false;
86 //-------------------------------------------------------------------------
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
93 function __construct($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;
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('');
109 Optional sorting items by stock_id.
111 function _cmp_lines($a, $b)
113 return strcmp($a->stock_id, $b->stock_id);
117 Returns items array optionally sorted by item code.
123 $items = $this->line_items;
124 if (@$SysPrefs->sort_sales_items)
125 uasort($items, array($this, '_cmp_lines'));
130 // Prepare cart to new child document entry, just after initial parent doc read.
132 function prepare_child($type)
137 $type = get_child_type($this->trans_type);
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;
145 $this->document_date = new_doc_date();
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);
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'];
162 if ($type == ST_SALESINVOICE) {
163 $this->due_date = get_invoice_duedate($this->payment, $this->document_date);
166 $this->src_docs = $this->trans_no;
171 // Prepares transaction for reedition updating with parent transaction data
173 function set_parent_constraints($sodata, $src_no) {
175 $srcdetails = get_sales_parent_lines($this->trans_type, $src_no);
176 $src_type = get_parent_type($this->trans_type);
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
188 $line = &$this->line_items[$line_no];
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
200 if ($src_type == ST_SALESORDER || $src_type == 0) {
201 $this->src_docs = array( $sodata['order_no']=>$sodata['version']);
203 // get src_data from debtor_trans
204 $this->src_docs = get_customer_trans_version($src_type, array_unique($src_docs));
207 //-------------------------------------------------------------------------
208 // Reading document into cart
210 function read($type, $trans_no=0, $prepare_child=false) {
212 global $SysPrefs, $Refs;
214 if (!is_array($trans_no)) $trans_no = array($trans_no);
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, $this->customer_id);
222 $this->update_payments();
223 if ($this->order_no) { // free hand credit notes have no order_no
224 $sodata = get_sales_order_header($this->order_no, ST_SALESORDER);
225 $this->cust_ref = $sodata["customer_ref"];
226 // currently currency is hard linked to debtor account
227 $this->delivery_to = $sodata["deliver_to"];
228 $this->delivery_address = $sodata["delivery_address"];
229 // child transaction reedition - update with parent info unless it is freehand
230 if (!$this->is_prepaid() && !$prepare_child) // this is read for view/reedition
231 $this->set_parent_constraints($sodata, $trans_no[0]);
234 // convert document into child and prepare qtys for entry
236 $this->prepare_child($prepare_child);
238 } else { // new document
239 $this->trans_type = $type;
241 $this->customer_currency = get_company_currency();
242 // set new sales document defaults here
243 if (get_global_customer() != ALL_TEXT)
244 $this->customer_id = get_global_customer();
246 $this->customer_id = '';
247 $this->document_date = new_doc_date();
248 if (!is_date_in_fiscalyear($this->document_date))
249 $this->document_date = end_fiscalyear();
250 $this->reference = $Refs->get_next($this->trans_type, null, array('date' => Today(),
251 'customer' => $this->customer_id));
252 if ($type != ST_SALESORDER && $type != ST_SALESQUOTE) // Added 2.1 Joe Hunt 2008-11-12
254 $dim = get_company_pref('use_dimension');
257 if ($this->customer_id == '')
258 $this->dimension_id = 0;
261 $cust = get_customer($this->customer_id);
262 $this->dimension_id = $cust['dimension_id'];
266 if ($this->customer_id == '')
267 $this->dimension2_id = 0;
269 $this->dimension2_id = $cust['dimension2_id'];
273 if ($type == ST_SALESINVOICE) {
275 get_invoice_duedate($this->payment, $this->document_date);
278 add_days($this->document_date, $SysPrefs->default_delivery_required_by());
280 $this->credit = get_current_cust_credit($this->customer_id);
283 //-------------------------------------------------------------------------
284 // Writing new/modified sales document to database.
285 // Makes parent documents for direct delivery/invoice by recurent call.
286 // $policy - 0 or 1: writeoff/return for IV, back order/cancel for DN
287 function write($policy=0) {
289 global $SysPrefs, $Refs;
291 begin_transaction(); // prevents partial database changes in case of direct delivery/invoice
292 if ($this->reference != 'auto' && $this->trans_no == 0 && !is_new_reference($this->reference, $this->trans_type))
294 if (!empty($SysPrefs->prefs['ref_no_auto_increase']))
295 $this->reference = $Refs->get_next($this->trans_type, null, array('date' => Today()));
296 if (!is_new_reference($this->reference, $this->trans_type))
298 commit_transaction();
302 if (count($this->src_docs) == 0 && ($this->trans_type == ST_SALESINVOICE || $this->trans_type == ST_CUSTDELIVERY) && !$this->is_prepaid()) {
303 // this is direct document - first add parent
304 $ref = $this->reference;
305 $date = $this->document_date;
306 $due_date = $this->due_date;
307 $dimension_id = $this->dimension_id;
308 $dimension2_id = $this->dimension2_id;
309 $this->trans_type = get_parent_type($this->trans_type);
311 $this->reference = 'auto';
312 $trans_no = $this->write(1);
314 // re-read parent document converting it to child
315 $this->read($this->trans_type, $trans_no, true);
316 $this->document_date = $date;
317 $this->reference = $ref;
318 $this->due_date = $due_date;
319 $this->dimension_id = $dimension_id;
320 $this->dimension2_id = $dimension2_id;
322 $this->reference = @html_entity_decode($this->reference, ENT_QUOTES);
323 $this->Comments = @html_entity_decode($this->Comments, ENT_QUOTES);
324 foreach($this->line_items as $lineno => $line) {
325 $this->line_items[$lineno]->stock_id = @html_entity_decode($line->stock_id, ENT_QUOTES);
326 $this->line_items[$lineno]->item_description = @html_entity_decode($line->item_description, ENT_QUOTES);
328 switch($this->trans_type) {
329 case ST_SALESINVOICE:
330 $ret = write_sales_invoice($this); break;
332 $ret = write_credit_note($this, $policy); break;
333 case ST_CUSTDELIVERY:
334 $ret = write_sales_delivery($this, $policy); break;
337 if ($this->trans_no==0) // new document
338 $ret = add_sales_order($this);
340 $ret = update_sales_order($this);
343 commit_transaction();
348 function set_customer($customer_id, $customer_name, $currency, $discount, $payment, $cdiscount=0)
350 $this->customer_name = $customer_name;
351 $this->customer_id = $customer_id;
352 $this->default_discount = $discount;
353 $this->customer_currency = $currency;
354 $this->payment = $payment;
355 $this->payment_terms = get_payment_terms($payment);
356 $this->cash_discount = $cdiscount;
358 if ($this->payment_terms['cash_sale']) {
359 $this->Location = $this->pos['pos_location'];
360 $this->location_name = $this->pos['location_name'];
362 $this->credit = get_current_cust_credit($customer_id);
365 function set_branch($branch_id, $tax_group_id, $tax_group_name, $phone='', $email='')
367 $this->Branch = $branch_id;
368 $this->phone = $phone;
369 $this->email = $email;
370 $this->tax_group_id = $tax_group_id;
371 $this->tax_group_array = get_tax_group_items_as_array($tax_group_id);
374 function set_sales_type($sales_type, $sales_name, $tax_included=0, $factor=0)
376 $this->sales_type = $sales_type;
377 $this->sales_type_name = $sales_name;
378 $this->tax_included = $tax_included;
379 $this->price_factor = $factor;
382 function set_location($id, $name)
384 $this->Location = $id;
385 $this->location_name = $name;
388 function set_delivery($shipper, $destination, $address, $freight_cost=null)
390 $this->ship_via = $shipper;
391 $this->deliver_to = $destination;
392 $this->delivery_address = $address;
393 if (isset($freight_cost))
394 $this->freight_cost = $freight_cost;
397 function add_to_cart($line_no, $stock_id, $qty, $price, $disc, $qty_done=0, $standard_cost=0, $description=null, $id=0, $src_no=0,
400 $line = new line_details($stock_id, $qty, $price, $disc,
401 $qty_done, $standard_cost, $description, $id, $src_no, $src_id);
404 $this->line_items[$line_no] = $line;
407 display_error(_("You have to enter valid stock code or nonempty description"));
411 function update_cart_item($line_no, $qty, $price, $disc, $description="")
413 if ($description != "")
414 $this->line_items[$line_no]->item_description = $description;
415 $this->line_items[$line_no]->quantity = $qty;
416 $this->line_items[$line_no]->qty_dispatched = $qty;
417 $this->line_items[$line_no]->price = $price;
418 $this->line_items[$line_no]->discount_percent = $disc;
421 function update_add_cart_item_qty($line_no, $qty)
423 $this->line_items[$line_no]->quantity += $qty;
426 function remove_from_cart($line_no)
428 array_splice($this->line_items, $line_no, 1);
431 function clear_items()
433 unset($this->line_items);
434 $this->line_items = array();
435 $this->sales_type = "";
437 $this->customer_id = $this->order_no = 0;
440 function count_items()
443 foreach ($this->line_items as $line) {
444 if ($line->quantity!=$line->qty_done) $counter++;
449 function get_items_total()
453 foreach ($this->line_items as $ln_itm) {
454 $price = $ln_itm->line_price();
455 $total += round($ln_itm->quantity * $price * (1 - $ln_itm->discount_percent),
461 function get_items_total_dispatch()
465 foreach ($this->line_items as $ln_itm) {
466 $price = $ln_itm->line_price();
467 $total += round(($ln_itm->qty_dispatched * $price * (1 - $ln_itm->discount_percent)),
473 function has_items_dispatch()
475 foreach ($this->line_items as $ln_itm) {
476 if ($ln_itm->qty_dispatched > 0)
482 function any_already_delivered()
484 /* Checks if there have been any line item processed */
486 foreach ($this->line_items as $stock_item) {
487 if ($stock_item->qty_done !=0) {
496 function some_already_delivered($line_no)
498 /* Checks if there have been deliveries of a specific line item */
499 if (isset($this->line_items[$line_no]) &&
500 $this->line_items[$line_no]->qty_done != 0) {
506 function get_taxes($shipping_cost=null)
510 if($shipping_cost==null)
511 $shipping_cost = $this->freight_cost;
513 foreach ($this->line_items as $ln_itm) {
514 $items[] = $ln_itm->stock_id;
516 $this->trans_type==ST_SALESORDER ? $ln_itm->quantity : $ln_itm->qty_dispatched) *
517 $ln_itm->line_price()* (1 - $ln_itm->discount_percent)), user_price_dec());
520 $taxes = get_tax_for_items($items, $prices, $shipping_cost,
521 $this->tax_group_id, $this->tax_included, $this->tax_group_array);
523 // Adjustment for swiss franken, we always have 5 rappen = 1/20 franken
524 if ($this->customer_currency == 'CHF') {
525 $val = $taxes['1']['Value'];
526 $val1 = (floatval((intval(round(($val*20),0)))/20));
527 $taxes['1']['Value'] = $val1;
533 function get_tax_free_shipping()
536 if ($this->tax_included==0)
537 return $this->freight_cost;
539 return ($this->freight_cost - $this->get_shipping_tax());
542 function get_shipping_tax()
545 $tax_items = get_shipping_tax_as_array($this->tax_group_id);
547 if ($tax_items != null) {
548 foreach ($tax_items as $item_tax) {
549 $index = $item_tax['tax_type_id'];
550 if (isset($this->tax_group_array[$index]['rate'])) {
551 $tax_rate += $item_tax['rate'];
555 if($this->tax_included)
556 return round($this->freight_cost*$tax_rate/($tax_rate+100), user_price_dec());
558 return round($this->freight_cost*$tax_rate/100, user_price_dec());
561 Returns transaction value including all taxes
563 function get_trans_total() {
565 $total = $this->get_items_total() + $this->freight_cost;
566 $dec = user_price_dec();
567 if (!$this->tax_included ) {
568 $total += $this->get_shipping_tax();
569 $taxes = $this->get_taxes();
570 foreach($taxes as $tax)
571 $total += round($tax['Value'], $dec);
578 Checks cart quantities on document_date.
579 Returns array of stock_ids which stock quantities would go negative on some day.
581 function check_qoh($date=null, $location=null)
583 $low_stock = array();
584 // check only for customer delivery and direct sales invoice
585 if (!($this->trans_type == ST_CUSTDELIVERY || ($this->trans_type == ST_SALESINVOICE && $this->trans_no==0)))
588 // collect quantities by stock_id
590 foreach ($this->line_items as $line_no => $line_item)
592 if (has_stock_holding($line_item->mb_flag))
594 if (!$this->trans_no) // new delivery
595 $qtys[$line_item->stock_id]['qty'] = $line_item->qty_dispatched + @$qtys[$line_item->stock_id]['qty'];
596 else // DN modification: check change in quantity
597 $qtys[$line_item->stock_id]['qty'] = ($line_item->qty_dispatched-$line_item->qty_old) + @$qtys[$line_item->stock_id]['qty'];
598 $qtys[$line_item->stock_id]['line'] = $line_no;
602 foreach($qtys as $stock_id => $sum)
604 if (check_negative_stock($stock_id, -$sum['qty'], $location ? $location : $this->Location, $date ? $date : $this->document_date))
605 $low_stock[] = $stock_id;
612 Returns true for documents issued in prepayment cycle.
614 function is_prepaid()
616 return $this->prepaid;
619 Order is ready for delivery in prepament mode.
621 function is_released()
623 return floatcmp($this->sum_paid, $this->prep_amount) >= 0;
627 Check whether order has been already invoiced/send or not.
629 function is_started()
631 if ($this->trans_no==0)
633 $order_no = array_keys($this->trans_no);
635 return is_sales_order_started(reset($order_no));
639 Check payment terms and prepayments selected for this invoice,
640 and updates partial/final invoice value respectively.
642 function update_payments()
644 $remainder = prepaid_invoice_remainder($this->order_no);
646 // recalculate prepaid part from payments
647 if ($this->payment_terms['days_before_due'] == -1)
648 { // this is partial invoice for selected prepayments made.
650 foreach($this->prepayments as $payment)
651 $paid += $payment['amt'];
652 $this->prep_amount = $this->trans_no ? $paid : min($remainder, $paid);
653 } else // this is final invoice
654 $this->prep_amount = $remainder;
656 } /* end of class defintion */
662 var $item_description;
667 var $src_no; // number of src doc for this line
670 var $discount_percent;
675 var $valid; // validation in constructor
677 Line quantity properties in various cart create modes:
680 $quantity - quantity on current document
681 $qty_done - quantity processed on all child documents
682 $qty_dispatched - not used
686 $quantity - free parent quantity including this doc (= max allowed quantity)
687 $qty_done - qty processed on child documents (= min allowed qty)
688 $qty_dispatched - quantity currently selected to process
689 $qty_old - quantity processed on this document before reedition
691 new child entry (view parent followed by prepare_child() call):
692 $quantity - max allowed quantity (get from parent)
693 $qty_done - qty processed on other child documents
694 $qty_dispatched - quantity currently selected to process
695 $qty_old - 0; not used
703 function __construct($stock_id, $qty, $prc, $disc_percent,
704 $qty_done, $standard_cost, $description, $id=0, $src_no=0, $src_id=0)
706 /* Constructor function to add a new LineDetail object with passed params */
709 $this->src_no = $src_no;
710 $this->src_id = $src_id;
711 $item_row = get_item($stock_id);
716 $this->mb_flag = $item_row["mb_flag"];
717 $this->units = $item_row["units"];
718 $this->descr_editable = $item_row["editable"];
719 if ($description == null || !$this->descr_editable)
720 $this->item_description = $item_row["description"];
722 $this->item_description = $description;
723 $this->tax_type = $item_row["tax_type_id"];
724 $this->tax_type_name = $item_row["tax_type_name"];
725 $this->stock_id = $stock_id;
726 $this->quantity = $qty;
727 $this->qty_dispatched = $qty;
729 $this->discount_percent = $disc_percent;
730 $this->qty_done = $qty_done;
731 $this->standard_cost = $standard_cost;
735 // get unit price as stated on document
736 function line_price()