blob: b0b3049d4878f400fc076d8c7418725ba3f060fa [file] [log] [blame]
Anand Doshi885e0742015-03-03 14:55:30 +05301# Copyright (c) 2015, Frappe Technologies Pvt. Ltd. and Contributors
Rushabh Mehta49dd7be2014-01-28 17:43:10 +05302# License: GNU General Public License v3. See license.txt
3
Rushabh Mehta49dd7be2014-01-28 17:43:10 +05304
Chillar Anand915b3432021-09-02 16:44:59 +05305import frappe
Nabin Haitdb030d12014-09-10 17:11:30 +05306from frappe import _, msgprint, scrub
Chillar Anand915b3432021-09-02 16:44:59 +05307from frappe.contacts.doctype.address.address import (
8 get_address_display,
9 get_company_address,
10 get_default_address,
11)
12from frappe.contacts.doctype.contact.contact import get_contact_details
Suraj Shetty7ed37ae2018-12-19 19:56:42 +053013from frappe.core.doctype.user_permission.user_permission import get_permitted_documents
Rushabh Mehta919a74a2017-06-22 16:37:04 +053014from frappe.model.utils import get_fetch_values
Chillar Anand915b3432021-09-02 16:44:59 +053015from frappe.utils import (
16 add_days,
17 add_months,
18 add_years,
19 cint,
20 cstr,
21 date_diff,
22 flt,
23 formatdate,
24 get_last_day,
25 get_timestamp,
26 getdate,
27 nowdate,
28)
tunde4a263c72017-08-02 22:20:35 +010029
Chillar Anand915b3432021-09-02 16:44:59 +053030import erpnext
31from erpnext import get_company_currency
32from erpnext.accounts.utils import get_fiscal_year
33from erpnext.exceptions import InvalidAccountCurrency, PartyDisabled, PartyFrozen
34
Rushabh Mehta49dd7be2014-01-28 17:43:10 +053035
Ankush Menat494bd9e2022-03-28 18:52:46 +053036class DuplicatePartyAccountError(frappe.ValidationError):
37 pass
38
Nabin Hait16099332015-09-03 16:03:07 +053039
Rushabh Mehta793ba6b2014-02-14 15:47:51 +053040@frappe.whitelist()
Ankush Menat494bd9e2022-03-28 18:52:46 +053041def get_party_details(
42 party=None,
43 account=None,
44 party_type="Customer",
45 company=None,
46 posting_date=None,
47 bill_date=None,
48 price_list=None,
49 currency=None,
50 doctype=None,
51 ignore_permissions=False,
52 fetch_payment_terms_template=True,
53 party_address=None,
54 company_address=None,
55 shipping_address=None,
56 pos_profile=None,
57):
Anand Doshi201dbbd2014-02-20 15:21:53 +053058
Rushabh Mehtad7a5b732015-04-01 23:38:13 +053059 if not party:
60 return {}
Nabin Hait5ef121b2015-06-08 12:26:52 +053061 if not frappe.db.exists(party_type, party):
62 frappe.throw(_("{0}: {1} does not exists").format(party_type, party))
Ankush Menat494bd9e2022-03-28 18:52:46 +053063 return _get_party_details(
64 party,
65 account,
66 party_type,
67 company,
68 posting_date,
69 bill_date,
70 price_list,
71 currency,
72 doctype,
73 ignore_permissions,
74 fetch_payment_terms_template,
75 party_address,
76 company_address,
77 shipping_address,
78 pos_profile,
79 )
Anand Doshi201dbbd2014-02-20 15:21:53 +053080
Ankush Menat494bd9e2022-03-28 18:52:46 +053081
82def _get_party_details(
83 party=None,
84 account=None,
85 party_type="Customer",
86 company=None,
87 posting_date=None,
88 bill_date=None,
89 price_list=None,
90 currency=None,
91 doctype=None,
92 ignore_permissions=False,
93 fetch_payment_terms_template=True,
94 party_address=None,
95 company_address=None,
96 shipping_address=None,
97 pos_profile=None,
98):
99 party_details = frappe._dict(
100 set_account_and_due_date(party, account, party_type, company, posting_date, bill_date, doctype)
101 )
Deepesh Garg6e2c13f2019-12-10 15:55:05 +0530102 party = party_details[party_type.lower()]
Rushabh Mehtacc008cc2014-02-03 16:14:56 +0530103
Ankush Menat494bd9e2022-03-28 18:52:46 +0530104 if not ignore_permissions and not (
105 frappe.has_permission(party_type, "read", party)
106 or frappe.has_permission(party_type, "select", party)
107 ):
Rushabh Mehta2d708872015-11-27 11:35:35 +0530108 frappe.throw(_("Not permitted for {0}").format(party), frappe.PermissionError)
Rushabh Mehtacc008cc2014-02-03 16:14:56 +0530109
Nabin Hait365ae272014-04-03 17:38:54 +0530110 party = frappe.get_doc(party_type, party)
Deepesh Gargb72cdb42022-01-21 18:00:35 +0530111 currency = party.get("default_currency") or currency or get_company_currency(company)
Rushabh Mehtacc008cc2014-02-03 16:14:56 +0530112
Ankush Menat494bd9e2022-03-28 18:52:46 +0530113 party_address, shipping_address = set_address_details(
114 party_details,
115 party,
116 party_type,
117 doctype,
118 company,
119 party_address,
120 company_address,
121 shipping_address,
122 )
Deepesh Gargcf9347d2020-03-31 17:28:43 +0530123 set_contact_details(party_details, party, party_type)
Deepesh Garg6e2c13f2019-12-10 15:55:05 +0530124 set_other_values(party_details, party, party_type)
125 set_price_list(party_details, party, party_type, price_list, pos_profile)
Anand Doshi13ae5482014-04-10 18:40:57 +0530126
Ankush Menat494bd9e2022-03-28 18:52:46 +0530127 party_details["tax_category"] = get_address_tax_category(
128 party.get("tax_category"),
129 party_address,
130 shipping_address if party_type != "Supplier" else party_address,
131 )
Deepesh Garg6e2c13f2019-12-10 15:55:05 +0530132
Ankush Menat494bd9e2022-03-28 18:52:46 +0530133 tax_template = set_taxes(
134 party.name,
135 party_type,
136 posting_date,
137 company,
138 customer_group=party_details.customer_group,
139 supplier_group=party_details.supplier_group,
140 tax_category=party_details.tax_category,
141 billing_address=party_address,
142 shipping_address=shipping_address,
143 )
Deepesh Gargf12be302021-11-30 20:34:53 +0530144
145 if tax_template:
Ankush Menat494bd9e2022-03-28 18:52:46 +0530146 party_details["taxes_and_charges"] = tax_template
rohitwaghchaure3ffe8962018-07-13 17:40:48 +0530147
Deepesh Gargbcf56e62021-08-06 23:53:16 +0530148 if cint(fetch_payment_terms_template):
Ankush Menat494bd9e2022-03-28 18:52:46 +0530149 party_details["payment_terms_template"] = get_payment_terms_template(
150 party.name, party_type, company
151 )
Rushabh Mehtacc008cc2014-02-03 16:14:56 +0530152
Deepesh Garg6e2c13f2019-12-10 15:55:05 +0530153 if not party_details.get("currency"):
154 party_details["currency"] = currency
Anand Doshi13ae5482014-04-10 18:40:57 +0530155
Rushabh Mehtacc008cc2014-02-03 16:14:56 +0530156 # sales team
Ankush Menat494bd9e2022-03-28 18:52:46 +0530157 if party_type == "Customer":
158 party_details["sales_team"] = [
159 {
160 "sales_person": d.sales_person,
161 "allocated_percentage": d.allocated_percentage or None,
162 "commission_rate": d.commission_rate,
163 }
164 for d in party.get("sales_team")
165 ]
Anand Doshi13ae5482014-04-10 18:40:57 +0530166
Zarrar7f8024c2018-08-01 17:45:05 +0530167 # supplier tax withholding category
168 if party_type == "Supplier" and party:
Ankush Menat494bd9e2022-03-28 18:52:46 +0530169 party_details["supplier_tds"] = frappe.get_value(
170 party_type, party.name, "tax_withholding_category"
171 )
Zarrar7f8024c2018-08-01 17:45:05 +0530172
Deepesh Garg6e2c13f2019-12-10 15:55:05 +0530173 return party_details
Rushabh Mehtacc008cc2014-02-03 16:14:56 +0530174
Ankush Menat494bd9e2022-03-28 18:52:46 +0530175
176def set_address_details(
177 party_details,
178 party,
179 party_type,
180 doctype=None,
181 company=None,
182 party_address=None,
183 company_address=None,
184 shipping_address=None,
185):
186 billing_address_field = (
187 "customer_address" if party_type == "Lead" else party_type.lower() + "_address"
188 )
189 party_details[billing_address_field] = party_address or get_default_address(
190 party_type, party.name
191 )
Nabin Hait7eba1a32017-10-02 15:59:27 +0530192 if doctype:
Ankush Menat494bd9e2022-03-28 18:52:46 +0530193 party_details.update(
194 get_fetch_values(doctype, billing_address_field, party_details[billing_address_field])
195 )
Rushabh Mehtacc008cc2014-02-03 16:14:56 +0530196 # address display
Deepesh Garg6e2c13f2019-12-10 15:55:05 +0530197 party_details.address_display = get_address_display(party_details[billing_address_field])
Nabin Hait9d1f0772014-02-19 17:43:24 +0530198 # shipping address
199 if party_type in ["Customer", "Lead"]:
Ankush Menat494bd9e2022-03-28 18:52:46 +0530200 party_details.shipping_address_name = shipping_address or get_party_shipping_address(
201 party_type, party.name
202 )
Deepesh Garg6e2c13f2019-12-10 15:55:05 +0530203 party_details.shipping_address = get_address_display(party_details["shipping_address_name"])
Nabin Hait7eba1a32017-10-02 15:59:27 +0530204 if doctype:
Ankush Menat494bd9e2022-03-28 18:52:46 +0530205 party_details.update(
206 get_fetch_values(doctype, "shipping_address_name", party_details.shipping_address_name)
207 )
Rushabh Mehta919a74a2017-06-22 16:37:04 +0530208
Deepesh Garg6e2c13f2019-12-10 15:55:05 +0530209 if company_address:
Ankush Menat494bd9e2022-03-28 18:52:46 +0530210 party_details.update({"company_address": company_address})
Deepesh Garg6e2c13f2019-12-10 15:55:05 +0530211 else:
212 party_details.update(get_company_address(company))
Shreya Shah4fa600a2018-06-05 11:27:53 +0530213
Ankush Menat494bd9e2022-03-28 18:52:46 +0530214 if doctype and doctype in ["Delivery Note", "Sales Invoice", "Sales Order"]:
Deepesh Garg6e2c13f2019-12-10 15:55:05 +0530215 if party_details.company_address:
Ankush Menat494bd9e2022-03-28 18:52:46 +0530216 party_details.update(
217 get_fetch_values(doctype, "company_address", party_details.company_address)
218 )
Deepesh Garg6e2c13f2019-12-10 15:55:05 +0530219 get_regional_address_details(party_details, doctype, company)
Shreya Shah4fa600a2018-06-05 11:27:53 +0530220
Deepesh Garg6e2c13f2019-12-10 15:55:05 +0530221 elif doctype and doctype in ["Purchase Invoice", "Purchase Order", "Purchase Receipt"]:
222 if party_details.company_address:
223 party_details["shipping_address"] = shipping_address or party_details["company_address"]
224 party_details.shipping_address_display = get_address_display(party_details["shipping_address"])
Ankush Menat494bd9e2022-03-28 18:52:46 +0530225 party_details.update(
226 get_fetch_values(doctype, "shipping_address", party_details.shipping_address)
227 )
Deepesh Garg6e2c13f2019-12-10 15:55:05 +0530228 get_regional_address_details(party_details, doctype, company)
229
230 return party_details.get(billing_address_field), party_details.shipping_address_name
Saif Ur Rehman67786682018-12-27 02:11:07 +0500231
Ankush Menat494bd9e2022-03-28 18:52:46 +0530232
Shreya Shah4fa600a2018-06-05 11:27:53 +0530233@erpnext.allow_regional
Deepesh Garg6e2c13f2019-12-10 15:55:05 +0530234def get_regional_address_details(party_details, doctype, company):
Shreya Shah4fa600a2018-06-05 11:27:53 +0530235 pass
Anand Doshi13ae5482014-04-10 18:40:57 +0530236
Ankush Menat494bd9e2022-03-28 18:52:46 +0530237
Deepesh Gargcf9347d2020-03-31 17:28:43 +0530238def set_contact_details(party_details, party, party_type):
239 party_details.contact_person = get_default_contact(party_type, party.name)
Anand Doshi13ae5482014-04-10 18:40:57 +0530240
Deepesh Garg6e2c13f2019-12-10 15:55:05 +0530241 if not party_details.contact_person:
Ankush Menat494bd9e2022-03-28 18:52:46 +0530242 party_details.update(
243 {
244 "contact_person": None,
245 "contact_display": None,
246 "contact_email": None,
247 "contact_mobile": None,
248 "contact_phone": None,
249 "contact_designation": None,
250 "contact_department": None,
251 }
252 )
Neil Trini Lasradofe2ffae2015-07-08 18:16:51 +0530253 else:
Deepesh Garg6e2c13f2019-12-10 15:55:05 +0530254 party_details.update(get_contact_details(party_details.contact_person))
Rushabh Mehtacc008cc2014-02-03 16:14:56 +0530255
Ankush Menat494bd9e2022-03-28 18:52:46 +0530256
Deepesh Garg6e2c13f2019-12-10 15:55:05 +0530257def set_other_values(party_details, party, party_type):
Rushabh Mehtacc008cc2014-02-03 16:14:56 +0530258 # copy
ChillarAnand9ace7d62022-03-07 16:53:59 +0530259 if party_type == "Customer":
saurabh8e499512016-02-19 11:08:45 +0530260 to_copy = ["customer_name", "customer_group", "territory", "language"]
Rushabh Mehta49dd7be2014-01-28 17:43:10 +0530261 else:
Zlash6589070782018-04-19 18:37:29 +0530262 to_copy = ["supplier_name", "supplier_group", "language"]
Rushabh Mehtacc008cc2014-02-03 16:14:56 +0530263 for f in to_copy:
Deepesh Garg6e2c13f2019-12-10 15:55:05 +0530264 party_details[f] = party.get(f)
Anand Doshi13ae5482014-04-10 18:40:57 +0530265
Rushabh Mehtacc008cc2014-02-03 16:14:56 +0530266 # fields prepended with default in Customer doctype
Ankush Menat494bd9e2022-03-28 18:52:46 +0530267 for f in ["currency"] + (
268 ["sales_partner", "commission_rate"] if party_type == "Customer" else []
269 ):
Rushabh Mehtacc008cc2014-02-03 16:14:56 +0530270 if party.get("default_" + f):
Deepesh Garg6e2c13f2019-12-10 15:55:05 +0530271 party_details[f] = party.get("default_" + f)
Rushabh Mehtacc008cc2014-02-03 16:14:56 +0530272
Ankush Menat494bd9e2022-03-28 18:52:46 +0530273
Rushabh Mehta72fbf902015-09-17 18:29:44 +0530274def get_default_price_list(party):
275 """Return default price list for party (Document object)"""
Nabin Hait34c551d2019-07-03 10:34:31 +0530276 if party.get("default_price_list"):
Rushabh Mehta72fbf902015-09-17 18:29:44 +0530277 return party.default_price_list
278
279 if party.doctype == "Customer":
Saqib Ansarie5fb8712022-03-10 13:54:43 +0530280 return frappe.db.get_value("Customer Group", party.customer_group, "default_price_list")
Rushabh Mehta72fbf902015-09-17 18:29:44 +0530281
Rushabh Mehta72fbf902015-09-17 18:29:44 +0530282
Deepesh Garg6e2c13f2019-12-10 15:55:05 +0530283def set_price_list(party_details, party, party_type, given_price_list, pos=None):
Anand Doshi13ae5482014-04-10 18:40:57 +0530284 # price list
Ankush Menat494bd9e2022-03-28 18:52:46 +0530285 price_list = get_permitted_documents("Price List")
rohitwaghchaure52107612020-05-05 12:12:33 +0530286
Faris Ansari64f01bd2020-04-14 11:51:48 +0530287 # if there is only one permitted document based on user permissions, set it
288 if price_list and len(price_list) == 1:
Suraj Shettydcc90e32018-05-04 17:52:57 +0530289 price_list = price_list[0]
Ankush Menat494bd9e2022-03-28 18:52:46 +0530290 elif pos and party_type == "Customer":
291 customer_price_list = frappe.get_value("Customer", party.name, "default_price_list")
deepeshgarg007c48efab2019-01-24 17:15:38 +0530292
293 if customer_price_list:
294 price_list = customer_price_list
295 else:
Ankush Menat494bd9e2022-03-28 18:52:46 +0530296 pos_price_list = frappe.get_value("POS Profile", pos, "selling_price_list")
deepeshgarg0071f9a6fe2019-01-25 11:53:55 +0530297 price_list = pos_price_list or given_price_list
Suraj Shettydcc90e32018-05-04 17:52:57 +0530298 else:
299 price_list = get_default_price_list(party) or given_price_list
Rushabh Mehtacc008cc2014-02-03 16:14:56 +0530300
301 if price_list:
Ankush Menat494bd9e2022-03-28 18:52:46 +0530302 party_details.price_list_currency = frappe.db.get_value(
303 "Price List", price_list, "currency", cache=True
304 )
Anand Doshi13ae5482014-04-10 18:40:57 +0530305
Ankush Menat494bd9e2022-03-28 18:52:46 +0530306 party_details[
307 "selling_price_list" if party.doctype == "Customer" else "buying_price_list"
308 ] = price_list
Anand Doshi13ae5482014-04-10 18:40:57 +0530309
Rushabh Mehtacc008cc2014-02-03 16:14:56 +0530310
Ankush Menat494bd9e2022-03-28 18:52:46 +0530311def set_account_and_due_date(
312 party, account, party_type, company, posting_date, bill_date, doctype
313):
Saqiba6f98d42020-07-23 18:51:26 +0530314 if doctype not in ["POS Invoice", "Sales Invoice", "Purchase Invoice"]:
Rushabh Mehtacc008cc2014-02-03 16:14:56 +0530315 # not an invoice
Ankush Menat494bd9e2022-03-28 18:52:46 +0530316 return {party_type.lower(): party}
Anand Doshi13ae5482014-04-10 18:40:57 +0530317
Rushabh Mehta49dd7be2014-01-28 17:43:10 +0530318 if party:
Anand Doshib20baf82015-09-25 16:17:50 +0530319 account = get_party_account(party_type, party, company)
Rushabh Mehta49dd7be2014-01-28 17:43:10 +0530320
Ankush Menat494bd9e2022-03-28 18:52:46 +0530321 account_fieldname = "debit_to" if party_type == "Customer" else "credit_to"
Rushabh Mehta49dd7be2014-01-28 17:43:10 +0530322 out = {
323 party_type.lower(): party,
Ankush Menat494bd9e2022-03-28 18:52:46 +0530324 account_fieldname: account,
325 "due_date": get_due_date(posting_date, party_type, party, company, bill_date),
Rushabh Mehtacc008cc2014-02-03 16:14:56 +0530326 }
Shreya Shah3a9eec22018-02-16 13:05:21 +0530327
Rushabh Mehta49dd7be2014-01-28 17:43:10 +0530328 return out
Rushabh Mehta361df892015-09-18 12:59:51 +0530329
Ankush Menat494bd9e2022-03-28 18:52:46 +0530330
Nabin Haitdb030d12014-09-10 17:11:30 +0530331@frappe.whitelist()
Deepesh Garg88648572021-11-12 12:39:30 +0530332def get_party_account(party_type, party=None, company=None):
Rushabh Mehta364054a2015-02-21 14:39:35 +0530333 """Returns the account for the given `party`.
Ankush Menat494bd9e2022-03-28 18:52:46 +0530334 Will first search in party (Customer / Supplier) record, if not found,
335 will search in group (Customer Group / Supplier Group),
336 finally will return default."""
Rushabh Mehta49dd7be2014-01-28 17:43:10 +0530337 if not company:
Anand Doshib20baf82015-09-25 16:17:50 +0530338 frappe.throw(_("Please select a Company"))
Rushabh Mehta49dd7be2014-01-28 17:43:10 +0530339
Ankush Menat494bd9e2022-03-28 18:52:46 +0530340 if not party and party_type in ["Customer", "Supplier"]:
341 default_account_name = (
342 "default_receivable_account" if party_type == "Customer" else "default_payable_account"
343 )
Deepesh Garg88648572021-11-12 12:39:30 +0530344
Ankush Menat494bd9e2022-03-28 18:52:46 +0530345 return frappe.get_cached_value("Company", company, default_account_name)
Saurabh0f86d862017-11-10 19:21:09 +0530346
Ankush Menat494bd9e2022-03-28 18:52:46 +0530347 account = frappe.db.get_value(
348 "Party Account", {"parenttype": party_type, "parent": party, "company": company}, "account"
349 )
Saurabh0f86d862017-11-10 19:21:09 +0530350
Ankush Menat494bd9e2022-03-28 18:52:46 +0530351 if not account and party_type in ["Customer", "Supplier"]:
352 party_group_doctype = "Customer Group" if party_type == "Customer" else "Supplier Group"
Nabin Hait9a33bc62018-08-09 10:47:09 +0530353 group = frappe.get_cached_value(party_type, party, scrub(party_group_doctype))
Ankush Menat494bd9e2022-03-28 18:52:46 +0530354 account = frappe.db.get_value(
355 "Party Account",
356 {"parenttype": party_group_doctype, "parent": group, "company": company},
357 "account",
358 )
Rushabh Mehta49dd7be2014-01-28 17:43:10 +0530359
Ankush Menat494bd9e2022-03-28 18:52:46 +0530360 if not account and party_type in ["Customer", "Supplier"]:
361 default_account_name = (
362 "default_receivable_account" if party_type == "Customer" else "default_payable_account"
363 )
364 account = frappe.get_cached_value("Company", company, default_account_name)
Rushabh Mehta364054a2015-02-21 14:39:35 +0530365
Saurabh0f86d862017-11-10 19:21:09 +0530366 existing_gle_currency = get_party_gle_currency(party_type, party, company)
367 if existing_gle_currency:
368 if account:
Nabin Hait9a33bc62018-08-09 10:47:09 +0530369 account_currency = frappe.db.get_value("Account", account, "account_currency", cache=True)
Saurabh0f86d862017-11-10 19:21:09 +0530370 if (account and account_currency != existing_gle_currency) or not account:
Ankush Menat494bd9e2022-03-28 18:52:46 +0530371 account = get_party_gle_account(party_type, party, company)
Rushabh Mehtab92087c2017-01-13 18:53:11 +0530372
Saurabh0f86d862017-11-10 19:21:09 +0530373 return account
Rushabh Mehta49dd7be2014-01-28 17:43:10 +0530374
Ankush Menat494bd9e2022-03-28 18:52:46 +0530375
rohitwaghchaure713cfc72018-09-11 17:40:37 +0530376@frappe.whitelist()
377def get_party_bank_account(party_type, party):
Ankush Menat494bd9e2022-03-28 18:52:46 +0530378 return frappe.db.get_value(
379 "Bank Account", {"party_type": party_type, "party": party, "is_default": 1}
380 )
381
rohitwaghchaure713cfc72018-09-11 17:40:37 +0530382
Anand Doshib20baf82015-09-25 16:17:50 +0530383def get_party_account_currency(party_type, party, company):
384 def generator():
385 party_account = get_party_account(party_type, party, company)
Nabin Hait9a33bc62018-08-09 10:47:09 +0530386 return frappe.db.get_value("Account", party_account, "account_currency", cache=True)
Anand Doshib20baf82015-09-25 16:17:50 +0530387
388 return frappe.local_cache("party_account_currency", (party_type, party, company), generator)
389
Ankush Menat494bd9e2022-03-28 18:52:46 +0530390
Anand Doshi4945b942015-09-30 16:41:15 +0530391def get_party_gle_currency(party_type, party, company):
392 def generator():
Ankush Menat494bd9e2022-03-28 18:52:46 +0530393 existing_gle_currency = frappe.db.sql(
394 """select account_currency from `tabGL Entry`
Anand Doshi4945b942015-09-30 16:41:15 +0530395 where docstatus=1 and company=%(company)s and party_type=%(party_type)s and party=%(party)s
Ankush Menat494bd9e2022-03-28 18:52:46 +0530396 limit 1""",
397 {"company": company, "party_type": party_type, "party": party},
398 )
Anand Doshi4945b942015-09-30 16:41:15 +0530399
400 return existing_gle_currency[0][0] if existing_gle_currency else None
401
Ankush Menat494bd9e2022-03-28 18:52:46 +0530402 return frappe.local_cache(
403 "party_gle_currency", (party_type, party, company), generator, regenerate_if_none=True
404 )
405
Rushabh Mehtab92087c2017-01-13 18:53:11 +0530406
Nabin Hait16d69592016-06-28 16:15:58 +0530407def get_party_gle_account(party_type, party, company):
408 def generator():
Ankush Menat494bd9e2022-03-28 18:52:46 +0530409 existing_gle_account = frappe.db.sql(
410 """select account from `tabGL Entry`
Nabin Hait16d69592016-06-28 16:15:58 +0530411 where docstatus=1 and company=%(company)s and party_type=%(party_type)s and party=%(party)s
Ankush Menat494bd9e2022-03-28 18:52:46 +0530412 limit 1""",
413 {"company": company, "party_type": party_type, "party": party},
414 )
Nabin Hait16d69592016-06-28 16:15:58 +0530415
416 return existing_gle_account[0][0] if existing_gle_account else None
417
Ankush Menat494bd9e2022-03-28 18:52:46 +0530418 return frappe.local_cache(
419 "party_gle_account", (party_type, party, company), generator, regenerate_if_none=True
420 )
421
Anand Doshi4945b942015-09-30 16:41:15 +0530422
Anand Doshid8bc40d2015-10-22 17:54:50 +0530423def validate_party_gle_currency(party_type, party, company, party_account_currency=None):
Anand Doshi4945b942015-09-30 16:41:15 +0530424 """Validate party account currency with existing GL Entry's currency"""
Anand Doshid8bc40d2015-10-22 17:54:50 +0530425 if not party_account_currency:
426 party_account_currency = get_party_account_currency(party_type, party, company)
427
Anand Doshi4945b942015-09-30 16:41:15 +0530428 existing_gle_currency = get_party_gle_currency(party_type, party, company)
429
430 if existing_gle_currency and party_account_currency != existing_gle_currency:
Ankush Menat494bd9e2022-03-28 18:52:46 +0530431 frappe.throw(
432 _(
433 "{0} {1} has accounting entries in currency {2} for company {3}. Please select a receivable or payable account with currency {2}."
434 ).format(
435 frappe.bold(party_type),
436 frappe.bold(party),
437 frappe.bold(existing_gle_currency),
438 frappe.bold(company),
439 ),
440 InvalidAccountCurrency,
441 )
442
Anand Doshi4945b942015-09-30 16:41:15 +0530443
Anand Doshida98ab62015-09-28 15:13:38 +0530444def validate_party_accounts(doc):
Deepesh Garg5a2b5712022-02-18 20:05:49 +0530445 from erpnext.controllers.accounts_controller import validate_account_head
Ankush Menat494bd9e2022-03-28 18:52:46 +0530446
Anand Doshida98ab62015-09-28 15:13:38 +0530447 companies = []
448
449 for account in doc.get("accounts"):
450 if account.company in companies:
Ankush Menat494bd9e2022-03-28 18:52:46 +0530451 frappe.throw(
452 _("There can only be 1 Account per Company in {0} {1}").format(doc.doctype, doc.name),
453 DuplicatePartyAccountError,
454 )
Anand Doshida98ab62015-09-28 15:13:38 +0530455 else:
456 companies.append(account.company)
Anand Doshid8bc40d2015-10-22 17:54:50 +0530457
Ankush Menat494bd9e2022-03-28 18:52:46 +0530458 party_account_currency = frappe.db.get_value(
459 "Account", account.account, "account_currency", cache=True
460 )
hendrikc257ce82019-09-05 16:44:09 +0700461 if frappe.db.get_default("Company"):
Ankush Menat494bd9e2022-03-28 18:52:46 +0530462 company_default_currency = frappe.get_cached_value(
463 "Company", frappe.db.get_default("Company"), "default_currency"
464 )
hendrikc257ce82019-09-05 16:44:09 +0700465 else:
Ankush Menat494bd9e2022-03-28 18:52:46 +0530466 company_default_currency = frappe.db.get_value("Company", account.company, "default_currency")
Anand Doshid8bc40d2015-10-22 17:54:50 +0530467
Deepesh Garg1a2cf5c2020-03-28 21:26:16 +0530468 validate_party_gle_currency(doc.doctype, doc.name, account.company, party_account_currency)
Anand Doshida98ab62015-09-28 15:13:38 +0530469
rohitwaghchaureea092a72017-02-01 12:02:08 +0530470 if doc.get("default_currency") and party_account_currency and company_default_currency:
Ankush Menat494bd9e2022-03-28 18:52:46 +0530471 if (
472 doc.default_currency != party_account_currency
473 and doc.default_currency != company_default_currency
474 ):
475 frappe.throw(
476 _(
477 "Billing currency must be equal to either default company's currency or party account currency"
478 )
479 )
tunde3b4bd372017-08-31 16:28:47 +0100480
Deepesh Garg5a2b5712022-02-18 20:05:49 +0530481 # validate if account is mapped for same company
482 validate_account_head(account.idx, account.account, account.company)
483
rohitwaghchaure62fea032016-03-30 13:24:42 +0530484
Nabin Hait4770a1a2015-07-09 16:35:46 +0530485@frappe.whitelist()
Shreya Shah3a9eec22018-02-16 13:05:21 +0530486def get_due_date(posting_date, party_type, party, company=None, bill_date=None):
tunde3b4bd372017-08-31 16:28:47 +0100487 """Get due date from `Payment Terms Template`"""
Rushabh Mehta49dd7be2014-01-28 17:43:10 +0530488 due_date = None
Shreya Shah3a9eec22018-02-16 13:05:21 +0530489 if (bill_date or posting_date) and party:
490 due_date = bill_date or posting_date
marinationfa085d72020-10-27 13:18:30 +0530491 template_name = get_payment_terms_template(party, party_type, company)
rohitwaghchaure3ffe8962018-07-13 17:40:48 +0530492
tunde3b4bd372017-08-31 16:28:47 +0100493 if template_name:
Ankush Menat494bd9e2022-03-28 18:52:46 +0530494 due_date = get_due_date_from_template(template_name, posting_date, bill_date).strftime(
495 "%Y-%m-%d"
496 )
tundeed86efb2017-09-05 01:15:31 +0100497 else:
498 if party_type == "Supplier":
Nabin Hait9a33bc62018-08-09 10:47:09 +0530499 supplier_group = frappe.get_cached_value(party_type, party, "supplier_group")
500 template_name = frappe.get_cached_value("Supplier Group", supplier_group, "payment_terms")
tundee5973e42017-09-05 18:11:58 +0100501 if template_name:
Ankush Menat494bd9e2022-03-28 18:52:46 +0530502 due_date = get_due_date_from_template(template_name, posting_date, bill_date).strftime(
503 "%Y-%m-%d"
504 )
Shreya Shah3a9eec22018-02-16 13:05:21 +0530505 # If due date is calculated from bill_date, check this condition
506 if getdate(due_date) < getdate(posting_date):
507 due_date = posting_date
Anand Doshi13ae5482014-04-10 18:40:57 +0530508 return due_date
Rushabh Mehta49dd7be2014-01-28 17:43:10 +0530509
Ankush Menat494bd9e2022-03-28 18:52:46 +0530510
Shreya Shah3a9eec22018-02-16 13:05:21 +0530511def get_due_date_from_template(template_name, posting_date, bill_date):
tunde3b4bd372017-08-31 16:28:47 +0100512 """
513 Inspects all `Payment Term`s from the a `Payment Terms Template` and returns the due
514 date after considering all the `Payment Term`s requirements.
515 :param template_name: Name of the `Payment Terms Template`
516 :return: String representing the calculated due date
517 """
Shreya Shah3a9eec22018-02-16 13:05:21 +0530518 due_date = getdate(bill_date or posting_date)
519
Ankush Menat494bd9e2022-03-28 18:52:46 +0530520 template = frappe.get_doc("Payment Terms Template", template_name)
tunde3b4bd372017-08-31 16:28:47 +0100521
522 for term in template.terms:
Ankush Menat494bd9e2022-03-28 18:52:46 +0530523 if term.due_date_based_on == "Day(s) after invoice date":
tunde3b4bd372017-08-31 16:28:47 +0100524 due_date = max(due_date, add_days(due_date, term.credit_days))
Ankush Menat494bd9e2022-03-28 18:52:46 +0530525 elif term.due_date_based_on == "Day(s) after the end of the invoice month":
tunde3b4bd372017-08-31 16:28:47 +0100526 due_date = max(due_date, add_days(get_last_day(due_date), term.credit_days))
527 else:
528 due_date = max(due_date, add_months(get_last_day(due_date), term.credit_months))
tunde3b4bd372017-08-31 16:28:47 +0100529 return due_date
530
Ankush Menat494bd9e2022-03-28 18:52:46 +0530531
532def validate_due_date(
533 posting_date, due_date, party_type, party, company=None, bill_date=None, template_name=None
534):
Nabin Hait4770a1a2015-07-09 16:35:46 +0530535 if getdate(due_date) < getdate(posting_date):
Rohit Waghchaured1a85a32018-11-26 18:42:29 +0530536 frappe.throw(_("Due Date cannot be before Posting / Supplier Invoice Date"))
Nabin Hait4770a1a2015-07-09 16:35:46 +0530537 else:
Ankush Menat494bd9e2022-03-28 18:52:46 +0530538 if not template_name:
539 return
rohitwaghchaure3ffe8962018-07-13 17:40:48 +0530540
Ankush Menat494bd9e2022-03-28 18:52:46 +0530541 default_due_date = get_due_date_from_template(template_name, posting_date, bill_date).strftime(
542 "%Y-%m-%d"
543 )
Saurabhd7897f12018-07-18 17:08:16 +0530544
Anand Doshi0ca587e2015-09-25 16:32:14 +0530545 if not default_due_date:
546 return
547
Nabin Hait93d3c822015-07-10 17:11:58 +0530548 if default_due_date != posting_date and getdate(due_date) > getdate(default_due_date):
Ankush Menat494bd9e2022-03-28 18:52:46 +0530549 is_credit_controller = (
550 frappe.db.get_single_value("Accounts Settings", "credit_controller") in frappe.get_roles()
551 )
Nabin Hait4770a1a2015-07-09 16:35:46 +0530552 if is_credit_controller:
Ankush Menat494bd9e2022-03-28 18:52:46 +0530553 msgprint(
554 _("Note: Due / Reference Date exceeds allowed customer credit days by {0} day(s)").format(
555 date_diff(due_date, default_due_date)
556 )
557 )
Nabin Hait4770a1a2015-07-09 16:35:46 +0530558 else:
Ankush Menat494bd9e2022-03-28 18:52:46 +0530559 frappe.throw(
560 _("Due / Reference Date cannot be after {0}").format(formatdate(default_due_date))
561 )
562
Rushabh Mehta361df892015-09-18 12:59:51 +0530563
Neil Trini Lasrado09f9c962015-08-26 10:41:31 +0530564@frappe.whitelist()
Nabin Hait16a7ec92019-09-05 13:01:15 +0530565def get_address_tax_category(tax_category=None, billing_address=None, shipping_address=None):
Ankush Menat494bd9e2022-03-28 18:52:46 +0530566 addr_tax_category_from = frappe.db.get_single_value(
567 "Accounts Settings", "determine_address_tax_category_from"
568 )
Saif Ur Rehmanfd531a62018-12-29 01:49:11 +0500569 if addr_tax_category_from == "Shipping Address":
570 if shipping_address:
571 tax_category = frappe.db.get_value("Address", shipping_address, "tax_category") or tax_category
572 else:
573 if billing_address:
574 tax_category = frappe.db.get_value("Address", billing_address, "tax_category") or tax_category
575
576 return cstr(tax_category)
Saif Ur Rehman67786682018-12-27 02:11:07 +0500577
Ankush Menat494bd9e2022-03-28 18:52:46 +0530578
Neil Trini Lasrado09f9c962015-08-26 10:41:31 +0530579@frappe.whitelist()
Ankush Menat494bd9e2022-03-28 18:52:46 +0530580def set_taxes(
581 party,
582 party_type,
583 posting_date,
584 company,
585 customer_group=None,
586 supplier_group=None,
587 tax_category=None,
588 billing_address=None,
589 shipping_address=None,
590 use_for_shopping_cart=None,
591):
Chillar Anand915b3432021-09-02 16:44:59 +0530592 from erpnext.accounts.doctype.tax_rule.tax_rule import get_party_details, get_tax_template
Ankush Menat494bd9e2022-03-28 18:52:46 +0530593
594 args = {party_type.lower(): party, "company": company}
Rushabh Mehta361df892015-09-18 12:59:51 +0530595
Saif Ur Rehman67786682018-12-27 02:11:07 +0500596 if tax_category:
Ankush Menat494bd9e2022-03-28 18:52:46 +0530597 args["tax_category"] = tax_category
Saif Ur Rehman67786682018-12-27 02:11:07 +0500598
Rushabh Mehta3c14c5a2017-09-29 13:21:22 +0530599 if customer_group:
Ankush Menat494bd9e2022-03-28 18:52:46 +0530600 args["customer_group"] = customer_group
Rushabh Mehta3c14c5a2017-09-29 13:21:22 +0530601
Zlash6589070782018-04-19 18:37:29 +0530602 if supplier_group:
Ankush Menat494bd9e2022-03-28 18:52:46 +0530603 args["supplier_group"] = supplier_group
Rushabh Mehta3c14c5a2017-09-29 13:21:22 +0530604
Neil Trini Lasrado09f9c962015-08-26 10:41:31 +0530605 if billing_address or shipping_address:
Ankush Menat494bd9e2022-03-28 18:52:46 +0530606 args.update(
607 get_party_details(
608 party, party_type, {"billing_address": billing_address, "shipping_address": shipping_address}
609 )
610 )
Neil Trini Lasrado09f9c962015-08-26 10:41:31 +0530611 else:
612 args.update(get_party_details(party, party_type))
Rushabh Mehta361df892015-09-18 12:59:51 +0530613
Anand Doshi2f957f22016-04-08 17:36:10 +0530614 if party_type in ("Customer", "Lead"):
Neil Trini Lasrado810bd352015-08-21 15:04:57 +0530615 args.update({"tax_type": "Sales"})
Anand Doshi2f957f22016-04-08 17:36:10 +0530616
Ankush Menat494bd9e2022-03-28 18:52:46 +0530617 if party_type == "Lead":
618 args["customer"] = None
619 del args["lead"]
Neil Trini Lasrado810bd352015-08-21 15:04:57 +0530620 else:
621 args.update({"tax_type": "Purchase"})
Rushabh Mehta361df892015-09-18 12:59:51 +0530622
Saurabh957e7a32015-09-11 15:44:06 +0530623 if use_for_shopping_cart:
Saurabh957e7a32015-09-11 15:44:06 +0530624 args.update({"use_for_shopping_cart": use_for_shopping_cart})
Rushabh Mehta361df892015-09-18 12:59:51 +0530625
626 return get_tax_template(posting_date, args)
shreyas29b565f2016-01-25 17:30:49 +0530627
tunde400d0462017-08-31 13:44:57 +0100628
629@frappe.whitelist()
marinationfa085d72020-10-27 13:18:30 +0530630def get_payment_terms_template(party_name, party_type, company=None):
Nabin Haitcfa9d1a2018-01-29 16:07:21 +0530631 if party_type not in ("Customer", "Supplier"):
632 return
tunde400d0462017-08-31 13:44:57 +0100633 template = None
Ankush Menat494bd9e2022-03-28 18:52:46 +0530634 if party_type == "Customer":
635 customer = frappe.get_cached_value(
636 "Customer", party_name, fieldname=["payment_terms", "customer_group"], as_dict=1
637 )
Nabin Haitcfa9d1a2018-01-29 16:07:21 +0530638 template = customer.payment_terms
639
640 if not template and customer.customer_group:
Ankush Menat494bd9e2022-03-28 18:52:46 +0530641 template = frappe.get_cached_value("Customer Group", customer.customer_group, "payment_terms")
Nabin Haitcfa9d1a2018-01-29 16:07:21 +0530642 else:
Ankush Menat494bd9e2022-03-28 18:52:46 +0530643 supplier = frappe.get_cached_value(
644 "Supplier", party_name, fieldname=["payment_terms", "supplier_group"], as_dict=1
645 )
Nabin Haitcfa9d1a2018-01-29 16:07:21 +0530646 template = supplier.payment_terms
Zlash6589070782018-04-19 18:37:29 +0530647 if not template and supplier.supplier_group:
Ankush Menat494bd9e2022-03-28 18:52:46 +0530648 template = frappe.get_cached_value("Supplier Group", supplier.supplier_group, "payment_terms")
Nabin Haitcfa9d1a2018-01-29 16:07:21 +0530649
650 if not template and company:
Ankush Menat494bd9e2022-03-28 18:52:46 +0530651 template = frappe.get_cached_value("Company", company, fieldname="payment_terms")
tunde400d0462017-08-31 13:44:57 +0100652 return template
653
Ankush Menat494bd9e2022-03-28 18:52:46 +0530654
shreyaseba9ca42016-01-26 14:56:52 +0530655def validate_party_frozen_disabled(party_type, party_name):
Subin Tomb8845b92021-07-30 16:30:18 +0530656
657 if frappe.flags.ignore_party_validation:
658 return
659
shreyas79872bf2016-01-26 13:57:06 +0530660 if party_type and party_name:
KanchanChauhanfbaa6192017-01-30 15:15:58 +0530661 if party_type in ("Customer", "Supplier"):
Nabin Hait9a33bc62018-08-09 10:47:09 +0530662 party = frappe.get_cached_value(party_type, party_name, ["is_frozen", "disabled"], as_dict=True)
deepeshgarg007737ec6b2019-10-20 17:36:36 +0530663 if party.disabled:
664 frappe.throw(_("{0} {1} is disabled").format(party_type, party_name), PartyDisabled)
665 elif party.get("is_frozen"):
Ankush Menat494bd9e2022-03-28 18:52:46 +0530666 frozen_accounts_modifier = frappe.db.get_single_value(
667 "Accounts Settings", "frozen_accounts_modifier"
668 )
KanchanChauhanfbaa6192017-01-30 15:15:58 +0530669 if not frozen_accounts_modifier in frappe.get_roles():
670 frappe.throw(_("{0} {1} is frozen").format(party_type, party_name), PartyFrozen)
671
672 elif party_type == "Employee":
Rucha Mahabala38147a2021-06-12 13:33:21 +0530673 if frappe.db.get_value("Employee", party_name, "status") != "Active":
Kanchan Chauhan95108ac2017-04-11 15:55:34 +0530674 frappe.msgprint(_("{0} {1} is not active").format(party_type, party_name), alert=True)
Rushabh Mehta15a7f212016-04-14 17:30:40 +0530675
Ankush Menat494bd9e2022-03-28 18:52:46 +0530676
Rushabh Mehta15a7f212016-04-14 17:30:40 +0530677def get_timeline_data(doctype, name):
Ankush Menat494bd9e2022-03-28 18:52:46 +0530678 """returns timeline data for the past one year"""
Rushabh Mehta15a7f212016-04-14 17:30:40 +0530679 from frappe.desk.form.load import get_communication_data
mbauskare7b87ad2017-02-16 13:12:29 +0530680
681 out = {}
Ankush Menat494bd9e2022-03-28 18:52:46 +0530682 fields = "creation, count(*)"
683 after = add_years(None, -1).strftime("%Y-%m-%d")
684 group_by = "group by Date(creation)"
Zarrar58200182018-05-30 11:56:23 +0530685
Ankush Menat494bd9e2022-03-28 18:52:46 +0530686 data = get_communication_data(
687 doctype,
688 name,
689 after=after,
690 group_by="group by creation",
691 fields="C.creation as creation, count(C.name)",
692 as_dict=False,
693 )
Zarrar58200182018-05-30 11:56:23 +0530694
695 # fetch and append data from Activity Log
Ankush Menat494bd9e2022-03-28 18:52:46 +0530696 data += frappe.db.sql(
697 """select {fields}
Zarrar58200182018-05-30 11:56:23 +0530698 from `tabActivity Log`
rohitwaghchaure52107612020-05-05 12:12:33 +0530699 where (reference_doctype=%(doctype)s and reference_name=%(name)s)
700 or (timeline_doctype in (%(doctype)s) and timeline_name=%(name)s)
701 or (reference_doctype in ("Quotation", "Opportunity") and timeline_name=%(name)s)
Zarrar58200182018-05-30 11:56:23 +0530702 and status!='Success' and creation > {after}
703 {group_by} order by creation desc
Ankush Menat494bd9e2022-03-28 18:52:46 +0530704 """.format(
705 fields=fields, group_by=group_by, after=after
706 ),
707 {"doctype": doctype, "name": name},
708 as_dict=False,
709 )
mbauskare7b87ad2017-02-16 13:12:29 +0530710
711 timeline_items = dict(data)
712
Ankush Menat8fe5feb2021-11-04 19:48:32 +0530713 for date, count in timeline_items.items():
mbauskare7b87ad2017-02-16 13:12:29 +0530714 timestamp = get_timestamp(date)
Ankush Menat494bd9e2022-03-28 18:52:46 +0530715 out.update({timestamp: count})
mbauskare7b87ad2017-02-16 13:12:29 +0530716
Nabin Hait2d79a642017-05-24 12:41:14 +0530717 return out
Rushabh Mehta919a74a2017-06-22 16:37:04 +0530718
Ankush Menat494bd9e2022-03-28 18:52:46 +0530719
deepeshgarg00712f5cef2018-12-25 16:06:19 +0530720def get_dashboard_info(party_type, party, loyalty_program=None):
Nabin Hait2d79a642017-05-24 12:41:14 +0530721 current_fiscal_year = get_fiscal_year(nowdate(), as_dict=True)
Rushabh Mehta919a74a2017-06-22 16:37:04 +0530722
Ankush Menat494bd9e2022-03-28 18:52:46 +0530723 doctype = "Sales Invoice" if party_type == "Customer" else "Purchase Invoice"
Rushabh Mehta919a74a2017-06-22 16:37:04 +0530724
Ankush Menat494bd9e2022-03-28 18:52:46 +0530725 companies = frappe.get_all(
726 doctype, filters={"docstatus": 1, party_type.lower(): party}, distinct=1, fields=["company"]
727 )
Rushabh Mehta919a74a2017-06-22 16:37:04 +0530728
deepeshgarg007920dc142018-11-23 10:17:28 +0530729 company_wise_info = []
730
Ankush Menat494bd9e2022-03-28 18:52:46 +0530731 company_wise_grand_total = frappe.get_all(
732 doctype,
deepeshgarg007ee05e352018-11-29 16:24:28 +0530733 filters={
Ankush Menat494bd9e2022-03-28 18:52:46 +0530734 "docstatus": 1,
deepeshgarg007ee05e352018-11-29 16:24:28 +0530735 party_type.lower(): party,
Ankush Menat494bd9e2022-03-28 18:52:46 +0530736 "posting_date": (
737 "between",
738 [current_fiscal_year.year_start_date, current_fiscal_year.year_end_date],
739 ),
740 },
741 group_by="company",
742 fields=[
743 "company",
744 "sum(grand_total) as grand_total",
745 "sum(base_grand_total) as base_grand_total",
746 ],
747 )
deepeshgarg007920dc142018-11-23 10:17:28 +0530748
deepeshgarg007a1d015c2018-12-26 11:01:02 +0530749 loyalty_point_details = []
750
deepeshgarg00712f5cef2018-12-25 16:06:19 +0530751 if party_type == "Customer":
Ankush Menat494bd9e2022-03-28 18:52:46 +0530752 loyalty_point_details = frappe._dict(
753 frappe.get_all(
754 "Loyalty Point Entry",
755 filters={
756 "customer": party,
757 "expiry_date": (">=", getdate()),
deepeshgarg00712f5cef2018-12-25 16:06:19 +0530758 },
759 group_by="company",
760 fields=["company", "sum(loyalty_points) as loyalty_points"],
Ankush Menat494bd9e2022-03-28 18:52:46 +0530761 as_list=1,
762 )
763 )
deepeshgarg00712f5cef2018-12-25 16:06:19 +0530764
deepeshgarg007f31caff2018-11-27 15:04:12 +0530765 company_wise_billing_this_year = frappe._dict()
766
767 for d in company_wise_grand_total:
768 company_wise_billing_this_year.setdefault(
Ankush Menat494bd9e2022-03-28 18:52:46 +0530769 d.company, {"grand_total": d.grand_total, "base_grand_total": d.base_grand_total}
770 )
deepeshgarg007f31caff2018-11-27 15:04:12 +0530771
Ankush Menat494bd9e2022-03-28 18:52:46 +0530772 company_wise_total_unpaid = frappe._dict(
773 frappe.db.sql(
774 """
deepeshgarg007920dc142018-11-23 10:17:28 +0530775 select company, sum(debit_in_account_currency) - sum(credit_in_account_currency)
Nabin Hait24f0b132017-05-24 13:01:26 +0530776 from `tabGL Entry`
deepeshgarg007920dc142018-11-23 10:17:28 +0530777 where party_type = %s and party=%s
Deepesh Garg802e63a2021-06-28 11:24:32 +0530778 and is_cancelled = 0
Ankush Menat494bd9e2022-03-28 18:52:46 +0530779 group by company""",
780 (party_type, party),
781 )
782 )
Nabin Hait2d79a642017-05-24 12:41:14 +0530783
deepeshgarg007920dc142018-11-23 10:17:28 +0530784 for d in companies:
Ankush Menat494bd9e2022-03-28 18:52:46 +0530785 company_default_currency = frappe.db.get_value("Company", d.company, "default_currency")
deepeshgarg007920dc142018-11-23 10:17:28 +0530786 party_account_currency = get_party_account_currency(party_type, party, d.company)
Rushabh Mehta919a74a2017-06-22 16:37:04 +0530787
Ankush Menat494bd9e2022-03-28 18:52:46 +0530788 if party_account_currency == company_default_currency:
789 billing_this_year = flt(
790 company_wise_billing_this_year.get(d.company, {}).get("base_grand_total")
791 )
deepeshgarg007920dc142018-11-23 10:17:28 +0530792 else:
Ankush Menat494bd9e2022-03-28 18:52:46 +0530793 billing_this_year = flt(company_wise_billing_this_year.get(d.company, {}).get("grand_total"))
deepeshgarg007920dc142018-11-23 10:17:28 +0530794
795 total_unpaid = flt(company_wise_total_unpaid.get(d.company))
796
deepeshgarg00712f5cef2018-12-25 16:06:19 +0530797 if loyalty_point_details:
798 loyalty_points = loyalty_point_details.get(d.company)
799
deepeshgarg007920dc142018-11-23 10:17:28 +0530800 info = {}
801 info["billing_this_year"] = flt(billing_this_year) if billing_this_year else 0
802 info["currency"] = party_account_currency
803 info["total_unpaid"] = flt(total_unpaid) if total_unpaid else 0
804 info["company"] = d.company
805
deepeshgarg00712f5cef2018-12-25 16:06:19 +0530806 if party_type == "Customer" and loyalty_point_details:
807 info["loyalty_points"] = loyalty_points
808
deepeshgarg007920dc142018-11-23 10:17:28 +0530809 if party_type == "Supplier":
810 info["total_unpaid"] = -1 * info["total_unpaid"]
811
812 company_wise_info.append(info)
813
814 return company_wise_info
tundebabzy40a02762017-10-25 07:54:34 +0100815
Ankush Menat494bd9e2022-03-28 18:52:46 +0530816
tundebabzy40a02762017-10-25 07:54:34 +0100817def get_party_shipping_address(doctype, name):
818 """
819 Returns an Address name (best guess) for the given doctype and name for which `address_type == 'Shipping'` is true.
820 and/or `is_shipping_address = 1`.
821
822 It returns an empty string if there is no matching record.
823
824 :param doctype: Party Doctype
825 :param name: Party name
826 :return: String
827 """
828 out = frappe.db.sql(
Ankush Menat494bd9e2022-03-28 18:52:46 +0530829 "SELECT dl.parent "
830 "from `tabDynamic Link` dl join `tabAddress` ta on dl.parent=ta.name "
831 "where "
832 "dl.link_doctype=%s "
833 "and dl.link_name=%s "
tundebabzy40a02762017-10-25 07:54:34 +0100834 'and dl.parenttype="Address" '
Ankush Menat494bd9e2022-03-28 18:52:46 +0530835 "and ifnull(ta.disabled, 0) = 0 and"
tundebabzy40a02762017-10-25 07:54:34 +0100836 '(ta.address_type="Shipping" or ta.is_shipping_address=1) '
Ankush Menat494bd9e2022-03-28 18:52:46 +0530837 "order by ta.is_shipping_address desc, ta.address_type desc limit 1",
838 (doctype, name),
tundebabzy40a02762017-10-25 07:54:34 +0100839 )
840 if out:
841 return out[0][0]
842 else:
Ankush Menat494bd9e2022-03-28 18:52:46 +0530843 return ""
Rohit Waghchaureaffeb3d2019-01-15 17:38:31 +0530844
Ankush Menat494bd9e2022-03-28 18:52:46 +0530845
846def get_partywise_advanced_payment_amount(
847 party_type, posting_date=None, future_payment=0, company=None
848):
Rohit Waghchaure4ed7d032019-03-25 15:37:25 +0530849 cond = "1=1"
850 if posting_date:
Deepesh Garged2c1802020-05-27 12:46:12 +0530851 if future_payment:
Ankush Menat494bd9e2022-03-28 18:52:46 +0530852 cond = "posting_date <= '{0}' OR DATE(creation) <= '{0}' " "".format(posting_date)
Deepesh Garged2c1802020-05-27 12:46:12 +0530853 else:
UrvashiKishnani810a3612021-03-02 08:20:03 +0400854 cond = "posting_date <= '{0}'".format(posting_date)
Deepesh Garged2c1802020-05-27 12:46:12 +0530855
Saqib39805912020-05-01 18:15:13 +0530856 if company:
UrvashiKishnani810a3612021-03-02 08:20:03 +0400857 cond += "and company = {0}".format(frappe.db.escape(company))
Rohit Waghchaure4ed7d032019-03-25 15:37:25 +0530858
Ankush Menat494bd9e2022-03-28 18:52:46 +0530859 data = frappe.db.sql(
860 """ SELECT party, sum({0}) as amount
UrvashiKishnani810a3612021-03-02 08:20:03 +0400861 FROM `tabGL Entry`
Rohit Waghchaure1a6e0152019-03-19 15:06:01 +0530862 WHERE
UrvashiKishnani810a3612021-03-02 08:20:03 +0400863 party_type = %s and against_voucher is null
864 and is_cancelled = 0
Ankush Menat494bd9e2022-03-28 18:52:46 +0530865 and {1} GROUP BY party""".format(
866 ("credit") if party_type == "Customer" else "debit", cond
867 ),
868 party_type,
869 )
Rohit Waghchaureaffeb3d2019-01-15 17:38:31 +0530870
871 if data:
hendrikc257ce82019-09-05 16:44:09 +0700872 return frappe._dict(data)
Ronel Cabrerafcb54762019-11-18 17:00:07 +0800873
Ankush Menat494bd9e2022-03-28 18:52:46 +0530874
Deepesh Gargcf9347d2020-03-31 17:28:43 +0530875def get_default_contact(doctype, name):
876 """
Ankush Menat494bd9e2022-03-28 18:52:46 +0530877 Returns default contact for the given doctype and name.
878 Can be ordered by `contact_type` to either is_primary_contact or is_billing_contact.
Ronel Cabrerafcb54762019-11-18 17:00:07 +0800879 """
Ankush Menat494bd9e2022-03-28 18:52:46 +0530880 out = frappe.db.sql(
881 """
Ronel Cabrerafcb54762019-11-18 17:00:07 +0800882 SELECT dl.parent, c.is_primary_contact, c.is_billing_contact
883 FROM `tabDynamic Link` dl
884 INNER JOIN tabContact c ON c.name = dl.parent
Deepesh Gargcf9347d2020-03-31 17:28:43 +0530885 WHERE
Ronel Cabrerafcb54762019-11-18 17:00:07 +0800886 dl.link_doctype=%s AND
887 dl.link_name=%s AND
888 dl.parenttype = "Contact"
Deepesh Gargcf9347d2020-03-31 17:28:43 +0530889 ORDER BY is_primary_contact DESC, is_billing_contact DESC
Ankush Menat494bd9e2022-03-28 18:52:46 +0530890 """,
891 (doctype, name),
892 )
Ronel Cabrerafcb54762019-11-18 17:00:07 +0800893 if out:
894 try:
895 return out[0][0]
Ankush Menat694ae812021-09-01 14:40:56 +0530896 except Exception:
Ronel Cabrerafcb54762019-11-18 17:00:07 +0800897 return None
898 else:
Faris Ansari64f01bd2020-04-14 11:51:48 +0530899 return None