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();
  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         // offer price values without freight costs
  36         $items_total = $invoice->get_items_total_dispatch();
  37         $freight_tax = $invoice->get_shipping_tax();
  38
  39         update_customer_trans_version(get_parent_type(ST_SALESINVOICE), $invoice->src_docs);
  40
  41         $ov_gst = 0;
  42         $taxes = $invoice->get_taxes(); // all taxes with freight_tax
  43
  44         foreach ($taxes as $taxitem) {
  45                 $taxitem['Value'] =  round2($taxitem['Value'], user_price_dec());
  46                 $ov_gst +=  $taxitem['Value'];
  47         }
  48
  49         if($invoice->tax_included==0) {
  50             $items_added_tax = $ov_gst-$freight_tax;
  51             $freight_added_tax = $freight_tax;
  52         } else {
  53             $items_added_tax = 0;
  54             $freight_added_tax = 0;
  55         }
  56         // 2006-06-14. If the Customer Branch AR Account is set to a Bank Account,
  57         // the transaction will be settled at once.
  58         if (is_bank_account($branch_data['receivables_account']))
  59                 $alloc = $items_total + $items_added_tax + $invoice->freight_cost + $freight_added_tax;
  60         else
  61                 $alloc = 0;
  62
  63         /* Insert/update the debtor_trans */
  64         $sales_order = $invoice->order_no;
  65         if (is_array($sales_order))
  66                         $sales_order = $sales_order[0]; // assume all crucial SO data are same for every delivery
  67
  68         $invoice_no = write_customer_trans(ST_SALESINVOICE, $trans_no, $invoice->customer_id,
  69                 $invoice->Branch, $date_, $invoice->reference, $items_total, 0,
  70                 $items_added_tax, $invoice->freight_cost, $freight_added_tax,
  71                 $invoice->sales_type, $sales_order, $invoice->ship_via,
  72                 $invoice->due_date, $alloc, 0, $invoice->dimension_id,
  73                 $invoice->dimension2_id, $invoice->payment);
  74                 // 2008-06-14 extra $alloc, 2008-11-12 added dimension_id Joe Hunt
  75
  76         if ($trans_no == 0) {
  77                 $invoice->trans_no = array($invoice_no=>0);
  78         } else {
  79                 delete_comments(ST_SALESINVOICE, $invoice_no);
  80                 void_gl_trans(ST_SALESINVOICE, $invoice_no, true);
  81                 void_cust_allocations(ST_SALESINVOICE, $invoice_no); // ?
  82                 void_trans_tax_details(ST_SALESINVOICE, $invoice_no);
  83         }
  84         $total = 0;
  85         foreach ($invoice->line_items as $line_no => $invoice_line) {
  86
  87                 $line_taxfree_price = get_tax_free_price_for_item($invoice_line->stock_id,
  88                         $invoice_line->price, 0, $invoice->tax_included,
  89                         $invoice->tax_group_array);
  90
  91                 $line_tax = get_full_price_for_item($invoice_line->stock_id,
  92                         $invoice_line->price, 0, $invoice->tax_included,
  93                         $invoice->tax_group_array) - $line_taxfree_price;
  94
  95                 write_customer_trans_detail_item(ST_SALESINVOICE, $invoice_no, $invoice_line->stock_id,
  96                         $invoice_line->item_description, $invoice_line->qty_dispatched,
  97                         $invoice_line->line_price(), $line_tax, $invoice_line->discount_percent,
  98                         $invoice_line->standard_cost, $invoice_line->src_id,
  99                         $trans_no ? $invoice_line->id : 0);
 100
 101                 // Update delivery items for the quantity invoiced
 102                 if ($invoice_line->qty_old != $invoice_line->qty_dispatched)
 103                         update_parent_line(ST_SALESINVOICE, $invoice_line->src_id, ($invoice_line->qty_dispatched-$invoice_line->qty_old));
 104
 105                 if ($invoice_line->qty_dispatched != 0) {
 106                         $stock_gl_code = get_stock_gl_code($invoice_line->stock_id);
 107
 108                         if ($invoice_line->line_price() != 0) {
 109                                 //Post sales transaction to GL credit sales
 110
 111                                 // 2008-06-14. If there is a Branch Sales Account, then override with this,
 112                                 // else take the Item Sales Account
 113                                 $sales_account = ($branch_data['sales_account'] != "" ? $branch_data['sales_account'] : $stock_gl_code['sales_account']);
 114                                 // 2008-08-01. If there is a Customer Dimension, then override with this,
 115                                 // else take the Item Dimension (if any)
 116                                 $dim = ($invoice->dimension_id != $customer['dimension_id'] ? $invoice->dimension_id :
 117                                         ($customer['dimension_id'] != 0 ? $customer["dimension_id"] : $stock_gl_code["dimension_id"]));
 118                                 $dim2 = ($invoice->dimension2_id != $customer['dimension2_id'] ? $invoice->dimension2_id :
 119                                         ($customer['dimension2_id'] != 0 ? $customer["dimension2_id"] : $stock_gl_code["dimension2_id"]));
 120                                 $total += add_gl_trans_customer(ST_SALESINVOICE, $invoice_no, $date_, $sales_account, $dim, $dim2,
 121                                         (-$line_taxfree_price * $invoice_line->qty_dispatched),
 122                                         $invoice->customer_id, "The sales price GL posting could not be inserted");
 123
 124                                 if ($invoice_line->discount_percent != 0) {
 125
 126                                         $total += add_gl_trans_customer(ST_SALESINVOICE, $invoice_no, $date_,
 127                                                 $branch_data["sales_discount_account"], $dim, $dim2,
 128                                                 ($line_taxfree_price * $invoice_line->qty_dispatched * $invoice_line->discount_percent),
 129                                                 $invoice->customer_id, "The sales discount GL posting could not be inserted");
 130                                 } /*end of if discount !=0 */
 131                         }
 132                 } /*quantity dispatched is more than 0 */
 133         } /*end of delivery_line loop */
 134
 135         if (($items_total + $charge_shipping) != 0) {
 136                 $total += add_gl_trans_customer(ST_SALESINVOICE, $invoice_no, $date_, $branch_data["receivables_account"], 0, 0,
 137                         ($items_total + $charge_shipping + $items_added_tax + $freight_added_tax),
 138                         $invoice->customer_id, "The total debtor GL posting could not be inserted");
 139         }
 140
 141         if ($charge_shipping != 0) {
 142                 $total += add_gl_trans_customer(ST_SALESINVOICE, $invoice_no, $date_, $company_data["freight_act"], 0, 0,
 143                         -$invoice->get_tax_free_shipping(), $invoice->customer_id,
 144                         "The freight GL posting could not be inserted");
 145         }
 146         // post all taxes
 147         foreach ($taxes as $taxitem) {
 148
 149                 if ($taxitem['Net'] != 0) {
 150                         $ex_rate = get_exchange_rate_from_home_currency(get_customer_currency($invoice->customer_id), $date_);
 151                         add_trans_tax_details(ST_SALESINVOICE, $invoice_no, $taxitem['tax_type_id'],
 152                                 $taxitem['rate'], $invoice->tax_included, $taxitem['Value'],
 153                                  $taxitem['Net'], $ex_rate, $date_, $invoice->reference);
 154
 155                         $total += add_gl_trans_customer(ST_SALESINVOICE, $invoice_no, $date_, $taxitem['sales_gl_code'], 0, 0,
 156                                 (-$taxitem['Value']), $invoice->customer_id,
 157                                 "A tax GL posting could not be inserted");
 158                 }
 159         }
 160
 161         /*Post a balance post if $total != 0 */
 162         add_gl_balance(ST_SALESINVOICE, $invoice_no, $date_, -$total, PT_CUSTOMER, $invoice->customer_id);
 163
 164         add_comments(10, $invoice_no, $date_, $invoice->Comments);
 165
 166         if ($trans_no == 0) {
 167                 $Refs->save(ST_SALESINVOICE, $invoice_no, $invoice->reference);
 168                 if ($invoice->payment_terms['cash_sale']) {
 169                         $amount = $items_total + $items_added_tax + $invoice->freight_cost
 170                                 + $freight_added_tax;
 171
 172                         // to use debtors.pmt_discount on cash sale:
 173                         // extend invoice entry page with final amount after discount
 174                         // and change line below.
 175                         $discount = 0; // $invoice->cash_discount*$amount;
 176                         $pmtno = write_customer_payment(0, $invoice->customer_id,
 177                                 $invoice->Branch, $invoice->cash_account, $date_,
 178                                 $Refs->get_next(ST_CUSTPAYMENT), $amount-$discount, $discount,
 179                                 _('Cash invoice').' '.$invoice_no);
 180                         add_cust_allocation($amount, ST_CUSTPAYMENT, $pmtno, ST_SALESINVOICE, $invoice_no);
 181
 182                         update_debtor_trans_allocation(ST_SALESINVOICE, $invoice_no, $amount);
 183                         update_debtor_trans_allocation(ST_CUSTPAYMENT, $pmtno, $amount);
 184                 }
 185         }
 186         hook_db_postwrite($invoice, ST_SALESINVOICE);
 187         commit_transaction();
 188
 189         return $invoice_no;
 190 }
 191
 192 //--------------------------------------------------------------------------------------------------
 193
 194 function void_sales_invoice($type, $type_no)
 195 {
 196         begin_transaction();
 197
 198         hook_db_prevoid($type, $type_no);
 199         void_bank_trans($type, $type_no, true);
 200         void_gl_trans($type, $type_no, true);
 201
 202         // reverse all the changes in parent document(s)
 203
 204         $deliveries = get_sales_parent_numbers($type, $type_no);
 205
 206         if ($deliveries !== 0) {
 207                 if (count($deliveries) == 1 && get_reference(ST_CUSTDELIVERY, $deliveries[0]) == "auto")
 208                 {
 209                         void_sales_delivery(ST_CUSTDELIVERY, $deliveries[0], false);
 210                         $date_ = Today();
 211                         add_audit_trail(ST_CUSTDELIVERY, $deliveries[0], $date_, _("Voided."));
 212                         add_voided_entry(ST_CUSTDELIVERY, $deliveries[0], $date_, "");
 213                 }
 214                 else
 215                 {
 216
 217                         $srcdetails = get_sales_parent_lines($type, $type_no);
 218                         while ($row = db_fetch($src_details)) {
 219                                 update_parent_line($type, $row['id'], -$row['quantity']);
 220                         }
 221                 }
 222         }
 223         // clear details after they've been reversed in the sales order
 224         void_customer_trans_details($type, $type_no);
 225
 226         void_trans_tax_details($type, $type_no);
 227
 228         void_cust_allocations($type, $type_no);
 229
 230         // do this last because other voidings can depend on it - especially voiding
 231         // DO NOT MOVE THIS ABOVE VOIDING or we can end up with trans with alloc < 0
 232         void_customer_trans($type, $type_no);
 233
 234         commit_transaction();
 235 }
 236
 237 ?>