sales/includes/db/sales_credit_db.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 //----------------------------------------------------------------------------------------
  13 // if ($writeoff_acc==0) return goods into $cart->Location
  14 // if src_docs!=0 => credit invoice else credit note
  15 //
  16 function write_credit_note(&$credit_note, $write_off_acc)
  17 {
  18         global $Refs;
  19
  20         if (is_array($credit_note->src_docs))
  21         {
  22                 $docs = array_keys($credit_note->src_docs);
  23                 $credit_invoice = reset($docs);
  24         }
  25         else
  26                 $credit_invoice = $credit_note->src_docs;
  27
  28         $credit_date = $credit_note->document_date;
  29         $tax_group_id = $credit_note->tax_group_id;
  30
  31         $trans_no = $credit_note->trans_no;
  32         if (is_array($trans_no)) {
  33                 $trans_no = key($trans_no);
  34         }
  35
  36         $credit_type = $write_off_acc == 0 ? 'Return' : 'WriteOff';
  37
  38         begin_transaction();
  39         hook_db_prewrite($credit_note, ST_CUSTCREDIT);
  40
  41         $company_data = get_company_prefs();
  42         $branch_data = get_branch_accounts($credit_note->Branch);
  43
  44         $credit_note_total = $credit_note->get_items_total_dispatch();
  45         $freight_tax = $credit_note->get_shipping_tax();
  46
  47         $taxes = $credit_note->get_taxes();
  48
  49         $tax_total = 0;
  50         foreach ($taxes as $taxitem) {
  51                 $taxitem['Value'] =  round2($taxitem['Value'], user_price_dec());
  52                 $tax_total += $taxitem['Value'];
  53         }
  54
  55         if ($credit_note->tax_included == 0) {
  56             $items_added_tax = $tax_total-$freight_tax;
  57             $freight_added_tax = $freight_tax;
  58         } else {
  59             $items_added_tax = 0;
  60             $freight_added_tax = 0;
  61         }
  62         // 2006-06-14. If the Customer Branch AR Account is set to a Bank Account,
  63         // the transaction will be settled at once.
  64         if (is_bank_account($branch_data['receivables_account']))
  65                 $alloc = $credit_note_total + $items_added_tax + $credit_note->freight_cost + $freight_added_tax;
  66         else
  67                 $alloc = 0;
  68
  69 //      $sales_order=$invoice->order_no;        //?
  70 //    if (is_array($sales_order)) $sales_order = $sales_order[0]; //?
  71         if (!isset($credit_note->order_no))
  72                 $credit_note->order_no = 0;
  73
  74         /*Now insert the Credit Note into the debtor_trans table with the allocations as calculated above*/
  75         // all amounts in debtor's currency
  76         $credit_no = write_customer_trans(ST_CUSTCREDIT, $trans_no, $credit_note->customer_id,
  77                 $credit_note->Branch, $credit_date, $credit_note->reference,
  78                 $credit_note_total, 0, $items_added_tax,
  79                 $credit_note->freight_cost, $freight_added_tax,
  80                 $credit_note->sales_type, $credit_note->order_no, $credit_note->ship_via,
  81                 null, $alloc, 0, $credit_note->dimension_id, $credit_note->dimension2_id,
  82                 $credit_note->payment);
  83                 // 2008-06-14 extra $alloc, 2008-11-12 dimension_id Joe Hunt
  84
  85         if ($trans_no==0) {
  86                 $credit_note->trans_no = array($credit_no=>0);
  87         } else {
  88                 delete_comments(ST_CUSTCREDIT, $credit_no);
  89                 void_cust_allocations(ST_CUSTCREDIT, $credit_no, $credit_date);
  90                 void_gl_trans(ST_CUSTCREDIT, $credit_no, true);
  91                 void_stock_move(ST_CUSTCREDIT, $credit_no);
  92                 void_trans_tax_details(ST_CUSTCREDIT, $credit_no);
  93         }
  94         if ($credit_invoice) {
  95                 update_customer_trans_version(get_parent_type(ST_CUSTCREDIT), $credit_note->src_docs );
  96
  97                 $total = $credit_note_total + $credit_note->freight_cost + $items_added_tax
  98                         + $freight_added_tax;
  99
 100                 if (!credit_sales_invoice_allocate($credit_invoice, $credit_no, $total, $credit_date))
 101                         return false;
 102         }
 103
 104         $total = 0;
 105         foreach ($credit_note->line_items as $credit_line) {
 106
 107                 if ($credit_invoice && $credit_line->qty_dispatched!=$credit_line->qty_old ) {
 108                         update_parent_line(ST_CUSTCREDIT, $credit_line->src_id,($credit_line->qty_dispatched
 109                                         -$credit_line->qty_old));
 110                 }
 111
 112                 $line_taxfree_price = get_tax_free_price_for_item($credit_line->stock_id, $credit_line->price,
 113                   0, $credit_note->tax_included, $credit_note->tax_group_array);
 114
 115                 $line_tax = get_full_price_for_item($credit_line->stock_id, $credit_line->price,
 116                   0, $credit_note->tax_included, $credit_note->tax_group_array) - $line_taxfree_price;
 117
 118                 write_customer_trans_detail_item(ST_CUSTCREDIT, $credit_no, $credit_line->stock_id,
 119                         $credit_line->item_description, $credit_line->qty_dispatched,
 120                         $credit_line->line_price(), $line_tax, $credit_line->discount_percent,
 121                         $credit_line->standard_cost, $credit_line->src_id, $trans_no==0 ? 0:  $credit_line->id);
 122
 123                 add_credit_movements_item($credit_note, $credit_line,
 124                         $credit_type, $line_taxfree_price+$line_tax, $credit_invoice);
 125
 126                 $total += add_gl_trans_credit_costs($credit_note, $credit_line, $credit_no,
 127                     $credit_date, $credit_type, $write_off_acc, $branch_data);
 128         } /*end of credit_line loop */
 129
 130         /*Post credit note transaction to GL credit debtors,
 131         debit freight re-charged and debit sales */
 132
 133         if (($credit_note_total + $credit_note->freight_cost) != 0) {
 134
 135                 $total += add_gl_trans_customer(ST_CUSTCREDIT, $credit_no, $credit_date, $branch_data["receivables_account"], 0, 0,
 136                         -($credit_note_total + $credit_note->freight_cost + $items_added_tax + $freight_added_tax),
 137                         $credit_note->customer_id,
 138                         "The total debtor GL posting for the credit note could not be inserted");
 139         }
 140
 141         if ($credit_note->freight_cost != 0) {
 142                 $total += add_gl_trans_customer(ST_CUSTCREDIT, $credit_no, $credit_date, $company_data["freight_act"], 0, 0,
 143                         $credit_note->get_tax_free_shipping(), $credit_note->customer_id,
 144                         "The freight GL posting for this credit note could not be inserted");
 145         }
 146
 147         foreach ($taxes as $taxitem) {
 148                 if ($taxitem['Net'] != 0) {
 149
 150                         $ex_rate = get_exchange_rate_from_home_currency(get_customer_currency($credit_note->customer_id), $credit_note->document_date);
 151                         add_trans_tax_details(ST_CUSTCREDIT, $credit_no, $taxitem['tax_type_id'],
 152                                 $taxitem['rate'], $credit_note->tax_included, $taxitem['Value'],
 153                                 $taxitem['Net'], $ex_rate,
 154                                 $credit_note->document_date, $credit_note->reference);
 155
 156                         $total += add_gl_trans_customer(ST_CUSTCREDIT, $credit_no, $credit_date, $taxitem['sales_gl_code'], 0, 0,
 157                                 $taxitem['Value'], $credit_note->customer_id,
 158                                 "A tax GL posting for this credit note could not be inserted");
 159                 }
 160         }
 161         /*Post a balance post if $total != 0 */
 162         add_gl_balance(ST_CUSTCREDIT, $credit_no, $credit_date, -$total, PT_CUSTOMER, $credit_note->customer_id);
 163
 164         add_comments(ST_CUSTCREDIT, $credit_no, $credit_date, $credit_note->Comments);
 165
 166         if ($trans_no == 0) {
 167                 $Refs->save(ST_CUSTCREDIT, $credit_no, $credit_note->reference);
 168         }
 169         hook_db_postwrite($credit_note, ST_CUSTCREDIT);
 170         commit_transaction();
 171
 172         return $credit_no;
 173 }
 174
 175 //----------------------------------------------------------------------------------------
 176 // Insert a stock movement coming back in to show the credit note and
 177 //      a reversing stock movement to show the write off
 178 //
 179
 180 function add_credit_movements_item(&$credit_note, &$credit_line,
 181         $credit_type, $price, $credited_invoice=0)
 182 {
 183
 184     //Chaitanya : Stamp current cost in stock moves $credit_line does not fetch cost
 185     $curr_std_cost = get_standard_cost($credit_line->stock_id);
 186
 187         if ($credit_type == "Return") {
 188
 189                 $reference = "Return ";
 190                 if ($credited_invoice) {
 191                         $reference .= "Ex Inv: " . $credited_invoice;
 192                 }
 193
 194         } elseif ($credit_type == "WriteOff") {
 195
 196                 $reference = "WriteOff ";
 197                 if ($credited_invoice)
 198                         $reference .= "Ex Inv: " . $credited_invoice;
 199
 200                 add_stock_move_customer(ST_CUSTCREDIT,  $credit_line->stock_id,
 201                 key($credit_note->trans_no), $credit_note->Location,
 202                 $credit_note->document_date, $reference, -$credit_line->qty_dispatched,
 203                 $curr_std_cost,  0, $price,
 204                 $credit_line->discount_percent);
 205
 206         }
 207     add_stock_move_customer(ST_CUSTCREDIT,  $credit_line->stock_id,
 208         key($credit_note->trans_no), $credit_note->Location,
 209         $credit_note->document_date, $reference, $credit_line->qty_dispatched,
 210         $curr_std_cost,  0, $price,
 211         $credit_line->discount_percent);
 212
 213 }
 214
 215 //----------------------------------------------------------------------------------------
 216
 217 function add_gl_trans_credit_costs($order, $order_line, $credit_no, $date_,
 218         $credit_type, $write_off_gl_code, &$branch_data)
 219 {
 220         $stock_gl_codes = get_stock_gl_code($order_line->stock_id);
 221         $customer = get_customer($order->customer_id);
 222         // 2008-08-01. If there is a Customer Dimension, then override with this,
 223         // else take the Item Dimension (if any)
 224         $dim = ($order->dimension_id != $customer['dimension_id'] ? $order->dimension_id :
 225                 ($customer['dimension_id'] != 0 ? $customer["dimension_id"] : $stock_gl_codes["dimension_id"]));
 226         $dim2 = ($order->dimension2_id != $customer['dimension2_id'] ? $order->dimension2_id :
 227                 ($customer['dimension2_id'] != 0 ? $customer["dimension2_id"] : $stock_gl_codes["dimension2_id"]));
 228
 229         $total = 0;
 230         /* insert gl_trans to credit stock and debit cost of sales at standard cost*/
 231         $standard_cost = get_standard_cost($order_line->stock_id);
 232         if ($standard_cost != 0) {
 233                 /*first the cost of sales entry*/
 234
 235                 $total += add_gl_trans_std_cost(ST_CUSTCREDIT, $credit_no, $date_, $stock_gl_codes["cogs_account"],
 236                         $dim, $dim2, "", -($standard_cost * $order_line->qty_dispatched),
 237                         PT_CUSTOMER, $order->customer_id,
 238                         "The cost of sales GL posting could not be inserted");
 239
 240                 /*now the stock entry*/
 241                 if ($credit_type == "WriteOff") {
 242                         $stock_entry_account = $write_off_gl_code;
 243                 } else {
 244                         $stock_gl_code = get_stock_gl_code($order_line->stock_id);
 245                         $stock_entry_account = $stock_gl_code["inventory_account"];
 246                 }
 247
 248                 $total += add_gl_trans_std_cost(ST_CUSTCREDIT, $credit_no, $date_, $stock_entry_account, 0, 0,
 249                         "", ($standard_cost * $order_line->qty_dispatched),
 250                         PT_CUSTOMER, $order->customer_id,
 251                         "The stock side (or write off) of the cost of sales GL posting could not be inserted");
 252
 253         } /* end of if GL and stock integrated and standard cost !=0 */
 254
 255         if ($order_line->line_price() != 0) {
 256
 257                 $line_taxfree_price =
 258                 get_tax_free_price_for_item($order_line->stock_id, $order_line->price,
 259                   0, $order->tax_included, $order->tax_group_array);
 260
 261                 $line_tax = get_full_price_for_item($order_line->stock_id, $order_line->price,
 262                   0, $order->tax_included, $order->tax_group_array) - $line_taxfree_price;
 263
 264
 265                 //Post sales transaction to GL credit sales
 266
 267                 // 2008-06-14. If there is a Branch Sales Account, then override with this,
 268                 // else take the Item Sales Account
 269                 if ($branch_data['sales_account'] != "")
 270                         $sales_account = $branch_data['sales_account'];
 271                 else
 272                         $sales_account = $stock_gl_codes['sales_account'];
 273                 $total += add_gl_trans_customer(ST_CUSTCREDIT, $credit_no, $date_, $sales_account, $dim, $dim2,
 274                         ($line_taxfree_price * $order_line->qty_dispatched), $order->customer_id,
 275                         "The credit note GL posting could not be inserted");
 276
 277                 if ($order_line->discount_percent != 0) {
 278
 279                         $total += add_gl_trans_customer(ST_CUSTCREDIT, $credit_no, $date_, $branch_data["sales_discount_account"],
 280                                 $dim, $dim2, -($line_taxfree_price * $order_line->qty_dispatched * $order_line->discount_percent),
 281                                 $order->customer_id,
 282                                 "The credit note discount GL posting could not be inserted");
 283
 284                 } /*end of if discount !=0 */
 285         } /*if line_price!=0 */
 286         return $total;
 287 }
 288
 289 ?>