purchasing/includes/supp_trans_class.inc

   1 <?php
   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
  13 */
  14
  15 include_once($path_to_root . "/taxes/tax_calc.inc");
  16
  17 class supp_trans
  18 {
  19
  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 */
  22         var $supplier_id;
  23         var $supplier_name;
  24         var $terms_description;
  25         var $terms;
  26
  27         var $tax_description;
  28         var $tax_group_id;
  29         var $tax_included;
  30
  31         var $trans_type;        // invoice or credit
  32
  33         var $Comments;
  34         var $tran_date;
  35         var $due_date;
  36
  37         var $supp_reference;
  38         var $reference;
  39         var $ov_amount;
  40         var $ov_discount;
  41         var $ov_gst;
  42         var $gl_codes_counter=0;
  43
  44         function supp_trans($trans_type)
  45         {
  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();
  50         }
  51
  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)
  55         {
  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);
  59                 return 1;
  60         }
  61
  62         function add_gl_codes_to_trans($gl_code, $gl_act_name, $gl_dim, $gl_dim2, $amount, $memo_)
  63         {
  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++;
  67                 return 1;
  68         }
  69
  70         function remove_grn_from_trans($grn_item_id)
  71         {
  72             unset($this->grn_items[$grn_item_id]);
  73         }
  74         function remove_gl_codes_from_trans($gl_code_counter)
  75         {
  76              unset($this->gl_codes[$gl_code_counter]);
  77         }
  78
  79         function is_valid_trans_to_post()
  80         {
  81                 return (count($this->grn_items) > 0 || count($this->gl_codes) > 0 ||
  82                         ($this->ov_amount != 0) || ($this->ov_discount > 0));
  83         }
  84
  85         function clear_items()
  86         {
  87                 unset($this->grn_items);
  88                 unset($this->gl_codes);
  89                 $this->ov_amount = $this->ov_discount = $this->supplier_id = 0;
  90
  91                 $this->grn_items = array();
  92                 $this->gl_codes = array();
  93         }
  94
  95     function get_taxes($tax_group_id=null, $shipping_cost=0, $gl_codes=true)
  96     {
  97         $items = array();
  98         $prices = array();
  99
 100         if ($tax_group_id == null)
 101                 $tax_group_id = $this->tax_group_id;
 102
 103                 // preload the taxgroup !
 104                 $tax_group = get_tax_group_items_as_array($tax_group_id);
 105
 106         foreach ($this->grn_items as $ln_itm)
 107         {
 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),
 111                          user_price_dec());
 112         }
 113
 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);
 118
 119 ///////////////// Joe Hunt 2009.08.18
 120
 121                 if ($gl_codes)
 122                 {
 123                         foreach ($this->gl_codes as $gl_code)
 124                         {
 125                                 $index = is_tax_account($gl_code->gl_code);
 126                                 if ($index !== false)
 127                                 {
 128                                         $taxes[$index]['Value'] += $gl_code->amount;
 129                                 }
 130                         }
 131                 }
 132 ////////////////
 133         return $taxes;
 134     }
 135         //
 136         //      Returns total invoice amount without taxes.
 137         //
 138     function get_total_taxfree($tax_group_id=null)
 139     {
 140         $total = 0;
 141
 142                 // preload the taxgroup !
 143                 if ($tax_group_id != null)
 144                         $tax_group = get_tax_group_items_as_array($tax_group_id);
 145                 else
 146                         $tax_group = null;
 147
 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)),
 150                          user_price_dec());
 151
 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;
 156                 }
 157                 return $total;
 158     }
 159
 160         function get_items_total()
 161         {
 162                 $total = 0;
 163
 164                 foreach ($this->grn_items as $ln_itm)
 165                         $total += round($ln_itm->this_quantity_inv * $ln_itm->chg_price, user_price_dec());
 166
 167                 foreach ($this->gl_codes as $gl_line)
 168                 {   //////// 2010-10-10 Joe Hunt
 169                         if (!is_tax_account($gl_line->gl_code))
 170                                 $total += $gl_line->amount;
 171                 }
 172                 return $total;
 173         }
 174 } /* end of class defintion */
 175
 176 class grn_item
 177 {
 178
 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 */
 181
 182         var $id;
 183         var $po_detail_item;
 184         var $item_code;
 185         var $item_description;
 186         var $qty_recd;
 187         var $prev_quantity_inv;
 188         var $this_quantity_inv;
 189         var $order_price;
 190         var $chg_price;
 191         var $std_cost_unit;
 192         var $gl_code;
 193         var $tax_included;
 194
 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)
 198         {
 199
 200                 $this->id = $id;
 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;
 212         }
 213
 214         function full_charge_price($tax_group_id, $tax_group=null)
 215         {
 216                 return get_full_price_for_item($this->item_code,
 217                   $this->chg_price, $tax_group_id, $this->tax_included, $tax_group);
 218         }
 219
 220         function taxfree_charge_price($tax_group_id, $tax_group=null)
 221         {
 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);
 226         }
 227 }
 228
 229
 230 class gl_codes
 231 {
 232
 233         var $Counter;
 234         var $gl_code;
 235         var $gl_act_name;
 236         var $gl_dim;
 237         var $gl_dim2;
 238         var $amount;
 239         var $memo_;
 240
 241         function gl_codes ($Counter, $gl_code, $gl_act_name, $gl_dim, $gl_dim2, $amount, $memo_)
 242         {
 243
 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_;
 252         }
 253 }
 254
 255 ?>