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 Supplier Transactions class to hold all the information for an accounts payable invoice or credit note
15 include_once($path_to_root . "/taxes/tax_calc.inc");
20 var $grn_items; /*array of objects of class grn_item using the id as the pointer */
21 var $gl_codes; /*array of objects of class gl_codes using a counter as the pointer */
30 var $trans_type; // invoice or credit
41 var $gl_codes_counter=0;
44 var $stored_algorithm;
46 function supp_trans($trans_type)
48 $this->trans_type = $trans_type;
49 /*Constructor function initialises a new Supplier Transaction object */
50 $this->grn_items = array();
51 $this->gl_codes = array();
54 function add_grn_to_trans($grn_item_id, $po_detail_item, $item_code, $item_description,
55 $qty_recd, $prev_quantity_inv, $this_quantity_inv, $order_price, $chg_price,
56 $std_cost_unit, $gl_code)
58 $this->grn_items[$grn_item_id] = new grn_item($grn_item_id, $po_detail_item,
59 $item_code, $item_description, $qty_recd, $prev_quantity_inv, $this_quantity_inv,
60 $order_price, $chg_price, $std_cost_unit, $gl_code, $this->tax_included);
64 function add_gl_codes_to_trans($gl_code, $gl_act_name, $gl_dim, $gl_dim2, $amount, $memo_)
66 $this->gl_codes[$this->gl_codes_counter] = new gl_codes($this->gl_codes_counter,
67 $gl_code, $gl_act_name, $gl_dim, $gl_dim2, $amount, $memo_);
68 $this->gl_codes_counter++;
72 function remove_grn_from_trans($grn_item_id)
74 unset($this->grn_items[$grn_item_id]);
76 function remove_gl_codes_from_trans($gl_code_counter)
78 unset($this->gl_codes[$gl_code_counter]);
81 function is_valid_trans_to_post()
83 return (count($this->grn_items) > 0 || count($this->gl_codes) > 0 ||
84 ($this->ov_amount != 0) || ($this->ov_discount > 0));
87 function clear_items()
89 unset($this->grn_items);
90 unset($this->gl_codes);
91 $this->ov_amount = $this->ov_discount = $this->supplier_id = 0;
93 $this->grn_items = array();
94 $this->gl_codes = array();
97 function get_taxes($tax_group_id=null, $shipping_cost=0, $gl_codes=true)
102 if ($tax_group_id == null)
103 $tax_group_id = $this->tax_group_id;
105 // preload the taxgroup !
106 $tax_group = get_tax_group_items_as_array($tax_group_id);
108 foreach ($this->grn_items as $ln_itm)
110 $items[] = $ln_itm->item_code;
111 // $prices[] =round( ($ln_itm->this_quantity_inv * $ln_itm->taxfree_charge_price($tax_group_id, $tax_group)),
112 $prices[] =round( ($ln_itm->this_quantity_inv * $ln_itm->chg_price),
116 if ($tax_group_id == null)
117 $tax_group_id = $this->tax_group_id;
118 $taxes = get_tax_for_items($items, $prices, $shipping_cost, $tax_group_id,
119 $this->tax_included, null, $this->tax_algorithm);
121 ///////////////// Joe Hunt 2009.08.18
125 foreach ($this->gl_codes as $gl_code)
127 $index = is_tax_account($gl_code->gl_code);
128 if ($index !== false)
130 $taxes[$index]['Value'] += $gl_code->amount;
138 // Returns total invoice amount without taxes.
140 function get_total_taxfree($tax_group_id=null)
144 // preload the taxgroup !
145 if ($tax_group_id != null)
146 $tax_group = get_tax_group_items_as_array($tax_group_id);
150 foreach ($this->grn_items as $ln_itm)
151 $total += round(($ln_itm->this_quantity_inv * $ln_itm->taxfree_charge_price($tax_group_id, $tax_group)),
154 foreach ($this->gl_codes as $gl_line)
155 { //////// 2009-08-18 Joe Hunt
156 if (!is_tax_account($gl_line->gl_code))
157 $total += $gl_line->amount;
162 // Returns transaction total
164 function get_items_total()
168 foreach ($this->grn_items as $ln_itm)
169 $total += round($ln_itm->this_quantity_inv * $ln_itm->chg_price, user_price_dec());
171 foreach ($this->gl_codes as $gl_line)
172 { //////// 2010-10-10 Joe Hunt
173 if (!is_tax_account($gl_line->gl_code) || $this->tax_included)
174 $total += $gl_line->amount;
178 } /* end of class defintion */
183 /* Contains relavent information from the purch_order_details as well to provide in cached form,
184 all the info to do the necessary entries without looking up ie additional queries of the database again */
189 var $item_description;
191 var $prev_quantity_inv;
192 var $this_quantity_inv;
199 function grn_item ($id, $po_detail_item, $item_code, $item_description, $qty_recd,
200 $prev_quantity_inv, $this_quantity_inv, $order_price, $chg_price,
201 $std_cost_unit, $gl_code, $tax_included)
205 $this->po_detail_item = $po_detail_item;
206 $this->item_code = $item_code;
207 $this->item_description = $item_description;
208 $this->qty_recd = $qty_recd;
209 $this->prev_quantity_inv = $prev_quantity_inv;
210 $this->this_quantity_inv = $this_quantity_inv;
211 $this->order_price =$order_price;
212 $this->chg_price = $chg_price;
213 $this->std_cost_unit = $std_cost_unit;
214 $this->gl_code = $gl_code;
215 $this->tax_included = $tax_included;
218 function full_charge_price($tax_group_id, $tax_group=null)
220 return get_full_price_for_item($this->item_code,
221 $this->chg_price, $tax_group_id, $this->tax_included, $tax_group);
224 function taxfree_charge_price($tax_group_id, $tax_group=null)
226 // if ($tax_group_id==null)
227 // return $this->chg_price;
228 return get_tax_free_price_for_item($this->item_code, $this->chg_price,
229 $tax_group_id, $this->tax_included, $tax_group);
245 function gl_codes ($Counter, $gl_code, $gl_act_name, $gl_dim, $gl_dim2, $amount, $memo_)
248 /* Constructor function to add a new gl_codes object with passed params */
249 $this->Counter = $Counter;
250 $this->gl_code = $gl_code;
251 $this->gl_act_name = $gl_act_name;
252 $this->gl_dim = $gl_dim;
253 $this->gl_dim2 = $gl_dim2;
254 $this->amount = $amount;
255 $this->memo_= $memo_;