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 */
31 var $trans_type; // invoice or credit
42 var $gl_codes_counter=0;
44 var $tax_overrides = array(); // array of taxes manually inserted during sales invoice entry
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);
61 unset($this->tax_overrides); // cancel tax overrides after cart change
65 function add_gl_codes_to_trans($gl_code, $gl_act_name, $gl_dim, $gl_dim2, $amount, $memo_)
67 $this->gl_codes[$this->gl_codes_counter] = new gl_codes($this->gl_codes_counter,
68 $gl_code, $gl_act_name, $gl_dim, $gl_dim2, $amount, $memo_);
69 $this->gl_codes_counter++;
70 unset($this->tax_overrides); // cancel tax overrides after cart change
74 function remove_grn_from_trans($grn_item_id)
76 unset($this->tax_overrides); // cancel tax overrides after cart change
77 unset($this->grn_items[$grn_item_id]);
79 function remove_gl_codes_from_trans($gl_code_counter)
81 unset($this->tax_overrides); // cancel tax overrides after cart change
82 unset($this->gl_codes[$gl_code_counter]);
85 function is_valid_trans_to_post()
87 return (count($this->grn_items) > 0 || count($this->gl_codes) > 0 ||
88 ($this->ov_amount != 0) || ($this->ov_discount > 0));
91 function clear_items()
93 unset($this->grn_items);
94 unset($this->gl_codes);
95 $this->ov_amount = $this->ov_discount = $this->supplier_id = 0;
97 $this->grn_items = array();
98 $this->gl_codes = array();
101 function get_taxes($tax_group_id=null, $shipping_cost=0, $gl_codes=true)
106 if ($tax_group_id == null)
107 $tax_group_id = $this->tax_group_id;
109 // preload the taxgroup
110 $tax_group = get_tax_group_items_as_array($tax_group_id);
112 foreach ($this->grn_items as $ln_itm)
114 $items[] = $ln_itm->item_code;
115 $prices[] =round( ($ln_itm->this_quantity_inv * $ln_itm->chg_price),
119 if ($tax_group_id == null)
120 $tax_group_id = $this->tax_group_id;
121 $taxes = get_tax_for_items($items, $prices, $shipping_cost, $tax_group_id,
122 $this->tax_included);
124 if (isset($this->tax_overrides))
125 foreach($this->tax_overrides as $id => $value) // add values entered manually
127 $taxes[$id]['Override'] = $value;
130 // Taxes included in gl_codes table have exact value, but count to overrides as well.
131 // Therefore when we want to now taxes only for items (gl_codes==false),
132 // we have to subtract gl_taxes from override values.
133 foreach ($this->gl_codes as $gl_code)
135 $index = is_tax_account($gl_code->gl_code);
136 if ($index !== false)
139 $taxes[$index]['Value'] += $gl_code->amount;
140 elseif (isset($this->tax_overrides))
141 $taxes[$index]['Override'] -= $gl_code->amount;
148 // Returns total invoice amount without taxes.
150 function get_total_taxfree($tax_group_id=null)
154 // preload the taxgroup !
155 if ($tax_group_id != null)
156 $tax_group = get_tax_group_items_as_array($tax_group_id);
160 foreach ($this->grn_items as $ln_itm)
161 $total += round(($ln_itm->this_quantity_inv * $ln_itm->taxfree_charge_price($tax_group_id, $tax_group)),
164 foreach ($this->gl_codes as $gl_line)
166 if (!is_tax_account($gl_line->gl_code))
167 $total += $gl_line->amount;
172 function get_items_total()
176 foreach ($this->grn_items as $ln_itm)
177 $total += round($ln_itm->this_quantity_inv * $ln_itm->chg_price, user_price_dec());
179 foreach ($this->gl_codes as $gl_line)
181 if (!is_tax_account($gl_line->gl_code) || $this->tax_included)
182 $total += $gl_line->amount;
186 } /* end of class defintion */
191 /* Contains relavent information from the purch_order_details as well to provide in cached form,
192 all the info to do the necessary entries without looking up ie additional queries of the database again */
197 var $item_description;
199 var $prev_quantity_inv;
200 var $this_quantity_inv;
207 function grn_item ($id, $po_detail_item, $item_code, $item_description, $qty_recd,
208 $prev_quantity_inv, $this_quantity_inv, $order_price, $chg_price,
209 $std_cost_unit, $gl_code, $tax_included)
213 $this->po_detail_item = $po_detail_item;
214 $this->item_code = $item_code;
215 $this->item_description = $item_description;
216 $this->qty_recd = $qty_recd;
217 $this->prev_quantity_inv = $prev_quantity_inv;
218 $this->this_quantity_inv = $this_quantity_inv;
219 $this->order_price =$order_price;
220 $this->chg_price = $chg_price;
221 $this->std_cost_unit = $std_cost_unit;
222 $this->gl_code = $gl_code;
223 $this->tax_included = $tax_included;
226 function full_charge_price($tax_group_id, $tax_group=null)
228 return get_full_price_for_item($this->item_code,
229 $this->chg_price, $tax_group_id, $this->tax_included, $tax_group);
232 function taxfree_charge_price($tax_group_id, $tax_group=null)
234 return get_tax_free_price_for_item($this->item_code, $this->chg_price,
235 $tax_group_id, $this->tax_included, $tax_group);
251 function gl_codes ($Counter, $gl_code, $gl_act_name, $gl_dim, $gl_dim2, $amount, $memo_)
254 /* Constructor function to add a new gl_codes object with passed params */
255 $this->Counter = $Counter;
256 $this->gl_code = $gl_code;
257 $this->gl_act_name = $gl_act_name;
258 $this->gl_dim = $gl_dim;
259 $this->gl_dim2 = $gl_dim2;
260 $this->amount = $amount;
261 $this->memo_= $memo_;