sales/includes/db/sales_invoice_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 //      Add or update Sales Invoice
  14 //
  15 function write_sales_invoice(&$invoice)
  16 {
  17         global $Refs;
  18
  19         $trans_no = $invoice->trans_no;
  20         if (is_array($trans_no))
  21                 $trans_no = key($trans_no);
  22
  23         $date_ = $invoice->document_date;
  24         $charge_shipping =$invoice->freight_cost;
  25
  26         begin_transaction(__FUNCTION__, func_get_args());
  27
  28         hook_db_prewrite($invoice, ST_SALESINVOICE);
  29         $company_data = get_company_prefs();
  30
  31         $branch_data = get_branch_accounts($invoice->Branch);
  32
  33         $customer = get_customer($invoice->customer_id);
  34
  35         add_new_exchange_rate($customer['curr_code'], $date_, $invoice->ex_rate);
  36
  37         // offer price values without freight costs
  38         $items_total = $invoice->get_items_total_dispatch();
  39         $freight_tax = $invoice->get_shipping_tax();
  40
  41         if (!$invoice->is_prepaid())
  42                 update_customer_trans_version(get_parent_type(ST_SALESINVOICE), $invoice->src_docs);
  43     elseif (count($invoice->prepayments)) {     // partial invoice
  44                 $last_payment = end($invoice->prepayments);
  45                 $gl_date = sql2date($last_payment['tran_date']);
  46         } else {        // final invoice
  47                 $gl_date = $invoice->document_date;
  48         }
  49
  50         $ov_gst = 0;
  51         $taxes = $invoice->get_taxes(); // all taxes with freight_tax
  52         $dec = user_price_dec();
  53         foreach ($taxes as $taxitem) {
  54                 $taxitem['Value'] =  round2($taxitem['Value'], $dec);
  55                 $ov_gst +=  $taxitem['Value'];
  56         }
  57
  58         if($invoice->tax_included==0) {
  59             $items_added_tax = $ov_gst - $freight_tax;
  60             $freight_added_tax = $freight_tax;
  61         } else {
  62             $items_added_tax = 0;
  63             $freight_added_tax = 0;
  64         }
  65
  66         /* Insert/update the debtor_trans */
  67         $sales_order = $invoice->order_no;
  68         if (is_array($sales_order))
  69                         $sales_order = $sales_order[0]; // assume all crucial SO data are same for every delivery
  70
  71         if ($trans_no) {
  72                 $allocs = get_payments_for($trans_no, ST_SALESINVOICE, $invoice->customer_id);
  73                 delete_comments(ST_SALESINVOICE, $trans_no);
  74                 void_gl_trans(ST_SALESINVOICE, $trans_no, true);
  75                 void_trans_tax_details(ST_SALESINVOICE, $trans_no);
  76         } else
  77                 $allocs = get_payments_for($invoice->order_no, ST_SALESORDER, $invoice->customer_id);
  78
  79         if ($invoice->is_prepaid()) // selected prepayment is already in cart
  80         {
  81                 $allocs = $invoice->prepayments;
  82                 // values posted are reduced by prepaid_factor
  83                 $prepaid_factor = $invoice->prep_amount/$invoice->get_trans_total();
  84         } else {
  85                 $prepaid_factor = 1;
  86         }
  87
  88          // write_customer_trans have to be called after optional void_cust_allocations above
  89         $invoice_no = write_customer_trans(ST_SALESINVOICE, $trans_no, $invoice->customer_id,
  90                 $invoice->Branch, $date_, $invoice->reference, $items_total, 0,
  91                 $items_added_tax, $invoice->freight_cost, $freight_added_tax,
  92                 $invoice->sales_type, $sales_order, $invoice->ship_via,
  93                 $invoice->due_date, 0, 0, $invoice->dimension_id,
  94                 $invoice->dimension2_id, $invoice->payment, $invoice->tax_included, $invoice->prep_amount);
  95
  96         if ($trans_no == 0) {
  97                 $invoice->trans_no = array($invoice_no=>0);
  98         } else
  99                 move_trans_attachments(ST_SALESINVOICE, $trans_no, $invoice_no);
 100
 101         $total = 0;
 102         // for prepayments use deferred income account if set
 103         $sales_account = $invoice->is_prepaid() ? get_company_pref('deferred_income_act') : 0;
 104
 105         $invoice->split_line_values();
 106         foreach ($invoice->line_items as $line_no => $line) {
 107                 $qty = $line->qty_dispatched;
 108                 $line_taxfree_price = $line->gl_amounts['Net'];
 109
 110                 $line_tax = $line->gl_amounts['Tax'];
 111
 112                 write_customer_trans_detail_item(ST_SALESINVOICE, $invoice_no, $line->stock_id,
 113                         $line->item_description, $line->qty_dispatched,
 114                         $line->line_price(), $qty ? $line_tax/$qty : 0, $line->discount_percent,
 115                         $line->unit_cost, $line->src_id,
 116                         $trans_no ? $line->id : 0);
 117
 118                 // Update delivery items for the quantity invoiced
 119                 if ($line->qty_old != $line->qty_dispatched)
 120                 {
 121                         if ($invoice->is_prepaid())
 122                                 update_prepaid_so_line($line->src_id, $line->qty_dispatched-$line->qty_old);
 123                         else
 124                                 update_parent_line(ST_SALESINVOICE, $line->src_id, ($line->qty_dispatched-$line->qty_old));
 125                 }
 126                 if ($line->qty_dispatched != 0) {
 127                         $stock_gl_code = get_stock_gl_code($line->stock_id);
 128
 129                         if ($line->line_price() != 0) {
 130                                 //Post sales transaction to GL credit sales
 131
 132                                 // If there is a Branch Sales Account, then override with this,
 133                                 // else take the Item Sales Account
 134                                 if (!$invoice->is_prepaid())
 135                                         $sales_account = ($branch_data['sales_account'] != "" ? $branch_data['sales_account'] : $stock_gl_code['sales_account']);
 136                                 // If there is a Customer Dimension, then override with this,
 137                                 // else take the Item Dimension (if any)
 138                                 $dim = ($invoice->dimension_id != $customer['dimension_id'] ? $invoice->dimension_id :
 139                                         ($customer['dimension_id'] != 0 ? $customer["dimension_id"] : $stock_gl_code["dimension_id"]));
 140                                 $dim2 = ($invoice->dimension2_id != $customer['dimension2_id'] ? $invoice->dimension2_id :
 141                                         ($customer['dimension2_id'] != 0 ? $customer["dimension2_id"] : $stock_gl_code["dimension2_id"]));
 142                                 $total += add_gl_trans_customer(ST_SALESINVOICE, $invoice_no, $date_, $sales_account, $dim, $dim2,
 143                                         -$line_taxfree_price*$prepaid_factor, $invoice->customer_id);
 144
 145                                 if ($line->discount_percent != 0) {
 146
 147                                         $total += add_gl_trans_customer(ST_SALESINVOICE, $invoice_no, $date_,
 148                                                 $branch_data["sales_discount_account"], $dim, $dim2,
 149                                                 ($line_taxfree_price * $line->discount_percent)*$prepaid_factor, $invoice->customer_id);
 150                                 } /*end of if discount !=0 */
 151                         }
 152                 } /*quantity dispatched is more than 0 */
 153         } /*end of delivery_line loop */
 154
 155         if (($items_total + $charge_shipping) != 0) {
 156                 $total += add_gl_trans_customer(ST_SALESINVOICE, $invoice_no, $date_, $branch_data["receivables_account"], 0, 0,
 157                         ($items_total + $charge_shipping + $items_added_tax + $freight_added_tax)*$prepaid_factor, $invoice->customer_id);
 158         }
 159         $to_allocate = ($items_total + $charge_shipping + $items_added_tax + $freight_added_tax);
 160
 161         $freight = get_item($invoice->ship_via);
 162
 163         if ($charge_shipping != 0) {
 164                 $total += add_gl_trans_customer(ST_SALESINVOICE, $invoice_no, $date_, $freight["sales_account"], 0, 0,
 165                         -$invoice->get_tax_free_shipping()*$prepaid_factor, $invoice->customer_id);
 166         }
 167         // post all taxes
 168         foreach ($taxes as $taxitem) {
 169                 if ($taxitem['Net'] != 0) {
 170                         $ex_rate = get_exchange_rate_from_home_currency(get_customer_currency($invoice->customer_id), $date_);
 171                         add_trans_tax_details(ST_SALESINVOICE, $invoice_no, $taxitem['tax_type_id'],
 172                                 $taxitem['rate'], $invoice->tax_included, $prepaid_factor*$taxitem['Value'],
 173                                  $taxitem['Net'], $ex_rate, $date_, $invoice->reference, TR_OUTPUT, $invoice->tax_group_id);
 174                         if (isset($taxitem['sales_gl_code']) && !empty($taxitem['sales_gl_code']) && $taxitem['Value'] != 0)
 175                                 $total += add_gl_trans_customer(ST_SALESINVOICE, $invoice_no, $date_, $taxitem['sales_gl_code'], 0, 0,
 176                                         (-$taxitem['Value'])*$prepaid_factor, $invoice->customer_id);
 177                 }
 178         }
 179
 180         /*Post a balance post if $total != 0 */
 181         add_gl_balance(ST_SALESINVOICE, $invoice_no, $date_, -$total, PT_CUSTOMER, $invoice->customer_id);
 182
 183         add_comments(ST_SALESINVOICE, $invoice_no, $date_, $invoice->Comments);
 184
 185         if ($trans_no == 0) {
 186                 $Refs->save(ST_SALESINVOICE, $invoice_no, $invoice->reference, null, $invoice->fixed_asset);
 187                 if ($invoice->payment_terms['cash_sale'] && $invoice->pos['pos_account']) {
 188                         $amount = $items_total + $items_added_tax + $invoice->freight_cost
 189                                 + $freight_added_tax;
 190
 191                         // to use debtors.pmt_discount on cash sale:
 192                         // extend invoice entry page with final amount after discount
 193                         // and change line below.
 194                         $discount = 0; // $invoice->cash_discount*$amount;
 195                         $pmtno = write_customer_payment(0, $invoice->customer_id,
 196                                 $invoice->Branch, $invoice->pos['pos_account'], $date_,
 197                                 $Refs->get_next(ST_CUSTPAYMENT, null, array('customer' => $invoice->customer_id,
 198                                         'branch' => $invoice->Branch, 'date' => $date_)),
 199                                 $amount-$discount, $discount,
 200                                 $invoice->pos['pos_name'].' #'.$invoice_no);
 201                         add_cust_allocation($amount, ST_CUSTPAYMENT, $pmtno, ST_SALESINVOICE, $invoice_no, $invoice->customer_id, $date_);
 202
 203                         update_debtor_trans_allocation(ST_SALESINVOICE, $invoice_no, $invoice->customer_id);
 204                         update_debtor_trans_allocation(ST_CUSTPAYMENT, $pmtno, $invoice->customer_id);
 205                 }
 206         }
 207         reallocate_payments($invoice_no, ST_SALESINVOICE, $date_, $to_allocate, $allocs, $invoice->customer_id);
 208         hook_db_postwrite($invoice, ST_SALESINVOICE);
 209
 210         commit_transaction();
 211
 212         return $invoice_no;
 213 }
 214
 215 //--------------------------------------------------------------------------------------------------
 216
 217 function void_sales_invoice($type, $type_no)
 218 {
 219         begin_transaction(__FUNCTION__, func_get_args());
 220
 221         hook_db_prevoid($type, $type_no);
 222         void_bank_trans($type, $type_no, true);
 223         void_gl_trans($type, $type_no, true);
 224
 225         // reverse all the changes in parent document(s)
 226         $factor = get_cust_prepayment_invoice_factor($type_no);
 227         if ($factor != 0)
 228         {
 229                 $lines = get_customer_trans_details($type, $type_no);
 230                 while($line = db_fetch($lines))
 231                 {
 232                         update_prepaid_so_line($line['src_id'], -$factor*$line['quantity']);
 233                 }
 234         }
 235         else
 236         {
 237                 $deliveries = get_sales_parent_numbers($type, $type_no);
 238
 239                 if ($deliveries !== 0) {
 240                         if ($type == ST_SALESINVOICE && count($deliveries) == 1 && get_reference(ST_CUSTDELIVERY, $deliveries[0]) == "auto")
 241                         {
 242                                 void_sales_delivery(ST_CUSTDELIVERY, $deliveries[0], false);
 243                                 $date_ = Today();
 244                                 add_audit_trail(ST_CUSTDELIVERY, $deliveries[0], $date_, _("Voided."));
 245                                 add_voided_entry(ST_CUSTDELIVERY, $deliveries[0], $date_, "");
 246                         }
 247                         else
 248                         {
 249                                 $srcdetails = get_sales_parent_lines($type, $type_no);
 250                                 while ($row = db_fetch($srcdetails)) {
 251                                         update_parent_line($type, $row['id'], -$row['quantity']);
 252                                 }
 253                         }
 254                 }
 255         }
 256         // clear details after they've been reversed in the sales order
 257         void_customer_trans_details($type, $type_no);
 258
 259         void_stock_move($type, $type_no); // in case of credit note with return
 260
 261         void_trans_tax_details($type, $type_no);
 262
 263         void_cust_allocations($type, $type_no);
 264
 265         // do this last because other voidings can depend on it - especially voiding
 266         // DO NOT MOVE THIS ABOVE VOIDING or we can end up with trans with alloc < 0
 267         void_customer_trans($type, $type_no);
 268         commit_transaction();
 269 }
 270
 271 function is_cust_invoice_credited($trans_no)
 272 {
 273         return db_num_rows(get_sales_child_lines(ST_SALESINVOICE, $trans_no));
 274 }
 275
 276 function get_cust_prepayment_invoice_factor($trans_no)
 277 {
 278         $sql = "SELECT IF(dt.prep_amount>0, dt.prep_amount/so.total ,0)
 279                 FROM ".TB_PREF."debtor_trans dt
 280                 LEFT JOIN ".TB_PREF."sales_orders so ON so.trans_type=".ST_SALESORDER." AND so.order_no=dt.order_
 281                  WHERE dt.type=".ST_SALESINVOICE." AND trans_no=".db_escape($trans_no);
 282         $row = db_fetch(db_query($sql, 'cannot retrieve prepaid invoice factor'));
 283         return $row[0];
 284 }
 285
 286 /*
 287         Return yet not invoiced amount of prepayment invoice (or 0 if normal invoice)
 288 */
 289 function prepaid_invoice_remainder($order)
 290 {
 291         $sql = "SELECT so.total - IFNULL(SUM(inv.prep_amount),0) FROM "
 292                 .TB_PREF."sales_orders so,
 293                 ".TB_PREF."debtor_trans inv,
 294                 ".TB_PREF."payment_terms pt
 295                 WHERE  so.order_no=".db_escape($order)
 296                         ." AND so.trans_type=".ST_SALESORDER
 297                         ." AND inv.type=".ST_SALESINVOICE
 298                         ." AND inv.order_=so.order_no"
 299                         ." AND so.payment_terms=pt.terms_indicator"
 300                         ." AND inv.payment_terms=pt.terms_indicator"
 301                         ." AND pt.days_before_due = -1";
 302
 303         $result = db_fetch(db_query($sql, "cannot find final invoice value"));
 304         return $result[0] ? $result[0] : 0;
 305 }
 306
 307
 308 /*
 309         Find oldest delivery date for sales invoice
 310 */
 311 function get_oldest_delivery_date($invoice_no)
 312 {
 313         $sql = "SELECT MIN(trans.tran_date)
 314                         FROM
 315                                 ".TB_PREF."debtor_trans_details del
 316                         LEFT JOIN ".TB_PREF."debtor_trans_details inv
 317                                 ON inv.src_id=del.id
 318                         LEFT JOIN ".TB_PREF."debtor_trans trans
 319                                 ON trans.type=".ST_CUSTDELIVERY." AND trans.trans_no = del.debtor_trans_no
 320                         WHERE
 321                                 inv.debtor_trans_type=".ST_SALESINVOICE
 322                                 ." AND inv.debtor_trans_no=".db_escape($invoice_no);
 323         $res = db_query($sql, 'cannot find oldest delivery date');
 324         $date = db_fetch($res);
 325         return $date[0];
 326 }
 327
 328 /*
 329         Find oldest payment date for sales invoice
 330 */
 331 function get_oldest_payment_date($invoice_no)
 332 {
 333         $sql = "SELECT MIN(payment.tran_date)
 334                         FROM
 335                         ".TB_PREF."cust_allocations alloc,
 336                         ".TB_PREF."debtor_trans payment
 337                         WHERE
 338                                 alloc.trans_type_to=".ST_SALESINVOICE." AND alloc.trans_no_to=".db_escape($invoice_no)
 339                         ." AND alloc.trans_type_from=payment.type AND alloc.trans_no_from=payment.trans_no";
 340         $res = db_query($sql, 'cannot find oldest delivery date');
 341         $date = db_fetch($res);
 342         return $date[0];
 343 }