483 lines
18 KiB
Python
483 lines
18 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 frappe import _, msgprint, scrub
|
|
from frappe.defaults import get_user_permissions
|
|
from frappe.model.utils import get_fetch_values
|
|
from frappe.utils import (add_days, getdate, formatdate, date_diff,
|
|
add_years, get_timestamp, nowdate, flt, add_months, get_last_day)
|
|
from frappe.contacts.doctype.address.address import (get_address_display,
|
|
get_default_address, get_company_address)
|
|
from frappe.contacts.doctype.contact.contact import get_contact_details, get_default_contact
|
|
from erpnext.exceptions import PartyFrozen, PartyDisabled, InvalidAccountCurrency
|
|
from erpnext.accounts.utils import get_fiscal_year
|
|
from erpnext import get_default_currency, get_company_currency
|
|
|
|
|
|
class DuplicatePartyAccountError(frappe.ValidationError): pass
|
|
|
|
@frappe.whitelist()
|
|
def get_party_details(party=None, account=None, party_type="Customer", company=None,
|
|
posting_date=None, price_list=None, currency=None, doctype=None, ignore_permissions=False):
|
|
|
|
if not party:
|
|
return {}
|
|
|
|
if not frappe.db.exists(party_type, party):
|
|
frappe.throw(_("{0}: {1} does not exists").format(party_type, party))
|
|
|
|
return _get_party_details(party, account, party_type,
|
|
company, posting_date, price_list, currency, doctype, ignore_permissions)
|
|
|
|
def _get_party_details(party=None, account=None, party_type="Customer", company=None,
|
|
posting_date=None, price_list=None, currency=None, doctype=None, ignore_permissions=False):
|
|
|
|
out = frappe._dict(set_account_and_due_date(party, account, party_type, company, posting_date, doctype))
|
|
|
|
party = out[party_type.lower()]
|
|
|
|
if not ignore_permissions and not frappe.has_permission(party_type, "read", party):
|
|
frappe.throw(_("Not permitted for {0}").format(party), frappe.PermissionError)
|
|
|
|
party = frappe.get_doc(party_type, party)
|
|
currency = party.default_currency if party.default_currency else get_company_currency(company)
|
|
|
|
set_address_details(out, party, party_type, doctype, company)
|
|
set_contact_details(out, party, party_type)
|
|
set_other_values(out, party, party_type)
|
|
set_price_list(out, party, party_type, price_list)
|
|
out["taxes_and_charges"] = set_taxes(party.name, party_type, posting_date, company, out.customer_group, out.supplier_type)
|
|
out["payment_terms_template"] = get_pyt_term_template(party.name, party_type, company)
|
|
|
|
if not out.get("currency"):
|
|
out["currency"] = currency
|
|
|
|
# sales team
|
|
if party_type=="Customer":
|
|
out["sales_team"] = [{
|
|
"sales_person": d.sales_person,
|
|
"allocated_percentage": d.allocated_percentage or None
|
|
} for d in party.get("sales_team")]
|
|
|
|
return out
|
|
|
|
def set_address_details(out, party, party_type, doctype=None, company=None):
|
|
billing_address_field = "customer_address" if party_type == "Lead" \
|
|
else party_type.lower() + "_address"
|
|
out[billing_address_field] = get_default_address(party_type, party.name)
|
|
if doctype:
|
|
out.update(get_fetch_values(doctype, billing_address_field, out[billing_address_field]))
|
|
|
|
# address display
|
|
out.address_display = get_address_display(out[billing_address_field])
|
|
|
|
# shipping address
|
|
if party_type in ["Customer", "Lead"]:
|
|
out.shipping_address_name = get_party_shipping_address(party_type, party.name)
|
|
out.shipping_address = get_address_display(out["shipping_address_name"])
|
|
if doctype:
|
|
out.update(get_fetch_values(doctype, 'shipping_address_name', out.shipping_address_name))
|
|
|
|
if doctype and doctype in ['Delivery Note', 'Sales Invoice']:
|
|
out.update(get_company_address(company))
|
|
if out.company_address:
|
|
out.update(get_fetch_values(doctype, 'company_address', out.company_address))
|
|
|
|
def set_contact_details(out, party, party_type):
|
|
out.contact_person = get_default_contact(party_type, party.name)
|
|
|
|
if not out.contact_person:
|
|
out.update({
|
|
"contact_person": None,
|
|
"contact_display": None,
|
|
"contact_email": None,
|
|
"contact_mobile": None,
|
|
"contact_phone": None,
|
|
"contact_designation": None,
|
|
"contact_department": None
|
|
})
|
|
else:
|
|
out.update(get_contact_details(out.contact_person))
|
|
|
|
def set_other_values(out, party, party_type):
|
|
# copy
|
|
if party_type=="Customer":
|
|
to_copy = ["customer_name", "customer_group", "territory", "language"]
|
|
else:
|
|
to_copy = ["supplier_name", "supplier_type", "language"]
|
|
for f in to_copy:
|
|
out[f] = party.get(f)
|
|
|
|
# fields prepended with default in Customer doctype
|
|
for f in ['currency'] \
|
|
+ (['sales_partner', 'commission_rate'] if party_type=="Customer" else []):
|
|
if party.get("default_" + f):
|
|
out[f] = party.get("default_" + f)
|
|
|
|
def get_default_price_list(party):
|
|
"""Return default price list for party (Document object)"""
|
|
if party.default_price_list:
|
|
return party.default_price_list
|
|
|
|
if party.doctype == "Customer":
|
|
price_list = frappe.db.get_value("Customer Group",
|
|
party.customer_group, "default_price_list")
|
|
if price_list:
|
|
return price_list
|
|
|
|
return None
|
|
|
|
def set_price_list(out, party, party_type, given_price_list):
|
|
# price list
|
|
price_list = filter(None, get_user_permissions().get("Price List", []))
|
|
if isinstance(price_list, list):
|
|
price_list = price_list[0] if len(price_list)==1 else None
|
|
|
|
if not price_list:
|
|
price_list = get_default_price_list(party)
|
|
|
|
if not price_list:
|
|
price_list = given_price_list
|
|
|
|
if price_list:
|
|
out.price_list_currency = frappe.db.get_value("Price List", price_list, "currency")
|
|
|
|
out["selling_price_list" if party.doctype=="Customer" else "buying_price_list"] = price_list
|
|
|
|
|
|
def set_account_and_due_date(party, account, party_type, company, posting_date, doctype):
|
|
if doctype not in ["Sales Invoice", "Purchase Invoice"]:
|
|
# not an invoice
|
|
return {
|
|
party_type.lower(): party
|
|
}
|
|
|
|
if party:
|
|
account = get_party_account(party_type, party, company)
|
|
|
|
account_fieldname = "debit_to" if party_type=="Customer" else "credit_to"
|
|
|
|
out = {
|
|
party_type.lower(): party,
|
|
account_fieldname : account,
|
|
"due_date": get_due_date(posting_date, party_type, party, company)
|
|
}
|
|
return out
|
|
|
|
@frappe.whitelist()
|
|
def get_party_account(party_type, party, company):
|
|
"""Returns the account for the given `party`.
|
|
Will first search in party (Customer / Supplier) record, if not found,
|
|
will search in group (Customer Group / Supplier Type),
|
|
finally will return default."""
|
|
if not company:
|
|
frappe.throw(_("Please select a Company"))
|
|
|
|
if not party:
|
|
return
|
|
|
|
account = frappe.db.get_value("Party Account",
|
|
{"parenttype": party_type, "parent": party, "company": company}, "account")
|
|
|
|
if not account and party_type in ['Customer', 'Supplier']:
|
|
party_group_doctype = "Customer Group" if party_type=="Customer" else "Supplier Type"
|
|
group = frappe.db.get_value(party_type, party, scrub(party_group_doctype))
|
|
account = frappe.db.get_value("Party Account",
|
|
{"parenttype": party_group_doctype, "parent": group, "company": company}, "account")
|
|
|
|
if not account and party_type in ['Customer', 'Supplier']:
|
|
default_account_name = "default_receivable_account" \
|
|
if party_type=="Customer" else "default_payable_account"
|
|
account = frappe.db.get_value("Company", company, default_account_name)
|
|
|
|
existing_gle_currency = get_party_gle_currency(party_type, party, company)
|
|
if existing_gle_currency:
|
|
if account:
|
|
account_currency = frappe.db.get_value("Account", account, "account_currency")
|
|
if (account and account_currency != existing_gle_currency) or not account:
|
|
account = get_party_gle_account(party_type, party, company)
|
|
|
|
return account
|
|
|
|
def get_party_account_currency(party_type, party, company):
|
|
def generator():
|
|
party_account = get_party_account(party_type, party, company)
|
|
return frappe.db.get_value("Account", party_account, "account_currency")
|
|
|
|
return frappe.local_cache("party_account_currency", (party_type, party, company), generator)
|
|
|
|
def get_party_gle_currency(party_type, party, company):
|
|
def generator():
|
|
existing_gle_currency = frappe.db.sql("""select account_currency from `tabGL Entry`
|
|
where docstatus=1 and company=%(company)s and party_type=%(party_type)s and party=%(party)s
|
|
limit 1""", { "company": company, "party_type": party_type, "party": party })
|
|
|
|
return existing_gle_currency[0][0] if existing_gle_currency else None
|
|
|
|
return frappe.local_cache("party_gle_currency", (party_type, party, company), generator,
|
|
regenerate_if_none=True)
|
|
|
|
def get_party_gle_account(party_type, party, company):
|
|
def generator():
|
|
existing_gle_account = frappe.db.sql("""select account from `tabGL Entry`
|
|
where docstatus=1 and company=%(company)s and party_type=%(party_type)s and party=%(party)s
|
|
limit 1""", { "company": company, "party_type": party_type, "party": party })
|
|
|
|
return existing_gle_account[0][0] if existing_gle_account else None
|
|
|
|
return frappe.local_cache("party_gle_account", (party_type, party, company), generator,
|
|
regenerate_if_none=True)
|
|
|
|
def validate_party_gle_currency(party_type, party, company, party_account_currency=None):
|
|
"""Validate party account currency with existing GL Entry's currency"""
|
|
if not party_account_currency:
|
|
party_account_currency = get_party_account_currency(party_type, party, company)
|
|
|
|
existing_gle_currency = get_party_gle_currency(party_type, party, company)
|
|
|
|
if existing_gle_currency and party_account_currency != existing_gle_currency:
|
|
frappe.throw(_("Accounting Entry for {0}: {1} can only be made in currency: {2}")
|
|
.format(party_type, party, existing_gle_currency), InvalidAccountCurrency)
|
|
|
|
def validate_party_accounts(doc):
|
|
companies = []
|
|
|
|
for account in doc.get("accounts"):
|
|
if account.company in companies:
|
|
frappe.throw(_("There can only be 1 Account per Company in {0} {1}")
|
|
.format(doc.doctype, doc.name), DuplicatePartyAccountError)
|
|
else:
|
|
companies.append(account.company)
|
|
|
|
party_account_currency = frappe.db.get_value("Account", account.account, "account_currency")
|
|
existing_gle_currency = get_party_gle_currency(doc.doctype, doc.name, account.company)
|
|
company_default_currency = frappe.db.get_value("Company",
|
|
frappe.db.get_default("Company"), "default_currency", cache=True)
|
|
|
|
if existing_gle_currency and party_account_currency != existing_gle_currency:
|
|
frappe.throw(_("Accounting entries have already been made in currency {0} for company {1}. Please select a receivable or payable account with currency {0}.").format(existing_gle_currency, account.company))
|
|
|
|
if doc.get("default_currency") and party_account_currency and company_default_currency:
|
|
if doc.default_currency != party_account_currency and doc.default_currency != company_default_currency:
|
|
frappe.throw(_("Billing currency must be equal to either default company's currency or party account currency"))
|
|
|
|
|
|
@frappe.whitelist()
|
|
def get_due_date(posting_date, party_type, party, company=None):
|
|
"""Get due date from `Payment Terms Template`"""
|
|
due_date = None
|
|
if posting_date and party:
|
|
due_date = posting_date
|
|
template_name = get_pyt_term_template(party, party_type, company)
|
|
if template_name:
|
|
due_date = get_due_date_from_template(template_name, posting_date).strftime("%Y-%m-%d")
|
|
else:
|
|
if party_type == "Supplier":
|
|
supplier_type = frappe.db.get_value(party_type, party, fieldname="supplier_type")
|
|
template_name = frappe.db.get_value("Supplier Type", supplier_type, fieldname="payment_terms")
|
|
if template_name:
|
|
due_date = get_due_date_from_template(template_name, posting_date).strftime("%Y-%m-%d")
|
|
|
|
return due_date
|
|
|
|
|
|
def get_due_date_from_template(template_name, posting_date):
|
|
"""
|
|
Inspects all `Payment Term`s from the a `Payment Terms Template` and returns the due
|
|
date after considering all the `Payment Term`s requirements.
|
|
:param template_name: Name of the `Payment Terms Template`
|
|
:return: String representing the calculated due date
|
|
"""
|
|
due_date = getdate(posting_date)
|
|
template = frappe.get_doc('Payment Terms Template', template_name)
|
|
|
|
for term in template.terms:
|
|
if term.due_date_based_on == 'Day(s) after invoice date':
|
|
due_date = max(due_date, add_days(due_date, term.credit_days))
|
|
elif term.due_date_based_on == 'Day(s) after the end of the invoice month':
|
|
due_date = max(due_date, add_days(get_last_day(due_date), term.credit_days))
|
|
else:
|
|
due_date = max(due_date, add_months(get_last_day(due_date), term.credit_months))
|
|
|
|
return due_date
|
|
|
|
def validate_due_date(posting_date, due_date, party_type, party, company=None):
|
|
if getdate(due_date) < getdate(posting_date):
|
|
frappe.throw(_("Due Date cannot be before Posting Date"))
|
|
else:
|
|
default_due_date = get_due_date(posting_date, party_type, party, company)
|
|
if not default_due_date:
|
|
return
|
|
|
|
if default_due_date != posting_date and getdate(due_date) > getdate(default_due_date):
|
|
is_credit_controller = frappe.db.get_single_value("Accounts Settings", "credit_controller") in frappe.get_roles()
|
|
if is_credit_controller:
|
|
msgprint(_("Note: Due / Reference Date exceeds allowed customer credit days by {0} day(s)")
|
|
.format(date_diff(due_date, default_due_date)))
|
|
else:
|
|
frappe.throw(_("Due / Reference Date cannot be after {0}")
|
|
.format(formatdate(default_due_date)))
|
|
|
|
@frappe.whitelist()
|
|
def set_taxes(party, party_type, posting_date, company, customer_group=None, supplier_type=None,
|
|
billing_address=None, shipping_address=None, use_for_shopping_cart=None):
|
|
from erpnext.accounts.doctype.tax_rule.tax_rule import get_tax_template, get_party_details
|
|
args = {
|
|
party_type.lower(): party,
|
|
"company": company
|
|
}
|
|
|
|
if customer_group:
|
|
args['customer_group'] = customer_group
|
|
|
|
if supplier_type:
|
|
args['supplier_type'] = supplier_type
|
|
|
|
if billing_address or shipping_address:
|
|
args.update(get_party_details(party, party_type, {"billing_address": billing_address, \
|
|
"shipping_address": shipping_address }))
|
|
else:
|
|
args.update(get_party_details(party, party_type))
|
|
|
|
if party_type in ("Customer", "Lead"):
|
|
args.update({"tax_type": "Sales"})
|
|
|
|
if party_type=='Lead':
|
|
args['customer'] = None
|
|
del args['lead']
|
|
else:
|
|
args.update({"tax_type": "Purchase"})
|
|
|
|
if use_for_shopping_cart:
|
|
args.update({"use_for_shopping_cart": use_for_shopping_cart})
|
|
|
|
return get_tax_template(posting_date, args)
|
|
|
|
|
|
@frappe.whitelist()
|
|
def get_pyt_term_template(party_name, party_type, company=None):
|
|
if party_type not in ("Customer", "Supplier"):
|
|
return
|
|
|
|
template = None
|
|
if party_type == 'Customer':
|
|
customer = frappe.db.get_value("Customer", party_name,
|
|
fieldname=['payment_terms', "customer_group"], as_dict=1)
|
|
template = customer.payment_terms
|
|
|
|
if not template and customer.customer_group:
|
|
template = frappe.db.get_value("Customer Group",
|
|
customer.customer_group, fieldname='payment_terms')
|
|
else:
|
|
supplier = frappe.db.get_value("Supplier", party_name,
|
|
fieldname=['payment_terms', "supplier_type"], as_dict=1)
|
|
template = supplier.payment_terms
|
|
|
|
if not template and supplier.supplier_type:
|
|
template = frappe.db.get_value("Supplier Type", supplier.supplier_type, fieldname='payment_terms')
|
|
|
|
if not template and company:
|
|
template = frappe.db.get_value("Company", company, fieldname='payment_terms')
|
|
|
|
return template
|
|
|
|
def validate_party_frozen_disabled(party_type, party_name):
|
|
if party_type and party_name:
|
|
if party_type in ("Customer", "Supplier"):
|
|
party = frappe.db.get_value(party_type, party_name, ["is_frozen", "disabled"], as_dict=True)
|
|
if party.disabled:
|
|
frappe.throw(_("{0} {1} is disabled").format(party_type, party_name), PartyDisabled)
|
|
elif party.get("is_frozen"):
|
|
frozen_accounts_modifier = frappe.db.get_value( 'Accounts Settings', None,'frozen_accounts_modifier')
|
|
if not frozen_accounts_modifier in frappe.get_roles():
|
|
frappe.throw(_("{0} {1} is frozen").format(party_type, party_name), PartyFrozen)
|
|
|
|
elif party_type == "Employee":
|
|
if frappe.db.get_value("Employee", party_name, "status") == "Left":
|
|
frappe.msgprint(_("{0} {1} is not active").format(party_type, party_name), alert=True)
|
|
|
|
def get_timeline_data(doctype, name):
|
|
'''returns timeline data for the past one year'''
|
|
from frappe.desk.form.load import get_communication_data
|
|
|
|
out = {}
|
|
data = get_communication_data(doctype, name,
|
|
fields = 'date(creation), count(name)',
|
|
after = add_years(None, -1).strftime('%Y-%m-%d'),
|
|
group_by='group by date(creation)', as_dict=False)
|
|
|
|
timeline_items = dict(data)
|
|
|
|
for date, count in timeline_items.iteritems():
|
|
timestamp = get_timestamp(date)
|
|
out.update({ timestamp: count })
|
|
|
|
return out
|
|
|
|
def get_dashboard_info(party_type, party):
|
|
current_fiscal_year = get_fiscal_year(nowdate(), as_dict=True)
|
|
company = frappe.db.get_default("company") or frappe.get_all("Company")[0].name
|
|
party_account_currency = get_party_account_currency(party_type, party, company)
|
|
company_default_currency = get_default_currency() \
|
|
or frappe.db.get_value('Company', company, 'default_currency')
|
|
|
|
if party_account_currency==company_default_currency:
|
|
total_field = "base_grand_total"
|
|
else:
|
|
total_field = "grand_total"
|
|
|
|
doctype = "Sales Invoice" if party_type=="Customer" else "Purchase Invoice"
|
|
|
|
billing_this_year = frappe.db.sql("""
|
|
select sum({0})
|
|
from `tab{1}`
|
|
where {2}=%s and docstatus=1 and posting_date between %s and %s
|
|
""".format(total_field, doctype, party_type.lower()),
|
|
(party, current_fiscal_year.year_start_date, current_fiscal_year.year_end_date))
|
|
|
|
total_unpaid = frappe.db.sql("""
|
|
select sum(debit_in_account_currency) - sum(credit_in_account_currency)
|
|
from `tabGL Entry`
|
|
where party_type = %s and party=%s""", (party_type, party))
|
|
|
|
info = {}
|
|
info["billing_this_year"] = flt(billing_this_year[0][0]) if billing_this_year else 0
|
|
info["currency"] = party_account_currency
|
|
info["total_unpaid"] = flt(total_unpaid[0][0]) if total_unpaid else 0
|
|
if party_type == "Supplier":
|
|
info["total_unpaid"] = -1 * info["total_unpaid"]
|
|
|
|
return info
|
|
|
|
|
|
def get_party_shipping_address(doctype, name):
|
|
"""
|
|
Returns an Address name (best guess) for the given doctype and name for which `address_type == 'Shipping'` is true.
|
|
and/or `is_shipping_address = 1`.
|
|
|
|
It returns an empty string if there is no matching record.
|
|
|
|
:param doctype: Party Doctype
|
|
:param name: Party name
|
|
:return: String
|
|
"""
|
|
out = frappe.db.sql(
|
|
'SELECT dl.parent '
|
|
'from `tabDynamic Link` dl join `tabAddress` ta on dl.parent=ta.name '
|
|
'where '
|
|
'dl.link_doctype=%s '
|
|
'and dl.link_name=%s '
|
|
'and dl.parenttype="Address" '
|
|
'and '
|
|
'(ta.address_type="Shipping" or ta.is_shipping_address=1) '
|
|
'order by ta.is_shipping_address desc, ta.address_type desc limit 1',
|
|
(doctype, name)
|
|
)
|
|
if out:
|
|
return out[0][0]
|
|
else:
|
|
return ''
|