brotherton-erpnext/erpnext/accounts/report/accounts_receivable/accounts_receivable.py

193 lines
6.8 KiB
Python
Raw Normal View History

# Copyright (c) 2013, Web Notes Technologies Pvt. Ltd.
# License: GNU General Public License v3. See license.txt
from __future__ import unicode_literals
2014-02-14 10:17:51 +00:00
import frappe
from frappe import _
from frappe.utils import getdate, nowdate, flt
2013-11-07 15:14:30 +00:00
class AccountsReceivableReport(object):
def __init__(self, filters=None):
2014-02-14 10:17:51 +00:00
self.filters = frappe._dict(filters or {})
2013-11-07 15:14:30 +00:00
self.filters.report_date = getdate(self.filters.report_date or nowdate())
self.age_as_on = getdate(nowdate()) \
if self.filters.report_date > getdate(nowdate()) \
else self.filters.report_date
def run(self):
2014-02-26 07:05:33 +00:00
customer_naming_by = frappe.db.get_value("Selling Settings", None, "cust_master_name")
2014-01-03 07:51:38 +00:00
return self.get_columns(customer_naming_by), self.get_data(customer_naming_by)
2014-01-03 07:51:38 +00:00
def get_columns(self, customer_naming_by):
columns = [
2014-09-11 08:15:27 +00:00
_("Posting Date") + ":Date:80", _("Account") + ":Link/Account:150",
_("Voucher Type") + "::110", _("Voucher No") + "::120", "::30",
_("Due Date") + ":Date:80",
_("Invoiced Amount") + ":Currency:100", _("Payment Received") + ":Currency:100",
_("Outstanding Amount") + ":Currency:100", _("Age") + ":Int:50", "0-30:Currency:100",
"30-60:Currency:100", "60-90:Currency:100", _("90-Above") + ":Currency:100",
_("Customer") + ":Link/Customer:200"
2013-11-07 15:14:30 +00:00
]
2014-01-03 07:28:04 +00:00
2014-01-03 07:51:38 +00:00
if customer_naming_by == "Naming Series":
columns += ["Customer Name::110"]
2014-01-03 07:51:38 +00:00
columns += ["Territory:Link/Territory:80", "Remarks::200"]
return columns
2014-01-03 07:51:38 +00:00
def get_data(self, customer_naming_by):
from erpnext.accounts.utils import get_currency_precision
currency_precision = get_currency_precision() or 2
2013-11-07 15:14:30 +00:00
data = []
future_vouchers = self.get_entries_after(self.filters.report_date)
for gle in self.get_entries_till(self.filters.report_date):
if self.is_receivable(gle, future_vouchers):
outstanding_amount = self.get_outstanding_amount(gle, self.filters.report_date)
if abs(outstanding_amount) > 0.1/10**currency_precision:
2013-11-07 15:14:30 +00:00
due_date = self.get_due_date(gle)
invoiced_amount = gle.debit if (gle.debit > 0) else 0
payment_received = invoiced_amount - outstanding_amount
row = [gle.posting_date, gle.account,
gle.voucher_type, gle.voucher_no, due_date,
invoiced_amount, payment_received,
2013-11-07 15:14:30 +00:00
outstanding_amount]
entry_date = due_date if self.filters.ageing_based_on == "Due Date" \
2013-11-07 15:14:30 +00:00
else gle.posting_date
2014-01-03 07:51:38 +00:00
row += get_ageing_data(self.age_as_on, entry_date, outstanding_amount) + \
[self.get_customer(gle.account)]
2014-01-03 07:51:38 +00:00
if customer_naming_by == "Naming Series":
row += [self.get_customer_name(gle.account)]
2014-01-03 07:51:38 +00:00
row += [self.get_territory(gle.account), gle.remarks]
2013-11-07 15:14:30 +00:00
data.append(row)
2014-01-03 07:51:38 +00:00
for i in range(0, len(data)):
data[i].insert(4, """<a href="%s"><i class="icon icon-share" style="cursor: pointer;"></i></a>""" \
% ("/".join(["#Form", data[i][2], data[i][3]]),))
2013-11-07 15:14:30 +00:00
return data
2013-11-07 15:14:30 +00:00
def get_entries_after(self, report_date):
# returns a distinct list
return list(set([(e.voucher_type, e.voucher_no) for e in self.get_gl_entries()
if getdate(e.posting_date) > report_date]))
def get_entries_till(self, report_date):
# returns a generator
return (e for e in self.get_gl_entries()
if getdate(e.posting_date) <= report_date)
def is_receivable(self, gle, future_vouchers):
return (
# advance
(not gle.against_voucher) or
# sales invoice
(gle.against_voucher==gle.voucher_no and gle.debit > 0) or
# entries adjusted with future vouchers
((gle.against_voucher_type, gle.against_voucher) in future_vouchers)
)
2013-11-07 15:14:30 +00:00
def get_outstanding_amount(self, gle, report_date):
payment_received = 0.0
for e in self.get_gl_entries_for(gle.account, gle.voucher_type, gle.voucher_no):
if getdate(e.posting_date) <= report_date and e.name!=gle.name:
payment_received += (flt(e.credit) - flt(e.debit))
2013-11-07 15:14:30 +00:00
return flt(gle.debit) - flt(gle.credit) - payment_received
2013-11-07 15:14:30 +00:00
def get_customer(self, account):
return self.get_account_map().get(account, {}).get("customer") or ""
def get_customer_name(self, account):
return self.get_account_map().get(account, {}).get("customer_name") or ""
2013-11-07 15:14:30 +00:00
def get_territory(self, account):
return self.get_account_map().get(account, {}).get("territory") or ""
2013-11-07 15:14:30 +00:00
def get_account_map(self):
if not hasattr(self, "account_map"):
2014-02-26 07:05:33 +00:00
self.account_map = dict(((r.name, r) for r in frappe.db.sql("""select
acc.name, cust.name as customer, cust.customer_name, cust.territory
2014-02-05 12:45:12 +00:00
from `tabAccount` acc left join `tabCustomer` cust
on cust.name=acc.master_name where acc.master_type="Customer" """, as_dict=True)))
2013-11-07 15:14:30 +00:00
return self.account_map
2013-11-07 15:14:30 +00:00
def get_due_date(self, gle):
if not hasattr(self, "invoice_due_date_map"):
# TODO can be restricted to posting date
2014-02-26 07:05:33 +00:00
self.invoice_due_date_map = dict(frappe.db.sql("""select name, due_date
2013-11-07 15:14:30 +00:00
from `tabSales Invoice` where docstatus=1"""))
return gle.voucher_type == "Sales Invoice" \
and self.invoice_due_date_map.get(gle.voucher_no) or ""
2013-11-07 15:14:30 +00:00
def get_gl_entries(self):
if not hasattr(self, "gl_entries"):
conditions, values = self.prepare_conditions()
2014-02-26 07:05:33 +00:00
self.gl_entries = frappe.db.sql("""select * from `tabGL Entry`
where docstatus < 2 {0} order by posting_date, account""".format(conditions),
2013-11-07 15:14:30 +00:00
values, as_dict=True)
return self.gl_entries
def prepare_conditions(self):
conditions = [""]
values = {}
if self.filters.company:
conditions.append("company=%(company)s")
values["company"] = self.filters.company
if self.filters.account:
conditions.append("account=%(account)s")
values["account"] = self.filters.account
else:
account_map = self.get_account_map()
if not account_map:
2014-02-14 10:17:51 +00:00
frappe.throw(_("No Customer Accounts found."))
2013-11-07 15:14:30 +00:00
else:
accounts_list = ['"{0}"'.format(ac) for ac in account_map]
conditions.append("account in ({0})".format(", ".join(accounts_list)))
2013-11-07 15:14:30 +00:00
return " and ".join(conditions), values
def get_gl_entries_for(self, account, against_voucher_type, against_voucher):
if not hasattr(self, "gl_entries_map"):
self.gl_entries_map = {}
for gle in self.get_gl_entries():
if gle.against_voucher_type and gle.against_voucher:
self.gl_entries_map.setdefault(gle.account, {})\
.setdefault(gle.against_voucher_type, {})\
.setdefault(gle.against_voucher, [])\
.append(gle)
2013-11-07 15:14:30 +00:00
return self.gl_entries_map.get(account, {})\
.get(against_voucher_type, {})\
.get(against_voucher, [])
def execute(filters=None):
2013-11-07 15:34:01 +00:00
return AccountsReceivableReport(filters).run()
2014-01-03 07:51:38 +00:00
def get_ageing_data(age_as_on, entry_date, outstanding_amount):
2013-11-07 15:34:01 +00:00
# [0-30, 30-60, 60-90, 90-above]
outstanding_range = [0.0, 0.0, 0.0, 0.0]
2013-11-07 15:39:06 +00:00
if not (age_as_on and entry_date):
2013-11-07 15:34:01 +00:00
return [0] + outstanding_range
age = (getdate(age_as_on) - getdate(entry_date)).days or 0
2013-11-07 15:34:01 +00:00
index = None
for i, days in enumerate([30, 60, 90]):
if age <= days:
index = i
break
if index is None: index = 3
outstanding_range[index] = outstanding_amount
2013-11-07 15:34:01 +00:00
return [age] + outstanding_range