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 */
24 var $terms_description;
30 var $trans_type; // invoice or credit
41 var $gl_codes_counter=0;
43 function supp_trans($trans_type)
45 $this->trans_type = $trans_type;
46 /*Constructor function initialises a new Supplier Transaction object */
47 $this->grn_items = array();
48 $this->gl_codes = array();
51 function add_grn_to_trans($grn_item_id, $po_detail_item, $item_code, $item_description,
52 $qty_recd, $prev_quantity_inv, $this_quantity_inv, $order_price, $chg_price,
53 $std_cost_unit, $gl_code)
55 $this->grn_items[$grn_item_id] = new grn_item($grn_item_id, $po_detail_item,
56 $item_code, $item_description, $qty_recd, $prev_quantity_inv, $this_quantity_inv,
57 $order_price, $chg_price, $std_cost_unit, $gl_code);
61 function add_gl_codes_to_trans($gl_code, $gl_act_name, $gl_dim, $gl_dim2, $amount, $memo_)
63 $this->gl_codes[$this->gl_codes_counter] = new gl_codes($this->gl_codes_counter,
64 $gl_code, $gl_act_name, $gl_dim, $gl_dim2, $amount, $memo_);
65 $this->gl_codes_counter++;
69 function remove_grn_from_trans($grn_item_id)
71 unset($this->grn_items[$grn_item_id]);
73 function remove_gl_codes_from_trans($gl_code_counter)
75 unset($this->gl_codes[$gl_code_counter]);
78 function is_valid_trans_to_post()
80 return (count($this->grn_items) > 0 || count($this->gl_codes) > 0 ||
81 ($this->ov_amount != 0) || ($this->ov_discount > 0));
84 function clear_items()
86 unset($this->grn_items);
87 unset($this->gl_codes);
88 $this->ov_amount = $this->ov_discount = $this->supplier_id = 0;
90 $this->grn_items = array();
91 $this->gl_codes = array();
94 function get_taxes($tax_group_id=null, $shipping_cost=0, $gl_codes=true)
99 if ($tax_group_id == null)
100 $tax_group_id = $this->tax_group_id;
102 // preload the taxgroup !
103 $tax_group = get_tax_group_items_as_array($tax_group_id);
105 foreach ($this->grn_items as $ln_itm)
107 $items[] = $ln_itm->item_code;
108 $prices[] =round( ($ln_itm->this_quantity_inv * $ln_itm->taxfree_charge_price($tax_group_id, $tax_group)),
112 if ($tax_group_id == null)
113 $tax_group_id = $this->tax_group_id;
115 $taxes = get_tax_for_items($items, $prices, $shipping_cost, $tax_group_id);
117 ///////////////// Joe Hunt 2009.08.18
121 foreach ($this->gl_codes as $gl_code)
123 $index = is_tax_account($gl_code->gl_code);
124 if ($index !== false)
126 $taxes[$index]['Value'] += $gl_code->amount;
134 function get_total_charged($tax_group_id=null)
138 // preload the taxgroup !
139 if ($tax_group_id != null)
140 $tax_group = get_tax_group_items_as_array($tax_group_id);
144 foreach ($this->grn_items as $ln_itm)
145 $total += round(($ln_itm->this_quantity_inv * $ln_itm->taxfree_charge_price($tax_group_id, $tax_group)),
148 foreach ($this->gl_codes as $gl_line)
149 { //////// 2009-08-18 Joe Hunt
150 if (!is_tax_account($gl_line->gl_code))
151 $total += $gl_line->amount;
156 } /* end of class defintion */
161 /* Contains relavent information from the purch_order_details as well to provide in cached form,
162 all the info to do the necessary entries without looking up ie additional queries of the database again */
167 var $item_description;
169 var $prev_quantity_inv;
170 var $this_quantity_inv;
176 function grn_item ($id, $po_detail_item, $item_code, $item_description, $qty_recd,
177 $prev_quantity_inv, $this_quantity_inv, $order_price, $chg_price,
178 $std_cost_unit, $gl_code)
182 $this->po_detail_item = $po_detail_item;
183 $this->item_code = $item_code;
184 $this->item_description = $item_description;
185 $this->qty_recd = $qty_recd;
186 $this->prev_quantity_inv = $prev_quantity_inv;
187 $this->this_quantity_inv = $this_quantity_inv;
188 $this->order_price =$order_price;
189 $this->chg_price = $chg_price;
190 $this->std_cost_unit = $std_cost_unit;
191 $this->gl_code = $gl_code;
194 function full_charge_price($tax_group_id, $tax_group=null)
196 return get_full_price_for_item($this->item_code,
197 $this->chg_price, $tax_group_id, 0, $tax_group);
200 function taxfree_charge_price($tax_group_id, $tax_group=null)
202 // if ($tax_group_id==null)
203 // return $this->chg_price;
204 return get_tax_free_price_for_item($this->item_code, $this->chg_price,
205 $tax_group_id, 0, $tax_group);
221 function gl_codes ($Counter, $gl_code, $gl_act_name, $gl_dim, $gl_dim2, $amount, $memo_)
224 /* Constructor function to add a new gl_codes object with passed params */
225 $this->Counter = $Counter;
226 $this->gl_code = $gl_code;
227 $this->gl_act_name = $gl_act_name;
228 $this->gl_dim = $gl_dim;
229 $this->gl_dim2 = $gl_dim2;
230 $this->amount = $amount;
231 $this->memo_= $memo_;