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 function supp_trans($trans_type)
46 $this->trans_type = $trans_type;
47 /*Constructor function initialises a new Supplier Transaction object */
48 $this->grn_items = array();
49 $this->gl_codes = array();
52 function add_grn_to_trans($grn_item_id, $po_detail_item, $item_code, $item_description,
53 $qty_recd, $prev_quantity_inv, $this_quantity_inv, $order_price, $chg_price,
54 $std_cost_unit, $gl_code)
56 $this->grn_items[$grn_item_id] = new grn_item($grn_item_id, $po_detail_item,
57 $item_code, $item_description, $qty_recd, $prev_quantity_inv, $this_quantity_inv,
58 $order_price, $chg_price, $std_cost_unit, $gl_code, $this->tax_included);
62 function add_gl_codes_to_trans($gl_code, $gl_act_name, $gl_dim, $gl_dim2, $amount, $memo_)
64 $this->gl_codes[$this->gl_codes_counter] = new gl_codes($this->gl_codes_counter,
65 $gl_code, $gl_act_name, $gl_dim, $gl_dim2, $amount, $memo_);
66 $this->gl_codes_counter++;
70 function remove_grn_from_trans($grn_item_id)
72 unset($this->grn_items[$grn_item_id]);
74 function remove_gl_codes_from_trans($gl_code_counter)
76 unset($this->gl_codes[$gl_code_counter]);
79 function is_valid_trans_to_post()
81 return (count($this->grn_items) > 0 || count($this->gl_codes) > 0 ||
82 ($this->ov_amount != 0) || ($this->ov_discount > 0));
85 function clear_items()
87 unset($this->grn_items);
88 unset($this->gl_codes);
89 $this->ov_amount = $this->ov_discount = $this->supplier_id = 0;
91 $this->grn_items = array();
92 $this->gl_codes = array();
95 function get_taxes($tax_group_id=null, $shipping_cost=0, $gl_codes=true)
100 if ($tax_group_id == null)
101 $tax_group_id = $this->tax_group_id;
103 // preload the taxgroup !
104 $tax_group = get_tax_group_items_as_array($tax_group_id);
106 foreach ($this->grn_items as $ln_itm)
108 $items[] = $ln_itm->item_code;
109 // $prices[] =round( ($ln_itm->this_quantity_inv * $ln_itm->taxfree_charge_price($tax_group_id, $tax_group)),
110 $prices[] =round( ($ln_itm->this_quantity_inv * $ln_itm->chg_price),
114 if ($tax_group_id == null)
115 $tax_group_id = $this->tax_group_id;
116 $taxes = get_tax_for_items($items, $prices, $shipping_cost, $tax_group_id,
117 $this->tax_included);
119 ///////////////// Joe Hunt 2009.08.18
123 foreach ($this->gl_codes as $gl_code)
125 $index = is_tax_account($gl_code->gl_code);
126 if ($index !== false)
128 $taxes[$index]['Value'] += $gl_code->amount;
136 // Returns total invoice amount without taxes.
138 function get_total_taxfree($tax_group_id=null)
142 // preload the taxgroup !
143 if ($tax_group_id != null)
144 $tax_group = get_tax_group_items_as_array($tax_group_id);
148 foreach ($this->grn_items as $ln_itm)
149 $total += round(($ln_itm->this_quantity_inv * $ln_itm->taxfree_charge_price($tax_group_id, $tax_group)),
152 foreach ($this->gl_codes as $gl_line)
153 { //////// 2009-08-18 Joe Hunt
154 if (!is_tax_account($gl_line->gl_code))
155 $total += $gl_line->amount;
160 function get_items_total()
164 foreach ($this->grn_items as $ln_itm)
165 $total += round($ln_itm->this_quantity_inv * $ln_itm->chg_price, user_price_dec());
167 foreach ($this->gl_codes as $gl_line)
168 { //////// 2010-10-10 Joe Hunt
169 if (!is_tax_account($gl_line->gl_code) || $this->tax_included)
170 $total += $gl_line->amount;
174 } /* end of class defintion */
179 /* Contains relavent information from the purch_order_details as well to provide in cached form,
180 all the info to do the necessary entries without looking up ie additional queries of the database again */
185 var $item_description;
187 var $prev_quantity_inv;
188 var $this_quantity_inv;
195 function grn_item ($id, $po_detail_item, $item_code, $item_description, $qty_recd,
196 $prev_quantity_inv, $this_quantity_inv, $order_price, $chg_price,
197 $std_cost_unit, $gl_code, $tax_included)
201 $this->po_detail_item = $po_detail_item;
202 $this->item_code = $item_code;
203 $this->item_description = $item_description;
204 $this->qty_recd = $qty_recd;
205 $this->prev_quantity_inv = $prev_quantity_inv;
206 $this->this_quantity_inv = $this_quantity_inv;
207 $this->order_price =$order_price;
208 $this->chg_price = $chg_price;
209 $this->std_cost_unit = $std_cost_unit;
210 $this->gl_code = $gl_code;
211 $this->tax_included = $tax_included;
214 function full_charge_price($tax_group_id, $tax_group=null)
216 return get_full_price_for_item($this->item_code,
217 $this->chg_price, $tax_group_id, $this->tax_included, $tax_group);
220 function taxfree_charge_price($tax_group_id, $tax_group=null)
222 // if ($tax_group_id==null)
223 // return $this->chg_price;
224 return get_tax_free_price_for_item($this->item_code, $this->chg_price,
225 $tax_group_id, $this->tax_included, $tax_group);
241 function gl_codes ($Counter, $gl_code, $gl_act_name, $gl_dim, $gl_dim2, $amount, $memo_)
244 /* Constructor function to add a new gl_codes object with passed params */
245 $this->Counter = $Counter;
246 $this->gl_code = $gl_code;
247 $this->gl_act_name = $gl_act_name;
248 $this->gl_dim = $gl_dim;
249 $this->gl_dim2 = $gl_dim2;
250 $this->amount = $amount;
251 $this->memo_= $memo_;