c89782502c
* Add new Select to filters * get the currencies from database rather than hardcoded * label report columns: - If presentation currency is available in filters, use it or - If company is available in filters, use it or - use default company currency * add new function - get_currency * tweak new function `get_currency` * add new function `convert` to convert a value to another currency * add new function `convert_to_presentation_currency` * clean up `get_currency` first pass * memoise the exchange rates * limit fetched GL entries to to_date * check if account type is p&l or not and use appropriate exchange rate based on that * change EXCHANGE RATE to a dict, use for memoisation * rename EXCHANGE_RATE * cache exchange rates and use them as needed * add docstrings * add presentation currency logic to financial statement reports * move new functions from `general_ledger.py` to new module * clean up * PEP 8 clean up * move function to util.py * PEP 8 clean up * remove presentation currency option from cashflow * adjust currency as needed * allow users to save presentation currency in Accounts Settings * add new function `get_presentation_currency_list` * refactor query_report modules with no promises * Revert "allow users to save presentation currency in Accounts Settings" This reverts commit 3b58a6296cf3f7b4d80ac55b03f9d5d4887b796b. * show print page in correct currency * Update utils.py
411 lines
11 KiB
Python
411 lines
11 KiB
Python
# Copyright (c) 2015, Frappe Technologies Pvt. Ltd. and Contributors
|
|
# License: GNU General Public License v3. See license.txt
|
|
|
|
from __future__ import unicode_literals
|
|
import frappe
|
|
from erpnext import get_company_currency, get_default_company
|
|
from erpnext.accounts.report.utils import get_currency, convert_to_presentation_currency
|
|
from frappe.utils import getdate, cstr, flt, fmt_money
|
|
from frappe import _, _dict
|
|
from erpnext.accounts.utils import get_account_currency
|
|
|
|
|
|
def execute(filters=None):
|
|
account_details = {}
|
|
|
|
if filters and filters.get('print_in_account_currency') and \
|
|
not filters.get('account'):
|
|
frappe.throw(_("Select an account to print in account currency"))
|
|
|
|
for acc in frappe.db.sql("""select name, is_group from tabAccount""", as_dict=1):
|
|
account_details.setdefault(acc.name, acc)
|
|
|
|
validate_filters(filters, account_details)
|
|
|
|
validate_party(filters)
|
|
|
|
filters = set_account_currency(filters)
|
|
|
|
columns = get_columns(filters)
|
|
|
|
res = get_result(filters, account_details)
|
|
|
|
return columns, res
|
|
|
|
|
|
def validate_filters(filters, account_details):
|
|
if not filters.get('company'):
|
|
frappe.throw(_('{0} is mandatory').format(_('Company')))
|
|
|
|
if filters.get("account") and not account_details.get(filters.account):
|
|
frappe.throw(_("Account {0} does not exists").format(filters.account))
|
|
|
|
if filters.get("account") and filters.get("group_by_account") \
|
|
and account_details[filters.account].is_group == 0:
|
|
frappe.throw(_("Can not filter based on Account, if grouped by Account"))
|
|
|
|
if filters.get("voucher_no") and filters.get("group_by_voucher"):
|
|
frappe.throw(_("Can not filter based on Voucher No, if grouped by Voucher"))
|
|
|
|
if filters.from_date > filters.to_date:
|
|
frappe.throw(_("From Date must be before To Date"))
|
|
|
|
|
|
def validate_party(filters):
|
|
party_type, party = filters.get("party_type"), filters.get("party")
|
|
|
|
if party:
|
|
if not party_type:
|
|
frappe.throw(_("To filter based on Party, select Party Type first"))
|
|
elif not frappe.db.exists(party_type, party):
|
|
frappe.throw(_("Invalid {0}: {1}").format(party_type, party))
|
|
|
|
|
|
def set_account_currency(filters):
|
|
if not (filters.get("account") or filters.get("party")):
|
|
return filters
|
|
else:
|
|
filters["company_currency"] = frappe.db.get_value("Company", filters.company, "default_currency")
|
|
account_currency = None
|
|
|
|
if filters.get("account"):
|
|
account_currency = get_account_currency(filters.account)
|
|
elif filters.get("party"):
|
|
gle_currency = frappe.db.get_value(
|
|
"GL Entry", {
|
|
"party_type": filters.party_type, "party": filters.party, "company": filters.company
|
|
},
|
|
"account_currency"
|
|
)
|
|
|
|
if gle_currency:
|
|
account_currency = gle_currency
|
|
else:
|
|
account_currency = None if filters.party_type == "Employee" else \
|
|
frappe.db.get_value(filters.party_type, filters.party, "default_currency")
|
|
|
|
filters["account_currency"] = account_currency or filters.company_currency
|
|
|
|
if filters.account_currency != filters.company_currency:
|
|
filters["show_in_account_currency"] = 1
|
|
|
|
return filters
|
|
|
|
def get_result(filters, account_details):
|
|
gl_entries = get_gl_entries(filters)
|
|
|
|
data = get_data_with_opening_closing(filters, account_details, gl_entries)
|
|
|
|
result = get_result_as_list(data, filters)
|
|
|
|
return result
|
|
|
|
|
|
def get_gl_entries(filters):
|
|
currency_map = get_currency(filters)
|
|
select_fields = """, sum(debit_in_account_currency) as debit_in_account_currency,
|
|
sum(credit_in_account_currency) as credit_in_account_currency""" \
|
|
|
|
|
|
group_by_condition = "group by voucher_type, voucher_no, account, cost_center" \
|
|
if filters.get("group_by_voucher") else "group by name"
|
|
|
|
gl_entries = frappe.db.sql(
|
|
"""
|
|
select
|
|
posting_date, account, party_type, party,
|
|
sum(debit) as debit, sum(credit) as credit,
|
|
voucher_type, voucher_no, cost_center, project,
|
|
against_voucher_type, against_voucher, account_currency,
|
|
remarks, against, is_opening {select_fields}
|
|
from `tabGL Entry`
|
|
where company=%(company)s {conditions}
|
|
{group_by_condition}
|
|
order by posting_date, account
|
|
""".format(
|
|
select_fields=select_fields, conditions=get_conditions(filters),
|
|
group_by_condition=group_by_condition
|
|
),
|
|
filters, as_dict=1)
|
|
|
|
if filters.get('presentation_currency'):
|
|
return convert_to_presentation_currency(gl_entries, currency_map)
|
|
else:
|
|
return gl_entries
|
|
|
|
|
|
def get_conditions(filters):
|
|
conditions = []
|
|
if filters.get("account"):
|
|
lft, rgt = frappe.db.get_value("Account", filters["account"], ["lft", "rgt"])
|
|
conditions.append("""account in (select name from tabAccount
|
|
where lft>=%s and rgt<=%s and docstatus<2)""" % (lft, rgt))
|
|
|
|
if filters.get("voucher_no"):
|
|
conditions.append("voucher_no=%(voucher_no)s")
|
|
|
|
if filters.get("party_type"):
|
|
conditions.append("party_type=%(party_type)s")
|
|
|
|
if filters.get("party"):
|
|
conditions.append("party=%(party)s")
|
|
|
|
if not (filters.get("account") or filters.get("party") or filters.get("group_by_account")):
|
|
conditions.append("posting_date >=%(from_date)s")
|
|
conditions.append("posting_date <=%(to_date)s")
|
|
|
|
if filters.get("project"):
|
|
conditions.append("project=%(project)s")
|
|
|
|
from frappe.desk.reportview import build_match_conditions
|
|
match_conditions = build_match_conditions("GL Entry")
|
|
|
|
if match_conditions:
|
|
conditions.append(match_conditions)
|
|
|
|
return "and {}".format(" and ".join(conditions)) if conditions else ""
|
|
|
|
|
|
def get_data_with_opening_closing(filters, account_details, gl_entries):
|
|
data = []
|
|
gle_map = initialize_gle_map(gl_entries)
|
|
|
|
totals, entries = get_accountwise_gle(filters, gl_entries, gle_map)
|
|
|
|
# Opening for filtered account
|
|
data.append(totals.opening)
|
|
|
|
if filters.get("group_by_account"):
|
|
for acc, acc_dict in gle_map.items():
|
|
if acc_dict.entries:
|
|
# opening
|
|
data.append({})
|
|
data.append(acc_dict.totals.opening)
|
|
|
|
data += acc_dict.entries
|
|
|
|
# totals
|
|
data.append(acc_dict.totals.total)
|
|
|
|
# closing
|
|
data.append(acc_dict.totals.closing)
|
|
data.append({})
|
|
|
|
else:
|
|
data += entries
|
|
|
|
# totals
|
|
data.append(totals.total)
|
|
|
|
# closing
|
|
data.append(totals.closing)
|
|
|
|
return data
|
|
|
|
|
|
def get_totals_dict():
|
|
def _get_debit_credit_dict(label):
|
|
return _dict(
|
|
account="'{0}'".format(label),
|
|
debit=0.0,
|
|
credit=0.0,
|
|
debit_in_account_currency=0.0,
|
|
credit_in_account_currency=0.0
|
|
)
|
|
return _dict(
|
|
opening = _get_debit_credit_dict(_('Opening')),
|
|
total = _get_debit_credit_dict(_('Total')),
|
|
closing = _get_debit_credit_dict(_('Closing (Opening + Total)'))
|
|
)
|
|
|
|
|
|
def initialize_gle_map(gl_entries):
|
|
gle_map = frappe._dict()
|
|
for gle in gl_entries:
|
|
gle_map.setdefault(gle.account, _dict(totals=get_totals_dict(), entries=[]))
|
|
return gle_map
|
|
|
|
|
|
def get_accountwise_gle(filters, gl_entries, gle_map):
|
|
totals = get_totals_dict()
|
|
entries = []
|
|
|
|
def update_value_in_dict(data, key, gle):
|
|
data[key].debit += flt(gle.debit)
|
|
data[key].credit += flt(gle.credit)
|
|
|
|
data[key].debit_in_account_currency += flt(gle.debit_in_account_currency)
|
|
data[key].credit_in_account_currency += flt(gle.credit_in_account_currency)
|
|
|
|
from_date, to_date = getdate(filters.from_date), getdate(filters.to_date)
|
|
for gle in gl_entries:
|
|
if gle.posting_date < from_date or cstr(gle.is_opening) == "Yes":
|
|
update_value_in_dict(gle_map[gle.account].totals, 'opening', gle)
|
|
update_value_in_dict(totals, 'opening', gle)
|
|
|
|
update_value_in_dict(gle_map[gle.account].totals, 'closing', gle)
|
|
update_value_in_dict(totals, 'closing', gle)
|
|
|
|
elif gle.posting_date <= to_date:
|
|
update_value_in_dict(gle_map[gle.account].totals, 'total', gle)
|
|
update_value_in_dict(totals, 'total', gle)
|
|
if filters.get("group_by_account"):
|
|
gle_map[gle.account].entries.append(gle)
|
|
else:
|
|
entries.append(gle)
|
|
|
|
update_value_in_dict(gle_map[gle.account].totals, 'closing', gle)
|
|
update_value_in_dict(totals, 'closing', gle)
|
|
|
|
return totals, entries
|
|
|
|
|
|
def get_result_as_list(data, filters):
|
|
balance, balance_in_account_currency = 0, 0
|
|
inv_details = get_supplier_invoice_details()
|
|
|
|
for d in data:
|
|
if not d.get('posting_date'):
|
|
balance, balance_in_account_currency = 0, 0
|
|
|
|
balance = get_balance(d, balance, 'debit', 'credit')
|
|
d['balance'] = balance
|
|
|
|
if filters.get("show_in_account_currency"):
|
|
balance_in_account_currency = get_balance(d, balance_in_account_currency,
|
|
'debit_in_account_currency', 'credit_in_account_currency')
|
|
d['balance_in_account_currency'] = balance_in_account_currency
|
|
else:
|
|
d['debit_in_account_currency'] = d.get('debit', 0)
|
|
d['credit_in_account_currency'] = d.get('credit', 0)
|
|
d['balance_in_account_currency'] = d.get('balance')
|
|
|
|
d['account_currency'] = filters.account_currency
|
|
d['bill_no'] = inv_details.get(d.get('against_voucher'), '')
|
|
|
|
return data
|
|
|
|
def get_supplier_invoice_details():
|
|
inv_details = {}
|
|
for d in frappe.db.sql(""" select name, bill_no from `tabPurchase Invoice`
|
|
where docstatus = 1 and bill_no is not null and bill_no != '' """, as_dict=1):
|
|
inv_details[d.name] = d.bill_no
|
|
|
|
return inv_details
|
|
|
|
def get_balance(row, balance, debit_field, credit_field):
|
|
balance += (row.get(debit_field, 0) - row.get(credit_field, 0))
|
|
|
|
return balance
|
|
|
|
def get_columns(filters):
|
|
if filters.get("presentation_currency"):
|
|
currency = filters["presentation_currency"]
|
|
else:
|
|
if filters.get("company"):
|
|
currency = get_company_currency(filters["company"])
|
|
else:
|
|
company = get_default_company()
|
|
currency = get_company_currency(company)
|
|
|
|
columns = [
|
|
{
|
|
"label": _("Posting Date"),
|
|
"fieldname": "posting_date",
|
|
"fieldtype": "Date",
|
|
"width": 90
|
|
},
|
|
{
|
|
"label": _("Account"),
|
|
"fieldname": "account",
|
|
"fieldtype": "Link",
|
|
"options": "Account",
|
|
"width": 180
|
|
},
|
|
{
|
|
"label": _("Debit ({0})".format(currency)),
|
|
"fieldname": "debit",
|
|
"fieldtype": "Float",
|
|
"width": 100
|
|
},
|
|
{
|
|
"label": _("Credit ({0})".format(currency)),
|
|
"fieldname": "credit",
|
|
"fieldtype": "Float",
|
|
"width": 100
|
|
},
|
|
{
|
|
"label": _("Balance ({0})".format(currency)),
|
|
"fieldname": "balance",
|
|
"fieldtype": "Float",
|
|
"width": 130
|
|
}
|
|
]
|
|
|
|
columns.extend([
|
|
{
|
|
"label": _("Voucher Type"),
|
|
"fieldname": "voucher_type",
|
|
"width": 120
|
|
},
|
|
{
|
|
"label": _("Voucher No"),
|
|
"fieldname": "voucher_no",
|
|
"fieldtype": "Dynamic Link",
|
|
"options": "voucher_type",
|
|
"width": 180
|
|
},
|
|
{
|
|
"label": _("Against Account"),
|
|
"fieldname": "against",
|
|
"width": 120
|
|
},
|
|
{
|
|
"label": _("Party Type"),
|
|
"fieldname": "party_type",
|
|
"width": 100
|
|
},
|
|
{
|
|
"label": _("Party"),
|
|
"fieldname": "party",
|
|
"width": 100
|
|
},
|
|
{
|
|
"label": _("Project"),
|
|
"options": "Project",
|
|
"fieldname": "project",
|
|
"width": 100
|
|
},
|
|
{
|
|
"label": _("Cost Center"),
|
|
"options": "Cost Center",
|
|
"fieldname": "cost_center",
|
|
"width": 100
|
|
},
|
|
{
|
|
"label": _("Against Voucher Type"),
|
|
"fieldname": "against_voucher_type",
|
|
"width": 100
|
|
},
|
|
{
|
|
"label": _("Against Voucher"),
|
|
"fieldname": "against_voucher",
|
|
"fieldtype": "Dynamic Link",
|
|
"options": "against_voucher_type",
|
|
"width": 100
|
|
},
|
|
{
|
|
"label": _("Supplier Invoice No"),
|
|
"fieldname": "bill_no",
|
|
"fieldtype": "Data",
|
|
"width": 100
|
|
},
|
|
{
|
|
"label": _("Remarks"),
|
|
"fieldname": "remarks",
|
|
"width": 400
|
|
}
|
|
])
|
|
|
|
return columns
|