Stable merged into unstable again (due to failure on binary file during previous...
[fa-stable.git] / sales / includes / db / payment_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   Write/update customer payment.
14 */
15 function write_customer_payment($trans_no, $customer_id, $branch_id, $bank_account,
16         $date_, $ref, $amount, $discount, $memo_, $rate=0, $charge=0)
17 {
18         global $Refs;
19
20         begin_transaction();
21         $args = func_get_args(); while (count($args) < 11) $args[] = 0;
22         $args = (object)array_combine(array('trans_no', 'customer_id', 'branch_id', 'bank_account', 
23                 'date_', 'ref', 'amount', 'discount', 'memo_','rate','charge'), $args);
24         hook_db_prewrite($args, ST_CUSTPAYMENT);
25
26         $company_record = get_company_prefs();
27         
28         //Chaitanya : 13_OCT_2011 : Voiding Tasks first
29         //Reason : After modifying the customer trans, it was getting voided later
30         if ($trans_no != 0) {
31           delete_comments(ST_CUSTPAYMENT, $trans_no);
32           void_bank_trans(ST_CUSTPAYMENT, $trans_no, true);
33           void_gl_trans(ST_CUSTPAYMENT, $trans_no, true);
34           void_cust_allocations(ST_CUSTPAYMENT, $trans_no, $date_);
35         }
36
37         $payment_no = write_customer_trans(ST_CUSTPAYMENT, $trans_no, $customer_id, $branch_id, 
38                 $date_, $ref, $amount, $discount, 0, 0, 0, 0, 0, 0, "", 0, $rate);
39    
40         $bank_gl_account = get_bank_gl_account($bank_account);
41
42         $total = 0;
43         /* Bank account entry first */
44         $total += add_gl_trans_customer(ST_CUSTPAYMENT, $payment_no, $date_,
45                 $bank_gl_account, 0, 0, $amount - $charge,  $customer_id,
46                 "Cannot insert a GL transaction for the bank account debit", $rate);
47
48         if ($branch_id != ANY_NUMERIC) {
49
50                 $branch_data = get_branch_accounts($branch_id);
51
52                 $debtors_account = $branch_data["receivables_account"];
53                 $discount_account = $branch_data["payment_discount_account"];
54
55         } else {
56                 $debtors_account = $company_record["debtors_act"];
57                 $discount_account = $company_record["default_prompt_payment_act"];
58         }
59
60         if (($discount + $amount) != 0) {
61         /* Now Credit Debtors account with receipts + discounts */
62         $total += add_gl_trans_customer(ST_CUSTPAYMENT, $payment_no, $date_,
63                 $debtors_account, 0, 0, -($discount + $amount), $customer_id,
64                 "Cannot insert a GL transaction for the debtors account credit", $rate);
65         }
66         if ($discount != 0)     {
67                 /* Now Debit discount account with discounts allowed*/
68                 $total += add_gl_trans_customer(ST_CUSTPAYMENT, $payment_no, $date_,
69                         $discount_account, 0, 0, $discount, $customer_id,
70                         "Cannot insert a GL transaction for the payment discount debit", $rate);
71         }
72
73         if ($charge != 0)       {
74                 /* Now Debit bank charge account with charges */
75                 $charge_act = get_company_pref('bank_charge_act');
76                 $total += add_gl_trans_customer(ST_CUSTPAYMENT, $payment_no, $date_,
77                         $charge_act, 0, 0, $charge, $customer_id,
78                         "Cannot insert a GL transaction for the payment bank charge debit", $rate);
79         }
80         /*Post a balance post if $total != 0 */
81         add_gl_balance(ST_CUSTPAYMENT, $payment_no, $date_, -$total, PT_CUSTOMER, $customer_id);        
82
83         /*now enter the bank_trans entry */
84         add_bank_trans(ST_CUSTPAYMENT, $payment_no, $bank_account, $ref,
85                 $date_, $amount - $charge, PT_CUSTOMER, $customer_id,
86                 get_customer_currency($customer_id), "", $rate);
87
88         add_comments(ST_CUSTPAYMENT, $payment_no, $date_, $memo_);
89
90         $Refs->save(ST_CUSTPAYMENT, $payment_no, $ref);
91
92         $args->trans_no = $payment_no;
93         hook_db_postwrite($args, ST_CUSTPAYMENT);
94         commit_transaction();
95
96         return $payment_no;
97 }
98
99 //-------------------------------------------------------------------------------------------------
100
101 function void_customer_payment($type, $type_no)
102 {
103         begin_transaction();
104
105         hook_db_prevoid($type, $type_no);
106         void_bank_trans($type, $type_no, true);
107         void_gl_trans($type, $type_no, true);
108         void_cust_allocations($type, $type_no);
109         void_customer_trans($type, $type_no);
110
111         commit_transaction();
112 }
113
114
115 ?>