brotherton-erpnext/erpnext/accounts/report/utils.py
2021-11-05 11:16:29 +05:30

145 lines
4.8 KiB
Python

import frappe
from frappe.utils import flt, formatdate, get_datetime_str
from erpnext import get_company_currency, get_default_company
from erpnext.accounts.doctype.fiscal_year.fiscal_year import get_from_and_to_date
from erpnext.setup.utils import get_exchange_rate
__exchange_rates = {}
def get_currency(filters):
"""
Returns a dictionary containing currency information. The keys of the dict are
- company: The company for which we are fetching currency information. if no
company is specified, it will fallback to the default company.
- company currency: The functional currency of the said company.
- presentation currency: The presentation currency to use. Only currencies that
have been used for transactions will be allowed.
- report date: The report date.
:param filters: Report filters
:type filters: dict
:return: str - Currency
"""
company = get_appropriate_company(filters)
company_currency = get_company_currency(company)
presentation_currency = filters['presentation_currency'] if filters.get('presentation_currency') else company_currency
report_date = filters.get('to_date')
if not report_date:
fiscal_year_to_date = get_from_and_to_date(filters.get('to_fiscal_year'))["to_date"]
report_date = formatdate(get_datetime_str(fiscal_year_to_date), "dd-MM-yyyy")
currency_map = dict(company=company, company_currency=company_currency, presentation_currency=presentation_currency, report_date=report_date)
return currency_map
def convert(value, from_, to, date):
"""
convert `value` from `from_` to `to` on `date`
:param value: Amount to be converted
:param from_: Currency of `value`
:param to: Currency to convert to
:param date: exchange rate as at this date
:return: Result of converting `value`
"""
rate = get_rate_as_at(date, from_, to)
converted_value = flt(value) / (rate or 1)
return converted_value
def get_rate_as_at(date, from_currency, to_currency):
"""
Gets exchange rate as at `date` for `from_currency` - `to_currency` exchange rate.
This calls `get_exchange_rate` so that we can get the correct exchange rate as per
the user's Accounts Settings.
It is made efficient by memoising results to `__exchange_rates`
:param date: exchange rate as at this date
:param from_currency: Base currency
:param to_currency: Quote currency
:return: Retrieved exchange rate
"""
rate = __exchange_rates.get('{0}-{1}@{2}'.format(from_currency, to_currency, date))
if not rate:
rate = get_exchange_rate(from_currency, to_currency, date) or 1
__exchange_rates['{0}-{1}@{2}'.format(from_currency, to_currency, date)] = rate
return rate
def convert_to_presentation_currency(gl_entries, currency_info, company):
"""
Take a list of GL Entries and change the 'debit' and 'credit' values to currencies
in `currency_info`.
:param gl_entries:
:param currency_info:
:return:
"""
converted_gl_list = []
presentation_currency = currency_info['presentation_currency']
company_currency = currency_info['company_currency']
account_currencies = list(set(entry['account_currency'] for entry in gl_entries))
for entry in gl_entries:
account = entry['account']
debit = flt(entry['debit'])
credit = flt(entry['credit'])
debit_in_account_currency = flt(entry['debit_in_account_currency'])
credit_in_account_currency = flt(entry['credit_in_account_currency'])
account_currency = entry['account_currency']
if len(account_currencies) == 1 and account_currency == presentation_currency:
if entry.get('debit'):
entry['debit'] = debit_in_account_currency
if entry.get('credit'):
entry['credit'] = credit_in_account_currency
else:
date = currency_info['report_date']
converted_debit_value = convert(debit, presentation_currency, company_currency, date)
converted_credit_value = convert(credit, presentation_currency, company_currency, date)
if entry.get('debit'):
entry['debit'] = converted_debit_value
if entry.get('credit'):
entry['credit'] = converted_credit_value
converted_gl_list.append(entry)
return converted_gl_list
def get_appropriate_company(filters):
if filters.get('company'):
company = filters['company']
else:
company = get_default_company()
return company
@frappe.whitelist()
def get_invoiced_item_gross_margin(sales_invoice=None, item_code=None, company=None, with_item_data=False):
from erpnext.accounts.report.gross_profit.gross_profit import GrossProfitGenerator
sales_invoice = sales_invoice or frappe.form_dict.get('sales_invoice')
item_code = item_code or frappe.form_dict.get('item_code')
company = company or frappe.get_cached_value("Sales Invoice", sales_invoice, 'company')
filters = {
'sales_invoice': sales_invoice,
'item_code': item_code,
'company': company,
'group_by': 'Invoice'
}
gross_profit_data = GrossProfitGenerator(filters)
result = gross_profit_data.grouped_data
if not with_item_data:
result = sum(d.gross_profit for d in result)
return result