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
42 var $tax_overrides = array(); // array of taxes manually inserted during sales invoice entry (direct invoice)
44 var $prep_amount = 0; // prepayment required
45 var $alloc; // sum of payments allocated
46 var $prepayments = array();
48 var $fixed_asset = false;
49 var $grn_id ; // grn batch id used in edition only
51 function __construct()
53 /*Constructor function initialises a new purchase order object */
54 $this->line_items = array();
55 $this->lines_on_order = $this->order_no = $this->supplier_id = 0;
58 function set_supplier($supplier_id, $supplier_name, $curr_code, $tax_group_id, $tax_included)
60 $this->supplier_id = $supplier_id;
61 $this->supplier_name = $supplier_name;
62 $this->curr_code = $curr_code;
63 $this->tax_group_id = $tax_group_id;
64 $this->tax_included = $tax_included;
65 $this->tax_group_array = get_tax_group_items_as_array($tax_group_id);
68 function add_to_order($line_no, $stock_id, $qty, $item_descr, $price, $uom, $req_del_date, $qty_inv, $qty_recd, $qty_ordered=0, $grn_item_id=0)
70 if (isset($qty) && $qty != 0)
72 $this->line_items[$line_no] = new po_line_details($line_no, $stock_id, $item_descr, $qty, $price, $uom,
73 $req_del_date, $qty_inv, $qty_recd, $qty_ordered, $grn_item_id);
74 $this->lines_on_order++;
80 function update_order_item($line_no, $qty, $price, $req_del_date, $description="")
82 if ($description != "")
83 $this->line_items[$line_no]->item_description = $description;
84 $this->line_items[$line_no]->quantity = $qty;
85 $this->line_items[$line_no]->price = $price;
86 $this->line_items[$line_no]->req_del_date = $req_del_date;
87 $this->line_items[$line_no]->item_description = $description;
90 function remove_from_order($line_no)
92 array_splice($this->line_items, $line_no, 1);
95 function order_has_items()
97 return count($this->line_items) != 0;
100 function clear_items()
102 unset($this->line_items);
103 $this->line_items = array();
105 $this->lines_on_order = 0;
110 function any_already_received()
112 /* Checks if there have been deliveries or invoiced entered against any of the line items */
113 if (count($this->line_items) > 0)
115 foreach ($this->line_items as $ordered_items)
117 if ($ordered_items->qty_received != 0 || $ordered_items->qty_inv != 0)
126 function some_already_received($line_no)
128 /* Checks if there have been deliveries or amounts invoiced against a specific line item */
129 if (count($this->line_items) > 0)
131 if ($this->line_items[$line_no]->qty_received != 0 ||
132 $this->line_items[$line_no]->qty_inv != 0)
141 // Returns taxes for PO/GRN.
142 // $receival=true in purchase receive context.
144 function get_taxes($shipping_cost=null, $receival=false)
148 if($shipping_cost==null)
149 $shipping_cost = 0;//$this->freight_cost;
151 foreach ($this->line_items as $ln_itm) {
152 $items[] = $ln_itm->stock_id;
153 $prices[] = round($ln_itm->price * $ln_itm->quantity, user_price_dec());
155 $taxes = get_tax_for_items($items, $prices, $shipping_cost,
156 $this->tax_group_id, $this->tax_included, $this->tax_group_array);
158 // Adjustment for swiss franken, we always have 5 rappen = 1/20 franken
159 if ($this->curr_code == 'CHF') {
160 $val = $taxes['1']['Value'];
161 $val1 = (floatval((intval(round(($val*20),0)))/20));
162 $taxes['1']['Value'] = $val1;
164 foreach($this->tax_overrides as $id => $value) // add values entered manually
166 $taxes[$id]['Override'] = $value;
172 Returns order value including all taxes
174 function get_trans_total() {
177 $dec = user_price_dec();
179 foreach ($this->line_items as $ln_itm) {
180 $items[] = $ln_itm->stock_id;
181 $value = round($ln_itm->quantity * $ln_itm->price, $dec);
186 if (!$this->tax_included ) {
187 $taxes = get_tax_for_items($items, $prices, 0, $this->tax_group_id,
188 $this->tax_included, $this->tax_group_array);
190 foreach($taxes as $tax)
191 $total += round($tax['Value'], $dec);
196 } /* end of class defintion */
198 class po_line_details
205 var $item_description;
212 var $quantity; // this document line quantity
213 var $qty_inv; // quantity already invoiced against this line (all PIs)
214 var $qty_received; // quantity already received against this line (all GRNs)
215 var $qty_ordered; // quantity on order (not used on PO entry)
220 function __construct($line_no, $stock_item, $item_descr, $qty, $prc, $uom, $req_del_date,
221 $qty_inv, $qty_recd, $qty_ordered=0, $grn_item_id=0)
223 /* Constructor function to add a new LineDetail object with passed params */
224 $this->line_no = $line_no;
225 $this->stock_id = $stock_item;
226 $item_row = get_item($stock_item);
230 $this->descr_editable = $item_row["editable"];
231 if ($item_descr == null || !$this->descr_editable)
232 $this->item_description = $item_row["description"];
234 $this->item_description = $item_descr;
235 $this->quantity = $qty;
236 $this->req_del_date = $req_del_date;
238 // $this->units = $uom;
239 $this->tax_type = $item_row["tax_type_id"];
240 $this->tax_type_name = $item_row["tax_type_name"];
241 $this->units = $item_row["units"];
242 $this->qty_received = $qty_recd;
243 $this->qty_inv = $qty_inv;
245 $this->grn_item_id = $grn_item_id;
246 $this->qty_ordered = $qty_ordered;
249 // Deprecated, use with care. If you need line value as it is calculated in invoice, use taxfree_charge_value below.
250 function taxfree_charge_price($po)
252 return get_tax_free_price_for_item($this->stock_id, $this->price,
253 $po->tax_group_id, $po->tax_included, $po->tax_group_array);
257 // GRN line tax free value.
259 function taxfree_charge_value($po)
261 return get_tax_free_price_for_item($this->stock_id, $this->quantity*$this->price,
262 $po->tax_group_id, $po->tax_included, $po->tax_group_array);