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
15 function write_sales_invoice(&$invoice)
19 $trans_no = $invoice->trans_no;
20 if (is_array($trans_no))
21 $trans_no = key($trans_no);
23 $date_ = $invoice->document_date;
24 $charge_shipping =$invoice->freight_cost;
28 hook_db_prewrite($invoice, ST_SALESINVOICE);
29 $company_data = get_company_prefs();
31 $branch_data = get_branch_accounts($invoice->Branch);
33 $customer = get_customer($invoice->customer_id);
35 add_new_exchange_rate($customer['curr_code'], $date_, $invoice->ex_rate);
37 // offer price values without freight costs
38 $items_total = $invoice->get_items_total_dispatch();
39 $freight_tax = $invoice->get_shipping_tax();
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;
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'];
58 if($invoice->tax_included==0) {
59 $items_added_tax = $ov_gst-$freight_tax;
60 $freight_added_tax = $freight_tax;
63 $freight_added_tax = 0;
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
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);
77 $allocs = get_payments_for($invoice->order_no, ST_SALESORDER, $invoice->customer_id);
79 if ($invoice->is_prepaid()) // selected prepayment is already in cart
81 $allocs = $invoice->prepayments;
82 // values posted are reduced by prepaid_factor
83 $prepaid_factor = $invoice->prep_amount/$invoice->get_trans_total();
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);
97 $invoice->trans_no = array($invoice_no=>0);
99 move_trans_attachments(ST_SALESINVOICE, $trans_no, $invoice_no);
102 // for prepayments use deferred income account if set
103 $sales_account = $invoice->is_prepaid() ? get_company_pref('deferred_income_act') : 0;
105 foreach ($invoice->line_items as $line_no => $invoice_line) {
106 $qty = $invoice_line->qty_dispatched;
107 $line_taxfree_price = get_tax_free_price_for_item(ST_SALESINVOICE, $invoice_line->stock_id,
108 $invoice_line->price * $qty, $invoice->tax_group_id, $invoice->tax_included,
109 $invoice->tax_group_array);
111 $line_tax = get_full_price_for_item(ST_SALESINVOICE, $invoice_line->stock_id,
112 $invoice_line->price * $qty, 0, $invoice->tax_included,
113 $invoice->tax_group_array) - $line_taxfree_price;
115 write_customer_trans_detail_item(ST_SALESINVOICE, $invoice_no, $invoice_line->stock_id,
116 $invoice_line->item_description, $invoice_line->qty_dispatched,
117 $invoice_line->line_price(), $qty ? $line_tax/$qty : 0, $invoice_line->discount_percent,
118 $invoice_line->unit_cost, $invoice_line->src_id,
119 $trans_no ? $invoice_line->id : 0);
121 // Update delivery items for the quantity invoiced
122 if ($invoice_line->qty_old != $invoice_line->qty_dispatched)
124 if ($invoice->is_prepaid())
125 update_prepaid_so_line($invoice_line->src_id, $invoice_line->qty_dispatched-$invoice_line->qty_old);
127 update_parent_line(ST_SALESINVOICE, $invoice_line->src_id, ($invoice_line->qty_dispatched-$invoice_line->qty_old));
129 if ($invoice_line->qty_dispatched != 0) {
130 $stock_gl_code = get_stock_gl_code($invoice_line->stock_id);
132 if ($invoice_line->line_price() != 0) {
133 //Post sales transaction to GL credit sales
135 // If there is a Branch Sales Account, then override with this,
136 // else take the Item Sales Account
137 if (!$invoice->is_prepaid())
138 $sales_account = ($branch_data['sales_account'] != "" ? $branch_data['sales_account'] : $stock_gl_code['sales_account']);
139 // If there is a Customer Dimension, then override with this,
140 // else take the Item Dimension (if any)
141 $dim = ($invoice->dimension_id != $customer['dimension_id'] ? $invoice->dimension_id :
142 ($customer['dimension_id'] != 0 ? $customer["dimension_id"] : $stock_gl_code["dimension_id"]));
143 $dim2 = ($invoice->dimension2_id != $customer['dimension2_id'] ? $invoice->dimension2_id :
144 ($customer['dimension2_id'] != 0 ? $customer["dimension2_id"] : $stock_gl_code["dimension2_id"]));
145 $total += add_gl_trans_customer(ST_SALESINVOICE, $invoice_no, $date_, $sales_account, $dim, $dim2,
146 -$line_taxfree_price*$prepaid_factor, $invoice->customer_id);
148 if ($invoice_line->discount_percent != 0) {
150 $total += add_gl_trans_customer(ST_SALESINVOICE, $invoice_no, $date_,
151 $branch_data["sales_discount_account"], $dim, $dim2,
152 ($line_taxfree_price * $invoice_line->discount_percent)*$prepaid_factor, $invoice->customer_id);
153 } /*end of if discount !=0 */
155 } /*quantity dispatched is more than 0 */
156 } /*end of delivery_line loop */
158 if (($items_total + $charge_shipping) != 0) {
159 $total += add_gl_trans_customer(ST_SALESINVOICE, $invoice_no, $date_, $branch_data["receivables_account"], 0, 0,
160 ($items_total + $charge_shipping + $items_added_tax + $freight_added_tax)*$prepaid_factor, $invoice->customer_id);
162 $to_allocate = ($items_total + $charge_shipping + $items_added_tax + $freight_added_tax);
164 if ($charge_shipping != 0) {
165 $total += add_gl_trans_customer(ST_SALESINVOICE, $invoice_no, $date_, $company_data["freight_act"], 0, 0,
166 -$invoice->get_tax_free_shipping()*$prepaid_factor, $invoice->customer_id);
169 foreach ($taxes as $taxitem) {
170 if ($taxitem['Net'] != 0) {
171 $ex_rate = get_exchange_rate_from_home_currency(get_customer_currency($invoice->customer_id), $date_);
172 add_trans_tax_details(ST_SALESINVOICE, $invoice_no, $taxitem['tax_type_id'],
173 $taxitem['rate'], $invoice->tax_included, $prepaid_factor*$taxitem['Value'],
174 $taxitem['Net'], $ex_rate, $date_, $invoice->reference, TR_OUTPUT, $invoice->tax_group_id);
175 if (isset($taxitem['sales_gl_code']) && !empty($taxitem['sales_gl_code']) && $taxitem['Value'] != 0)
176 $total += add_gl_trans_customer(ST_SALESINVOICE, $invoice_no, $date_, $taxitem['sales_gl_code'], 0, 0,
177 (-$taxitem['Value'])*$prepaid_factor, $invoice->customer_id);
181 /*Post a balance post if $total != 0 */
182 add_gl_balance(ST_SALESINVOICE, $invoice_no, $date_, -$total, PT_CUSTOMER, $invoice->customer_id);
184 add_comments(ST_SALESINVOICE, $invoice_no, $date_, $invoice->Comments);
186 if ($trans_no == 0) {
187 $Refs->save(ST_SALESINVOICE, $invoice_no, $invoice->reference, null, $invoice->fixed_asset);
188 if ($invoice->payment_terms['cash_sale'] && $invoice->pos['pos_account']) {
189 $amount = $items_total + $items_added_tax + $invoice->freight_cost
190 + $freight_added_tax;
192 // to use debtors.pmt_discount on cash sale:
193 // extend invoice entry page with final amount after discount
194 // and change line below.
195 $discount = 0; // $invoice->cash_discount*$amount;
196 $pmtno = write_customer_payment(0, $invoice->customer_id,
197 $invoice->Branch, $invoice->pos['pos_account'], $date_,
198 $Refs->get_next(ST_CUSTPAYMENT, null, array('customer' => $invoice->customer_id,
199 'branch' => $invoice->Branch, 'date' => $date_)),
200 $amount-$discount, $discount,
201 $invoice->pos['pos_name'].' #'.$invoice_no);
202 add_cust_allocation($amount, ST_CUSTPAYMENT, $pmtno, ST_SALESINVOICE, $invoice_no, $invoice->customer_id, $date_);
204 update_debtor_trans_allocation(ST_SALESINVOICE, $invoice_no, $invoice->customer_id);
205 update_debtor_trans_allocation(ST_CUSTPAYMENT, $pmtno, $invoice->customer_id);
208 reallocate_payments($invoice_no, ST_SALESINVOICE, $date_, $to_allocate, $allocs, $invoice->customer_id);
209 hook_db_postwrite($invoice, ST_SALESINVOICE);
211 commit_transaction();
216 //--------------------------------------------------------------------------------------------------
218 function void_sales_invoice($type, $type_no)
222 hook_db_prevoid($type, $type_no);
223 void_bank_trans($type, $type_no, true);
224 void_gl_trans($type, $type_no, true);
226 // reverse all the changes in parent document(s)
227 $factor = get_cust_prepayment_invoice_factor($type_no);
230 $lines = get_customer_trans_details($type, $type_no);
231 while($line = db_fetch($lines))
233 update_prepaid_so_line($line['src_id'], -$factor*$line['quantity']);
238 $deliveries = get_sales_parent_numbers($type, $type_no);
240 if ($deliveries !== 0) {
241 if ($type == ST_SALESINVOICE && count($deliveries) == 1 && get_reference(ST_CUSTDELIVERY, $deliveries[0]) == "auto")
243 void_sales_delivery(ST_CUSTDELIVERY, $deliveries[0], false);
245 add_audit_trail(ST_CUSTDELIVERY, $deliveries[0], $date_, _("Voided."));
246 add_voided_entry(ST_CUSTDELIVERY, $deliveries[0], $date_, "");
250 $srcdetails = get_sales_parent_lines($type, $type_no);
251 while ($row = db_fetch($srcdetails)) {
252 update_parent_line($type, $row['id'], -$row['quantity']);
257 // clear details after they've been reversed in the sales order
258 void_customer_trans_details($type, $type_no);
260 void_stock_move($type, $type_no); // in case of credit note with return
262 void_trans_tax_details($type, $type_no);
264 void_cust_allocations($type, $type_no);
266 // do this last because other voidings can depend on it - especially voiding
267 // DO NOT MOVE THIS ABOVE VOIDING or we can end up with trans with alloc < 0
268 void_customer_trans($type, $type_no);
269 commit_transaction();
272 function is_cust_invoice_credited($trans_no)
274 return db_num_rows(get_sales_child_lines(ST_SALESINVOICE, $trans_no));
277 function get_cust_prepayment_invoice_factor($trans_no)
279 $sql = "SELECT IF(dt.prep_amount>0, dt.prep_amount/so.total ,0)
280 FROM ".TB_PREF."debtor_trans dt
281 LEFT JOIN ".TB_PREF."sales_orders so ON so.trans_type=".ST_SALESORDER." AND so.order_no=dt.order_
282 WHERE dt.type=".ST_SALESINVOICE." AND trans_no=".db_escape($trans_no);
283 $row = db_fetch(db_query($sql, 'cannot retrieve prepaid invoice factor'));
288 Return yet not invoiced amount of prepayment invoice (or 0 if normal invoice)
290 function prepaid_invoice_remainder($order)
292 $sql = "SELECT so.total - IFNULL(SUM(inv.prep_amount),0) FROM "
293 .TB_PREF."sales_orders so,
294 ".TB_PREF."debtor_trans inv,
295 ".TB_PREF."payment_terms pt
296 WHERE so.order_no=".db_escape($order)
297 ." AND so.trans_type=".ST_SALESORDER
298 ." AND inv.type=".ST_SALESINVOICE
299 ." AND inv.order_=so.order_no"
300 ." AND so.payment_terms=pt.terms_indicator"
301 ." AND inv.payment_terms=pt.terms_indicator"
302 ." AND pt.days_before_due = -1";
304 $result = db_fetch(db_query($sql, "cannot find final invoice value"));
305 return $result[0] ? $result[0] : 0;
310 Find oldest delivery date for sales invoice
312 function get_oldest_delivery_date($invoice_no)
314 $sql = "SELECT MIN(trans.tran_date)
316 ".TB_PREF."debtor_trans_details del
317 LEFT JOIN ".TB_PREF."debtor_trans_details inv
319 LEFT JOIN ".TB_PREF."debtor_trans trans
320 ON trans.type=".ST_CUSTDELIVERY." AND trans.trans_no = del.debtor_trans_no
322 inv.debtor_trans_type=".ST_SALESINVOICE
323 ." AND inv.debtor_trans_no=".db_escape($invoice_no);
324 $res = db_query($sql, 'cannot find oldest delivery date');
325 $date = db_fetch($res);
330 Find oldest payment date for sales invoice
332 function get_oldest_payment_date($invoice_no)
334 $sql = "SELECT MIN(payment.tran_date)
336 ".TB_PREF."cust_allocations alloc,
337 ".TB_PREF."debtor_trans payment
339 alloc.trans_type_to=".ST_SALESINVOICE." AND alloc.trans_no_to=".db_escape($invoice_no)
340 ." AND alloc.trans_type_from=payment.type AND alloc.trans_no_from=payment.trans_no";
341 $res = db_query($sql, 'cannot find oldest delivery date');
342 $date = db_fetch($res);