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
37 var $src_docs = array(); // source invoice for this credit note (if any)
44 var $gl_codes_counter=0;
47 var $tax_overrides = array(); // array of taxes manually inserted during sales invoice entry
52 function __construct($trans_type, $trans_no=0)
54 $this->trans_type = $trans_type;
55 /*Constructor function initialises a new Supplier Transaction object */
56 $this->read($trans_type, $trans_no);
59 function read($trans_type, $trans_no)
61 $this->trans_type = $trans_type;
62 $this->trans_no = $trans_no;
63 $this->grn_items = array();
64 $this->gl_codes = array();
66 read_supp_invoice($trans_no, $trans_type, $this);
67 if ($trans_type == ST_SUPPCREDIT)
69 $this->src_docs = find_src_invoices($trans_no);
71 read_supplier_details_to_trans($this, $this->supplier_id);
75 function add_grn_to_trans($grn_item_id, $po_detail_item, $item_code, $item_description,
76 $qty_recd, $prev_quantity_inv, $this_quantity_inv, $order_price, $chg_price,
77 $std_cost_unit, $gl_code)
79 $this->grn_items[$grn_item_id] = new grn_item($grn_item_id, $po_detail_item,
80 $item_code, $item_description, $qty_recd, $prev_quantity_inv, $this_quantity_inv,
81 $order_price, $chg_price, $std_cost_unit, $gl_code, $this->tax_included);
83 $this->src_docs = find_src_invoices($this);
85 unset($this->tax_overrides); // cancel tax overrides after cart change
89 function add_gl_codes_to_trans($gl_code, $gl_act_name, $gl_dim, $gl_dim2, $amount, $memo_)
91 $this->gl_codes[$this->gl_codes_counter] = new gl_codes($this->gl_codes_counter,
92 $gl_code, $gl_act_name, $gl_dim, $gl_dim2, $amount, $memo_);
93 $this->gl_codes_counter++;
94 unset($this->tax_overrides); // cancel tax overrides after cart change
98 function remove_grn_from_trans($grn_item_id)
100 unset($this->tax_overrides); // cancel tax overrides after cart change
101 unset($this->grn_items[$grn_item_id]);
103 function remove_gl_codes_from_trans($gl_code_counter)
105 unset($this->tax_overrides); // cancel tax overrides after cart change
106 unset($this->gl_codes[$gl_code_counter]);
109 function is_valid_trans_to_post()
111 return (count($this->grn_items) > 0 || count($this->gl_codes) > 0 ||
112 ($this->ov_amount != 0) || ($this->ov_discount > 0));
115 function clear_items()
117 unset($this->grn_items);
118 unset($this->gl_codes);
119 $this->ov_amount = $this->ov_discount = $this->supplier_id = 0;
121 $this->grn_items = array();
122 $this->gl_codes = array();
125 function get_taxes($tax_group_id=null, $shipping_cost=0, $gl_codes=true)
130 if ($tax_group_id == null)
131 $tax_group_id = $this->tax_group_id;
133 // preload the taxgroup
134 $tax_group = get_tax_group_items_as_array($tax_group_id);
136 foreach ($this->grn_items as $ln_itm)
138 $items[] = $ln_itm->item_code;
139 $prices[] =round( ($ln_itm->this_quantity_inv * $ln_itm->chg_price),
143 if ($tax_group_id == null)
144 $tax_group_id = $this->tax_group_id;
145 $taxes = get_tax_for_items($items, $prices, $shipping_cost, $tax_group_id,
146 $this->tax_included);
148 if (isset($this->tax_overrides))
149 foreach($this->tax_overrides as $id => $value) // add values entered manually
151 $taxes[$id]['Override'] = $value;
154 // Taxes included in gl_codes table have exact value, but count to overrides as well.
155 // Therefore when we want to now taxes only for items (gl_codes==false),
156 // we have to subtract gl_taxes from override values.
157 foreach ($this->gl_codes as $gl_code)
159 $index = is_tax_account($gl_code->gl_code);
160 if ($index !== false)
163 $taxes[$index]['Value'] += $gl_code->amount;
164 elseif (isset($this->tax_overrides))
165 $taxes[$index]['Override'] -= $gl_code->amount;
172 // Returns total invoice amount without taxes.
174 function get_total_taxfree($tax_group_id=null)
178 // preload the taxgroup !
179 if ($tax_group_id != null)
180 $tax_group = get_tax_group_items_as_array($tax_group_id);
184 foreach ($this->grn_items as $ln_itm)
185 $total += round(($ln_itm->this_quantity_inv * $ln_itm->taxfree_charge_price($tax_group_id, $tax_group)),
188 foreach ($this->gl_codes as $gl_line)
190 if (!is_tax_account($gl_line->gl_code))
191 $total += $gl_line->amount;
196 // Returns transaction total
198 function get_items_total()
202 foreach ($this->grn_items as $ln_itm)
203 $total += round($ln_itm->this_quantity_inv * $ln_itm->chg_price, user_price_dec());
205 foreach ($this->gl_codes as $gl_line)
207 if (!is_tax_account($gl_line->gl_code) || $this->tax_included)
208 $total += $gl_line->amount;
212 } /* end of class defintion */
217 /* Contains relavent information from the purch_order_details as well to provide in cached form,
218 all the info to do the necessary entries without looking up ie additional queries of the database again */
223 var $item_description;
225 var $prev_quantity_inv;
226 var $this_quantity_inv;
233 function __construct($id, $po_detail_item, $item_code, $item_description, $qty_recd,
234 $prev_quantity_inv, $this_quantity_inv, $order_price, $chg_price,
235 $std_cost_unit, $gl_code, $tax_included)
239 $this->po_detail_item = $po_detail_item;
240 $this->item_code = $item_code;
241 $this->item_description = $item_description;
242 $this->qty_recd = $qty_recd;
243 $this->prev_quantity_inv = $prev_quantity_inv;
244 $this->this_quantity_inv = $this_quantity_inv;
245 $this->order_price =$order_price;
246 $this->chg_price = $chg_price;
247 $this->std_cost_unit = $std_cost_unit;
248 $this->gl_code = $gl_code;
249 $this->tax_included = $tax_included;
252 function full_charge_price($tax_group_id, $tax_group=null)
254 return get_full_price_for_item($this->item_code,
255 $this->chg_price, $tax_group_id, $this->tax_included, $tax_group);
258 function taxfree_charge_price($tax_group_id, $tax_group=null)
260 return get_tax_free_price_for_item($this->item_code, $this->chg_price,
261 $tax_group_id, $this->tax_included, $tax_group);
277 function __construct($Counter, $gl_code, $gl_act_name, $gl_dim, $gl_dim2, $amount, $memo_)
280 /* Constructor function to add a new gl_codes object with passed params */
281 $this->Counter = $Counter;
282 $this->gl_code = $gl_code;
283 $this->gl_act_name = $gl_act_name;
284 $this->gl_dim = $gl_dim;
285 $this->gl_dim2 = $gl_dim2;
286 $this->amount = $amount;
287 $this->memo_= $memo_;