3 //----------------------------------------------------------------------------------------
4 // if ($writeoff_acc==0) return goods into $cart->Location
5 // if src_docs!=0 => credit invoice else credit note
7 function write_credit_note($credit_note, $write_off_acc)
9 // Changed 2008-09-26 Joe Hunt -------
10 $credit_invoice = count(array_keys($credit_note->src_docs)) ? reset(array_keys($credit_note->src_docs)) : 0;
12 $credit_date = $credit_note->document_date;
13 $tax_group_id = $credit_note->tax_group_id;
15 $trans_no = $credit_note->trans_no;
16 if (is_array($trans_no)) {
17 $trans_no = key($trans_no);
20 $credit_type = $write_off_acc == 0 ? 'Return' : 'WriteOff';
24 $company_data = get_company_prefs();
25 $branch_data = get_branch_accounts($credit_note->Branch);
27 $credit_note_total = $credit_note->get_items_total_dispatch();
28 $freight_tax = $credit_note->get_shipping_tax();
30 $taxes = $credit_note->get_taxes();
33 foreach ($taxes as $taxitem) {
34 $tax_total += $taxitem['Value'];
37 if ($credit_note->tax_included == 0) {
38 $items_added_tax = $tax_total-$freight_tax;
39 $freight_added_tax = $freight_tax;
42 $freight_added_tax = 0;
44 // 2006-06-14. If the Customer Branch AR Account is set to a Bank Account,
45 // the transaction will be settled at once.
46 if (is_bank_account($branch_data['receivables_account']))
47 $alloc = $credit_note_total + $items_added_tax + $credit_note->freight_cost + $freight_added_tax;
51 // $sales_order=$invoice->order_no; //?
52 // if (is_array($sales_order)) $sales_order = $sales_order[0]; //?
53 if (!isset($credit_note->order_no))
54 $credit_note->order_no = 0;
56 /*Now insert the Credit Note into the debtor_trans table with the allocations as calculated above*/
57 // all amounts in debtor's currency
58 $credit_no = write_customer_trans(11, $trans_no, $credit_note->customer_id,
59 $credit_note->Branch, $credit_date, $credit_note->reference,
60 $credit_note_total, 0, $items_added_tax,
61 $credit_note->freight_cost, $freight_added_tax,
62 $credit_note->sales_type,
63 $credit_note->order_no, $credit_invoice, $credit_note->ship_via,
64 null, $alloc); // 2008-06-14 extra $alloc
67 $credit_note->trans_no = array($credit_no=>0);
68 set_document_parent($credit_note);
70 delete_comments(11, $credit_no);
71 void_cust_allocations(11, $credit_no, $credit_date);
72 void_gl_trans(11, $credit_no, true);
73 void_stock_move(11, $credit_no);
74 void_customer_trans_tax_details(11, $credit_no);
77 if ($credit_invoice) {
78 $invoice_alloc_balance = get_DebtorTrans_allocation_balance(10, $credit_invoice);
79 update_customer_trans_version(get_parent_type(11), $credit_note->src_docs );
80 if ($invoice_alloc_balance > 0) { /*the invoice is not already fully allocated */
81 $total = $credit_note_total + $credit_note->freight_cost +
82 $items_added_tax + $freight_added_tax;
84 $allocate_amount = ($invoice_alloc_balance > $total) ? $total : $invoice_alloc_balance;
85 /*Now insert the allocation record if > 0 */
86 if ($allocate_amount != 0) {
87 update_debtor_trans_allocation(10, $credit_invoice, $allocate_amount);
88 update_debtor_trans_allocation(11, $credit_no, $allocate_amount); // ***
89 add_cust_allocation($allocate_amount, 11, $credit_no, 10, $credit_invoice);
90 // Exchange Variations Joe Hunt 2008-09-20 ////////////////////////////////////////
92 exchange_variation(11, $credit_no, 10, $credit_invoice, $credit_date,
93 $allocate_amount, payment_person_types::customer());
95 ///////////////////////////////////////////////////////////////////////////
101 foreach ($credit_note->line_items as $credit_line) {
103 if ($credit_invoice && $credit_line->qty_dispatched!=$credit_line->qty_old ) {
104 update_parent_line(11, $credit_line->id,($credit_line->qty_dispatched
105 -$credit_line->qty_old));
108 $line_taxfree_price = get_tax_free_price_for_item($credit_line->stock_id, $credit_line->price,
109 0, $credit_note->tax_included, $credit_note->tax_group_array);
111 $line_tax = get_full_price_for_item($credit_line->stock_id, $credit_line->price,
112 0, $credit_note->tax_included, $credit_note->tax_group_array) - $line_taxfree_price;
114 write_customer_trans_detail_item(11, $credit_no, $credit_line->stock_id,
115 $credit_line->item_description, $credit_line->qty_dispatched,
116 $credit_line->line_price(), $line_tax, $credit_line->discount_percent,
117 $credit_line->standard_cost, $trans_no==0 ? 0: $credit_line->id);
119 add_credit_movements_item($credit_note, $credit_line,
120 $credit_type, $line_taxfree_price+$line_tax, $credit_invoice);
122 add_gl_trans_credit_costs($credit_note, $credit_line, $credit_no,
123 $credit_date, $credit_type, $write_off_acc, $branch_data);
124 } /*end of credit_line loop */
126 /*Post credit note transaction to GL credit debtors,
127 debit freight re-charged and debit sales */
129 if (($credit_note_total + $credit_note->freight_cost) != 0) {
131 add_gl_trans_customer(11, $credit_no, $credit_date, $branch_data["receivables_account"], 0, 0,
132 -($credit_note_total + $credit_note->freight_cost + $items_added_tax + $freight_added_tax),
133 $credit_note->customer_id,
134 "The total debtor GL posting for the credit note could not be inserted");
137 if ($credit_note->freight_cost !=0) {
138 add_gl_trans_customer(11, $credit_no, $credit_date, $company_data["freight_act"], 0, 0,
139 $credit_note->get_tax_free_shipping(), $credit_note->customer_id,
140 "The freight GL posting for this credit note could not be inserted");
143 foreach ($taxes as $taxitem) {
144 if ($taxitem['Value'] != 0) {
146 add_customer_trans_tax_detail_item(11, $credit_no, $taxitem['tax_type_id'],
147 $taxitem['rate'], $credit_note->tax_included, $taxitem['Value']);
149 add_gl_trans_customer(11, $credit_no, $credit_date, $taxitem['sales_gl_code'], 0, 0,
150 $taxitem['Value'], $credit_note->customer_id,
151 "A tax GL posting for this credit note could not be inserted");
155 add_comments(11, $credit_no, $credit_date, $credit_note->Comments);
157 if ($trans_no == 0) {
158 references::save_last($credit_note->reference, 11);
161 commit_transaction();
166 //----------------------------------------------------------------------------------------
167 // Insert a stock movement coming back in to show the credit note and
168 // a reversing stock movement to show the write off
170 function add_credit_movements_item(&$credit_note, &$credit_line,
171 $credit_type, $price, $credited_invoice=0)
174 if ($credit_type == "Return") {
176 $reference = "Return ";
177 if ($credited_invoice) {
178 $reference .= "Ex Inv: " . $credited_invoice;
181 } elseif ($credit_type == "WriteOff") {
183 $reference = "WriteOff ";
184 if ($credited_invoice)
185 $reference .= "Ex Inv: " . $credited_invoice;
187 add_stock_move_customer(11, $credit_line->stock_id,
188 key($credit_note->trans_no), $credit_note->Location,
189 $credit_note->document_date, $reference, -$credit_line->qty_dispatched,
190 $credit_line->standard_cost, 0, $price,
191 $credit_line->discount_percent);
194 add_stock_move_customer(11, $credit_line->stock_id,
195 key($credit_note->trans_no), $credit_note->Location,
196 $credit_note->document_date, $reference, $credit_line->qty_dispatched,
197 $credit_line->standard_cost, 0, $price,
198 $credit_line->discount_percent);
202 //----------------------------------------------------------------------------------------
204 function add_gl_trans_credit_costs($order, $order_line, $credit_no, $date_,
205 $credit_type, $write_off_gl_code, &$branch_data)
207 $stock_gl_codes = get_stock_gl_code($order_line->stock_id);
208 $customer = get_customer($order->customer_id);
209 // 2008-08-01. If there is a Customer Dimension, then override with this,
210 // else take the Item Dimension (if any)
211 $dim = ($customer['dimension_id'] != 0 ? $customer["dimension_id"] : $stock_gl_codes["dimension_id"]);
212 $dim2 = ($customer['dimension2_id'] != 0 ? $customer["dimension2_id"] : $stock_gl_codes["dimension2_id"]);
214 /* insert gl_trans to credit stock and debit cost of sales at standard cost*/
215 $standard_cost = get_standard_cost($order_line->stock_id);
216 if ($standard_cost != 0) {
217 /*first the cost of sales entry*/
219 add_gl_trans_std_cost(11, $credit_no, $date_, $stock_gl_codes["cogs_account"],
220 $dim, $dim2, "", -($standard_cost * $order_line->qty_dispatched),
221 payment_person_types::customer(), $order->customer_id,
222 "The cost of sales GL posting could not be inserted");
224 /*now the stock entry*/
225 if ($credit_type == "WriteOff") {
226 $stock_entry_account = $write_off_gl_code;
228 $stock_gl_code = get_stock_gl_code($order_line->stock_id);
229 $stock_entry_account = $stock_gl_code["inventory_account"];
232 add_gl_trans_std_cost(11, $credit_no, $date_, $stock_entry_account, 0, 0,
233 "", ($standard_cost * $order_line->qty_dispatched),
234 payment_person_types::customer(), $order->customer_id,
235 "The stock side (or write off) of the cost of sales GL posting could not be inserted");
237 } /* end of if GL and stock integrated and standard cost !=0 */
239 if ($order_line->line_price() != 0) {
241 $line_taxfree_price =
242 get_tax_free_price_for_item($order_line->stock_id, $order_line->price,
243 0, $order->tax_included, $order->tax_group_array);
245 $line_tax = get_full_price_for_item($order_line->stock_id, $order_line->price,
246 0, $order->tax_included, $order->tax_group_array) - $line_taxfree_price;
249 //Post sales transaction to GL credit sales
251 // 2008-06-14. If there is a Branch Sales Account, then override with this,
252 // else take the Item Sales Account
253 if ($branch_data['sales_account'] != "")
254 $sales_account = $branch_data['sales_account'];
256 $sales_account = $stock_gl_codes['sales_account'];
257 add_gl_trans_customer(11, $credit_no, $date_, $sales_account, $dim, $dim2,
258 ($line_taxfree_price * $order_line->qty_dispatched), $order->customer_id,
259 "The credit note GL posting could not be inserted");
261 if ($order_line->discount_percent != 0) {
263 add_gl_trans_customer(11, $credit_no, $date_, $branch_data["sales_discount_account"],
264 $dim, $dim2, -($line_taxfree_price * $order_line->qty_dispatched * $order_line->discount_percent),
266 "The credit note discount GL posting could not be inserted");
268 } /*end of if discount !=0 */
269 } /*if line_price!=0 */