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 ***********************************************************************/
13 This class serves as cart for PO or GRN.
19 var $trans_type; // order/grn/invoice (direct)
26 var $delivery_address;
28 var $prep_amount = 0; // prepayment required
29 var $alloc; // sum of payments allocated
30 var $tax_included; // type of prices
32 var $due_date; // for grn this is delivery date
33 var $order_no; // for order modification, grn batch
34 var $ex_rate; // for grn
48 var $tax_overrides = array(); // array of taxes manually inserted during sales invoice entry (direct invoice)
50 var $prepayments = array();
52 var $fixed_asset = false;
53 var $grn_id; // grn batch id used in edition only
55 function __construct()
57 $this->line_items = array();
58 $this->order_no = $this->supplier_id = 0;
59 $this->tax_group_id = find_domestic_tax_group(); // prevent tax errors until supplier is selected
62 function set_supplier($supplier_id, $supplier_name, $curr_code, $tax_group_id, $tax_included, $tax_area)
64 $this->supplier_id = $supplier_id;
65 $this->supplier_name = $supplier_name;
66 $this->curr_code = $curr_code;
67 $this->tax_group_id = $tax_group_id;
68 $this->tax_included = $tax_included;
69 $this->tax_area = $tax_area;
72 function add_to_order($stock_id, $qty, $item_descr, $price, $req_del_date, $qty_inv, $qty_recd, $qty_ordered=0, $grn_item_id=0, $po_item_id=0, $unit_cost=0)
74 $this->line_items[] = new po_line_details($stock_id, $item_descr, $qty, $price,
75 $req_del_date, $qty_inv, $qty_recd, $qty_ordered, $grn_item_id, $po_item_id, $unit_cost);
78 function update_order_item($line_no, $qty, $price, $req_del_date, $description="")
80 if ($description != "")
81 $this->line_items[$line_no]->item_description = $description;
82 $this->line_items[$line_no]->quantity = $qty;
83 $this->line_items[$line_no]->price = $price;
84 $this->line_items[$line_no]->req_del_date = $req_del_date;
85 $this->line_items[$line_no]->item_description = $description;
88 function remove_from_order($line_no)
90 array_splice($this->line_items, $line_no, 1);
93 function order_has_items()
95 return count($this->line_items) != 0;
98 function clear_items()
100 unset($this->line_items);
101 $this->line_items = array();
106 function any_already_received()
108 /* Checks if there have been deliveries or invoiced entered against any of the line items */
109 if (count($this->line_items) > 0)
111 foreach ($this->line_items as $ordered_items)
113 if ($ordered_items->qty_received != 0 || $ordered_items->qty_inv != 0)
122 function some_already_received($line_no)
124 /* Checks if there have been deliveries or amounts invoiced against a specific line item */
125 if (count($this->line_items) > 0)
127 if ($this->line_items[$line_no]->qty_received != 0 ||
128 $this->line_items[$line_no]->qty_inv != 0)
137 // Returns taxes for PO/GRN.
138 // $receival=true in purchase receive context.
140 function get_taxes($shipping_cost=null, $receival=false)
144 if($shipping_cost==null)
145 $shipping_cost = 0;//$this->freight_cost;
147 foreach ($this->line_items as $ln_itm) {
148 $items[] = $ln_itm->stock_id;
149 $prices[] = round($ln_itm->price * $ln_itm->quantity, user_price_dec());
151 $taxes = get_tax_for_items($this->trans_type, $items, $prices, $shipping_cost,
152 $this->tax_group_id, $this->tax_included);
154 // Adjustment for swiss franken, we always have 5 rappen = 1/20 franken
155 if ($this->curr_code == 'CHF') {
156 $val = $taxes['1']['Value'];
157 $val1 = (floatval((intval(round(($val*20),0)))/20));
158 $taxes['1']['Value'] = $val1;
160 foreach($this->tax_overrides as $id => $value) // add values entered manually
162 $taxes[$id]['Override'] = $value;
168 Returns order value including all taxes
170 function get_trans_total() {
173 $dec = user_price_dec();
175 foreach ($this->line_items as $ln_itm) {
176 $items[] = $ln_itm->stock_id;
177 $value = round($ln_itm->quantity * $ln_itm->price, $dec);
182 if (!$this->tax_included ) {
183 $taxes = get_tax_for_items($this->trans_type, $items, $prices, 0, $this->tax_group_id,
184 $this->tax_included);
186 foreach($taxes as $tax)
187 $total += round($tax['Value'], $dec);
192 function split_line_values()
194 // split nominal line values
195 foreach($this->line_items as $line)
196 $line->split_item_value($this);
198 // Exact tax values are currently entered as tax totals, so we need to move the differences back on line level.
199 // currently first item with given tax type will be fixed with the calculated difference
200 // FIXME: change UI moving tax edit to line level in line edit mode, then this workaround will be obsolete.
201 foreach($this->get_taxes() as $tax_id => $tax)
203 if ($tax['Value'] != 0 && ($tax['Value'] != $tax['Override']))
205 foreach($this->line_items as $id => $line)
206 if ($line->gl_amounts[0]['tax_type_id'] == $tax_id) // assumed single tax rate on item, so always gl_mount[0] is valid
208 $diff = $tax['Override'] - $tax['Value'];
209 $this->line_items[$id]->gl_amounts[0]['Value'] += $diff;
210 if ($line->vat_category != VC_NONDEDUCT)
211 $this->line_items[$id]->gl_amounts[0]['Deductible'] += $diff;
213 $this->line_items[$id]->gl_amounts['Cost'] += $diff;
214 // when supplier uses net prices the price is exact, so don't fix net, still record exact VAT.
215 if ($this->tax_included)
217 $this->line_items[$id]->gl_amounts['Net'] -= $diff;
218 $this->line_items[$id]->gl_amounts['Cost'] -= $diff;
226 } /* end of class defintion */
228 class po_line_details
234 var $item_description;
238 var $qty_inv; // quantity already invoiced against this line (all PIs)
239 var $qty_received; // quantity already received against this line (all GRNs)
240 var $qty_ordered; // quantity on order (not used on PO entry)
242 var $quantity; // this document line quantity
247 var $gl_amounts; // splited line value (after call to split_line_value method)
249 function __construct($stock_item, $item_descr, $qty, $prc, $req_del_date,
250 $qty_inv, $qty_recd, $qty_ordered=0, $grn_item_id=0, $po_item_id=0, $unit_cost=0)
252 $this->stock_id = $stock_item;
253 $item_row = get_item($stock_item);
257 $this->descr_editable = $item_row["editable"];
258 if ($item_descr == null || !$this->descr_editable)
259 $this->item_description = $item_row["description"];
261 $this->item_description = $item_descr;
262 $this->quantity = $qty;
263 $this->req_del_date = $req_del_date;
265 $this->units = $item_row["units"];
266 $this->qty_received = $qty_recd;
267 $this->qty_inv = $qty_inv;
268 $this->unit_cost = $unit_cost;
269 $this->grn_item_id = $grn_item_id;
270 $this->vat_category = $item_row["vat_category"];
271 $this->qty_ordered = $qty_ordered;
272 $this->po_item_id = $po_item_id;
276 // GRN line tax free value.
278 function taxfree_charge_value($po)
280 return get_tax_free_price_for_item($po->trans_type, $this->stock_id, $this->quantity*$this->price,
281 $po->tax_group_id, $po->tax_included);
285 Splits item value to parts posted to GL.
287 function split_item_value($cart)
291 return $this->gl_amounts = split_item_price($this->stock_id, $this->price*$this->quantity, $cart->tax_group_id, $cart->tax_included,
292 ST_SUPPINVOICE, $vat_factor);