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 purch_order class to hold all the information for a purchase order and delivery
18 var $trans_type; // order/grn/invoice (direct)
22 var $delivery_address;
29 var $order_no; /*Only used for modification of existing orders otherwise only established when order committed */
30 var $lines_on_order = 0;
33 var $tax_group_array = null; // saves db queries
34 var $tax_included; // type of prices
36 var $stored_algorithm; // copy to find the change after invoice in processed
41 var $prep_amount = 0; // prepayment required
42 var $alloc; // sum of payments allocated
43 var $prepayments = array();
45 function purch_order()
47 /*Constructor function initialises a new purchase order object */
48 $this->line_items = array();
49 $this->lines_on_order = $this->order_no = $this->supplier_id = 0;
52 function set_supplier($supplier_id, $supplier_name, $curr_code, $tax_group_id, $tax_included, $tax_algorithm)
54 $this->supplier_id = $supplier_id;
55 $this->supplier_name = $supplier_name;
56 $this->curr_code = $curr_code;
57 $this->tax_group_id = $tax_group_id;
58 $this->tax_included = $tax_included;
59 $this->stored_algorithm = $this->tax_algorithm = $tax_algorithm;
60 $this->tax_group_array = get_tax_group_items_as_array($tax_group_id);
63 function add_to_order($line_no, $stock_id, $qty, $item_descr, $price, $uom, $req_del_date, $qty_inv, $qty_recd)
65 if ($qty != 0 && isset($qty))
67 $this->line_items[$line_no] = new po_line_details($line_no, $stock_id, $item_descr, $qty, $price, $uom,
68 $req_del_date, $qty_inv, $qty_recd);
69 $this->lines_on_order++;
75 function update_order_item($line_no, $qty, $price, $req_del_date, $description="")
77 if ($description != "")
78 $this->line_items[$line_no]->item_description = $description;
79 $this->line_items[$line_no]->quantity = $qty;
80 $this->line_items[$line_no]->price = $price;
81 $this->line_items[$line_no]->req_del_date = $req_del_date;
82 $this->line_items[$line_no]->item_description = $description;
85 function remove_from_order($line_no)
87 array_splice($this->line_items, $line_no, 1);
90 function order_has_items()
92 return count($this->line_items) != 0;
95 function clear_items()
97 unset($this->line_items);
98 $this->line_items = array();
100 $this->lines_on_order = 0;
105 function any_already_received()
107 /* Checks if there have been deliveries or invoiced entered against any of the line items */
108 if (count($this->line_items) > 0)
110 foreach ($this->line_items as $ordered_items)
112 if ($ordered_items->qty_received != 0 || $ordered_items->qty_inv != 0)
121 function some_already_received($line_no)
123 /* Checks if there have been deliveries or amounts invoiced against a specific line item */
124 if (count($this->line_items) > 0)
126 if ($this->line_items[$line_no]->qty_received != 0 ||
127 $this->line_items[$line_no]->qty_inv != 0)
136 // Returns taxes for PO/GRN.
137 // $receival=true in purchase receive context.
139 function get_taxes($shipping_cost=null, $receival=false)
143 if($shipping_cost==null)
144 $shipping_cost = 0;//$this->freight_cost;
146 foreach ($this->line_items as $ln_itm) {
147 $items[] = $ln_itm->stock_id;
148 $prices[] = round($ln_itm->price * ($receival ? $ln_itm->receive_qty : $ln_itm->quantity), user_price_dec());
150 $taxes = get_tax_for_items($items, $prices, $shipping_cost,
151 $this->tax_group_id, $this->tax_included, $this->tax_group_array, $this->tax_algorithm);
153 // Adjustment for swiss franken, we always have 5 rappen = 1/20 franken
154 if ($this->curr_code == 'CHF') {
155 $val = $taxes['1']['Value'];
156 $taxes['1']['Value'] = (floatval((intval(round(($val*20),0)))/20));
162 Returns order value including all taxes
164 function get_trans_total() {
167 $dec = user_price_dec();
169 foreach ($this->line_items as $ln_itm) {
170 $items[] = $ln_itm->stock_id;
171 $value = round($ln_itm->quantity * $ln_itm->price, $dec);
176 if (!$this->tax_included ) {
177 $taxes = get_tax_for_items($items, $prices, 0, $this->tax_group_id,
178 $this->tax_included, $this->tax_group_array, $this->tax_algorithm);
180 foreach($taxes as $tax)
181 $total += round($tax['Value'], $dec);
186 } /* end of class defintion */
188 class po_line_details
195 var $item_description;
202 var $quantity; // current/entry quantity of PO line
203 var $qty_inv; // quantity already invoiced against this line
204 var $receive_qty; // current/entry GRN quantity
205 var $qty_received; // quantity already received against this line
210 function po_line_details($line_no, $stock_item, $item_descr, $qty, $prc, $uom, $req_del_date,
211 $qty_inv, $qty_recd, $grn_item_id=0)
214 /* Constructor function to add a new LineDetail object with passed params */
215 $this->line_no = $line_no;
216 $this->stock_id = $stock_item;
217 $item_row = get_item($stock_item);
221 $this->descr_editable = $item_row["editable"];
222 if ($item_descr == null || !$this->descr_editable)
223 $this->item_description = $item_row["description"];
225 $this->item_description = $item_descr;
226 $this->quantity = $qty;
227 $this->req_del_date = $req_del_date;
229 // $this->units = $uom;
230 $this->tax_type = $item_row["tax_type_id"];
231 $this->tax_type_name = $item_row["tax_type_name"];
232 $this->units = $item_row["units"];
233 $this->qty_received = $qty_recd;
234 $this->qty_inv = $qty_inv;
235 $this->receive_qty = 0; /*initialise these last two only */
236 $this->standard_cost =0;
237 $this->grn_item_id = $grn_item_id;
240 function taxfree_charge_price($po)
242 return get_tax_free_price_for_item($this->stock_id, $this->price,
243 $po->tax_group_id, $po->tax_included, $po->tax_group_array);