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
16 function write_credit_note(&$credit_note, $write_off_acc)
20 if (is_array($credit_note->src_docs))
22 $docs = array_keys($credit_note->src_docs);
23 $credit_invoice = reset($docs);
26 $credit_invoice = $credit_note->src_docs;
28 $credit_date = $credit_note->document_date;
29 $tax_group_id = $credit_note->tax_group_id;
31 $trans_no = $credit_note->trans_no;
32 if (is_array($trans_no)) {
33 $trans_no = key($trans_no);
36 $credit_type = $write_off_acc == 0 ? 'Return' : 'WriteOff';
39 hook_db_prewrite($credit_note, ST_CUSTCREDIT);
41 $company_data = get_company_prefs();
42 $branch_data = get_branch_accounts($credit_note->Branch);
44 add_new_exchange_rate(get_customer_currency($credit_note->customer_id), $credit_date, $credit_note->ex_rate);
46 $credit_note_total = $credit_note->get_items_total_dispatch();
47 $freight_tax = $credit_note->get_shipping_tax();
49 $taxes = $credit_note->get_taxes();
52 foreach ($taxes as $taxitem) {
53 $taxitem['Value'] = round2($taxitem['Value'], user_price_dec());
54 $tax_total += $taxitem['Value'];
57 if ($credit_note->tax_included == 0) {
58 $items_added_tax = $tax_total-$freight_tax;
59 $freight_added_tax = $freight_tax;
62 $freight_added_tax = 0;
64 // 2006-06-14. If the Customer Branch AR Account is set to a Bank Account,
65 // the transaction will be settled at once.
66 if (is_bank_account($branch_data['receivables_account']))
67 $alloc = $credit_note_total + $items_added_tax + $credit_note->freight_cost + $freight_added_tax;
71 // $sales_order=$invoice->order_no; //?
72 // if (is_array($sales_order)) $sales_order = $sales_order[0]; //?
73 if (!isset($credit_note->order_no))
74 $credit_note->order_no = 0;
76 /*Now insert the Credit Note into the debtor_trans table with the allocations as calculated above*/
77 // all amounts in debtor's currency
78 $credit_no = write_customer_trans(ST_CUSTCREDIT, $trans_no, $credit_note->customer_id,
79 $credit_note->Branch, $credit_date, $credit_note->reference,
80 $credit_note_total, 0, $items_added_tax,
81 $credit_note->freight_cost, $freight_added_tax,
82 $credit_note->sales_type, $credit_note->order_no, $credit_note->ship_via,
83 null, $alloc, 0, $credit_note->dimension_id, $credit_note->dimension2_id,
84 $credit_note->payment, $credit_note->tax_included);
85 // 2008-06-14 extra $alloc, 2008-11-12 dimension_id Joe Hunt
88 $credit_note->trans_no = array($credit_no=>0);
90 delete_comments(ST_CUSTCREDIT, $credit_no);
91 void_cust_allocations(ST_CUSTCREDIT, $credit_no, $credit_date);
92 void_gl_trans(ST_CUSTCREDIT, $credit_no, true);
93 void_stock_move(ST_CUSTCREDIT, $credit_no);
94 void_trans_tax_details(ST_CUSTCREDIT, $credit_no);
96 if ($credit_invoice) {
97 update_customer_trans_version(get_parent_type(ST_CUSTCREDIT), $credit_note->src_docs );
99 $total = $credit_note_total + $credit_note->freight_cost + $items_added_tax
100 + $freight_added_tax;
102 if (!credit_sales_invoice_allocate($credit_invoice, $credit_no, $total, $credit_date))
107 foreach ($credit_note->line_items as $credit_line) {
109 if ($credit_invoice && $credit_line->qty_dispatched!=$credit_line->qty_old ) {
110 update_parent_line(ST_CUSTCREDIT, $credit_line->src_id,($credit_line->qty_dispatched
111 -$credit_line->qty_old));
114 $line_taxfree_price = get_tax_free_price_for_item($credit_line->stock_id, $credit_line->price,
115 0, $credit_note->tax_included, $credit_note->tax_group_array);
117 $line_tax = get_full_price_for_item($credit_line->stock_id, $credit_line->price,
118 0, $credit_note->tax_included, $credit_note->tax_group_array) - $line_taxfree_price;
120 write_customer_trans_detail_item(ST_CUSTCREDIT, $credit_no, $credit_line->stock_id,
121 $credit_line->item_description, $credit_line->qty_dispatched,
122 $credit_line->line_price(), $line_tax, $credit_line->discount_percent,
123 $credit_line->standard_cost, $credit_line->src_id, $trans_no==0 ? 0: $credit_line->id);
126 if ($credit_type == 'Return')
127 add_credit_movements_item($credit_note, $credit_line,
128 $credit_type, $line_taxfree_price+$line_tax, $credit_invoice);
130 $total += add_gl_trans_credit_costs($credit_note, $credit_line, $credit_no,
131 $credit_date, $credit_type, $write_off_acc, $branch_data);
132 } /*end of credit_line loop */
134 /*Post credit note transaction to GL credit debtors,
135 debit freight re-charged and debit sales */
137 if (($credit_note_total + $credit_note->freight_cost) != 0) {
139 $total += add_gl_trans_customer(ST_CUSTCREDIT, $credit_no, $credit_date, $branch_data["receivables_account"], 0, 0,
140 -($credit_note_total + $credit_note->freight_cost + $items_added_tax + $freight_added_tax),
141 $credit_note->customer_id,
142 "The total debtor GL posting for the credit note could not be inserted");
145 if ($credit_note->freight_cost != 0) {
146 $total += add_gl_trans_customer(ST_CUSTCREDIT, $credit_no, $credit_date, $company_data["freight_act"], 0, 0,
147 $credit_note->get_tax_free_shipping(), $credit_note->customer_id,
148 "The freight GL posting for this credit note could not be inserted");
151 foreach ($taxes as $taxitem) {
152 if ($taxitem['Net'] != 0) {
154 $ex_rate = get_exchange_rate_from_home_currency(get_customer_currency($credit_note->customer_id), $credit_note->document_date);
155 add_trans_tax_details(ST_CUSTCREDIT, $credit_no, $taxitem['tax_type_id'],
156 $taxitem['rate'], $credit_note->tax_included, $taxitem['Value'],
157 $taxitem['Net'], $ex_rate,
158 $credit_note->document_date, $credit_note->reference, TR_OUTPUT);
160 $total += add_gl_trans_customer(ST_CUSTCREDIT, $credit_no, $credit_date, $taxitem['sales_gl_code'], 0, 0,
161 $taxitem['Value'], $credit_note->customer_id,
162 "A tax GL posting for this credit note could not be inserted");
165 /*Post a balance post if $total != 0 */
166 add_gl_balance(ST_CUSTCREDIT, $credit_no, $credit_date, -$total, PT_CUSTOMER, $credit_note->customer_id);
168 add_comments(ST_CUSTCREDIT, $credit_no, $credit_date, $credit_note->Comments);
170 if ($trans_no == 0) {
171 $Refs->save(ST_CUSTCREDIT, $credit_no, $credit_note->reference);
173 hook_db_postwrite($credit_note, ST_CUSTCREDIT);
174 commit_transaction();
179 //----------------------------------------------------------------------------------------
180 // Insert a stock movement coming back in to show the credit note and
181 // a reversing stock movement to show the write off
183 function add_credit_movements_item(&$credit_note, &$credit_line,
184 $credit_type, $price, $credited_invoice=0)
186 //Chaitanya : Stamp current cost in stock moves $credit_line does not fetch cost
187 $curr_std_cost = get_standard_cost($credit_line->stock_id);
189 $reference = _("Return");
190 if ($credited_invoice) {
191 $reference .= ' '._("Ex Inv:").' ' . $credited_invoice;
194 add_stock_move_customer(ST_CUSTCREDIT, $credit_line->stock_id,
195 key($credit_note->trans_no), $credit_note->Location,
196 $credit_note->document_date, $reference, $credit_line->qty_dispatched,
197 $curr_std_cost, $price,
198 $credit_line->discount_percent);
201 //----------------------------------------------------------------------------------------
203 function add_gl_trans_credit_costs($order, $order_line, $credit_no, $date_,
204 $credit_type, $write_off_gl_code, &$branch_data)
206 $stock_gl_codes = get_stock_gl_code($order_line->stock_id);
207 $customer = get_customer($order->customer_id);
208 // 2008-08-01. If there is a Customer Dimension, then override with this,
209 // else take the Item Dimension (if any)
210 $dim = ($order->dimension_id != $customer['dimension_id'] ? $order->dimension_id :
211 ($customer['dimension_id'] != 0 ? $customer["dimension_id"] : $stock_gl_codes["dimension_id"]));
212 $dim2 = ($order->dimension2_id != $customer['dimension2_id'] ? $order->dimension2_id :
213 ($customer['dimension2_id'] != 0 ? $customer["dimension2_id"] : $stock_gl_codes["dimension2_id"]));
216 /* insert gl_trans to credit stock and debit cost of sales at standard cost*/
217 $standard_cost = get_standard_cost($order_line->stock_id);
218 if ($standard_cost != 0) {
219 /*first the cost of sales entry*/
221 $total += add_gl_trans_std_cost(ST_CUSTCREDIT, $credit_no, $date_, $stock_gl_codes["cogs_account"],
222 $dim, $dim2, "", -($standard_cost * $order_line->qty_dispatched),
223 PT_CUSTOMER, $order->customer_id,
224 "The cost of sales GL posting could not be inserted");
226 /*now the stock entry*/
227 if ($credit_type == "WriteOff") {
228 $stock_entry_account = $write_off_gl_code;
230 $stock_gl_code = get_stock_gl_code($order_line->stock_id);
231 $stock_entry_account = $stock_gl_code["inventory_account"];
234 $total += add_gl_trans_std_cost(ST_CUSTCREDIT, $credit_no, $date_, $stock_entry_account, 0, 0,
235 "", ($standard_cost * $order_line->qty_dispatched),
236 PT_CUSTOMER, $order->customer_id,
237 "The stock side (or write off) of the cost of sales GL posting could not be inserted");
239 } /* end of if GL and stock integrated and standard cost !=0 */
241 if ($order_line->line_price() != 0) {
243 $line_taxfree_price =
244 get_tax_free_price_for_item($order_line->stock_id, $order_line->price,
245 0, $order->tax_included, $order->tax_group_array);
247 $line_tax = get_full_price_for_item($order_line->stock_id, $order_line->price,
248 0, $order->tax_included, $order->tax_group_array) - $line_taxfree_price;
251 //Post sales transaction to GL credit sales
253 // 2008-06-14. If there is a Branch Sales Account, then override with this,
254 // else take the Item Sales Account
255 if ($branch_data['sales_account'] != "")
256 $sales_account = $branch_data['sales_account'];
258 $sales_account = $stock_gl_codes['sales_account'];
259 $total += add_gl_trans_customer(ST_CUSTCREDIT, $credit_no, $date_, $sales_account, $dim, $dim2,
260 ($line_taxfree_price * $order_line->qty_dispatched), $order->customer_id,
261 "The credit note GL posting could not be inserted");
263 if ($order_line->discount_percent != 0) {
265 $total += add_gl_trans_customer(ST_CUSTCREDIT, $credit_no, $date_, $branch_data["sales_discount_account"],
266 $dim, $dim2, -($line_taxfree_price * $order_line->qty_dispatched * $order_line->discount_percent),
268 "The credit note discount GL posting could not be inserted");
270 } /*end of if discount !=0 */
271 } /*if line_price!=0 */