References saved in refs table for all documents for easy access.
[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)
17 {
18         begin_transaction();
19
20         $company_record = get_company_prefs();
21
22         $payment_no = write_customer_trans(12, $trans_no, $customer_id, $branch_id, 
23                 $date_, $ref, $amount, $discount, 0, 0, 0, 0, 0, 0, 0, "", 0, $rate);
24
25         $bank_gl_account = get_bank_gl_account($bank_account);
26
27         if ($trans_no != 0) {
28           delete_comments(12, $trans_no);
29           void_bank_trans(12, $trans_no, true);
30           void_gl_trans(12, $trans_no, true);
31           void_cust_allocations(12, $trans_no, $date_);
32         }
33         $total = 0;
34         /* Bank account entry first */
35         $total += add_gl_trans_customer(12, $payment_no, $date_,
36                 $bank_gl_account, 0, 0, $amount,  $customer_id,
37                 "Cannot insert a GL transaction for the bank account debit", $rate);
38
39         if ($branch_id != reserved_words::get_any_numeric()) {
40
41                 $branch_data = get_branch_accounts($branch_id);
42
43                 $debtors_account = $branch_data["receivables_account"];
44                 $discount_account = $branch_data["payment_discount_account"];
45
46         } else {
47                 $debtors_account = $company_record["debtors_act"];
48                 $discount_account = $company_record["default_prompt_payment_act"];
49         }
50
51         if (($discount + $amount) != 0) {
52         /* Now Credit Debtors account with receipts + discounts */
53         $total += add_gl_trans_customer(12, $payment_no, $date_,
54                 $debtors_account, 0, 0, -($discount + $amount), $customer_id,
55                 "Cannot insert a GL transaction for the debtors account credit", $rate);
56         }
57         if ($discount != 0)     {
58                 /* Now Debit discount account with discounts allowed*/
59                 $total += add_gl_trans_customer(12, $payment_no, $date_,
60                         $discount_account, 0, 0, $discount, $customer_id,
61                         "Cannot insert a GL transaction for the payment discount debit", $rate);
62         }
63
64         /*Post a balance post if $total != 0 */
65         add_gl_balance(12, $payment_no, $date_, -$total, payment_person_types::customer(), $customer_id);       
66
67         /*now enter the bank_trans entry */
68         add_bank_trans(12, $payment_no, $bank_account, $ref,
69                 $date_, $amount, payment_person_types::customer(), $customer_id,
70                 get_customer_currency($customer_id));
71
72         add_comments(12, $payment_no, $date_, $memo_);
73
74         references::save(12, $payment_no, $ref);
75
76         commit_transaction();
77
78         return $payment_no;
79 }
80
81 //-------------------------------------------------------------------------------------------------
82
83 function void_customer_payment($type, $type_no)
84 {
85         begin_transaction();
86
87         void_bank_trans($type, $type_no, true);
88         void_gl_trans($type, $type_no, true);
89         void_cust_allocations($type, $type_no);
90         void_customer_trans($type, $type_no);
91
92         commit_transaction();
93 }
94
95
96 ?>