blob: ccd54b344fd87e479da4199aa180521e48e441e5 [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
Sagar Vora5c066202023-03-13 14:02:50 +000035PURCHASE_TRANSACTION_TYPES = {"Purchase Order", "Purchase Receipt", "Purchase Invoice"}
36SALES_TRANSACTION_TYPES = {
37 "Quotation",
38 "Sales Order",
39 "Delivery Note",
40 "Sales Invoice",
41 "POS Invoice",
42}
43TRANSACTION_TYPES = PURCHASE_TRANSACTION_TYPES | SALES_TRANSACTION_TYPES
44
Rushabh Mehta49dd7be2014-01-28 17:43:10 +053045
Ankush Menat494bd9e2022-03-28 18:52:46 +053046class DuplicatePartyAccountError(frappe.ValidationError):
47 pass
48
Nabin Hait16099332015-09-03 16:03:07 +053049
Rushabh Mehta793ba6b2014-02-14 15:47:51 +053050@frappe.whitelist()
Ankush Menat494bd9e2022-03-28 18:52:46 +053051def get_party_details(
52 party=None,
53 account=None,
54 party_type="Customer",
55 company=None,
56 posting_date=None,
57 bill_date=None,
58 price_list=None,
59 currency=None,
60 doctype=None,
61 ignore_permissions=False,
62 fetch_payment_terms_template=True,
63 party_address=None,
64 company_address=None,
65 shipping_address=None,
66 pos_profile=None,
67):
Anand Doshi201dbbd2014-02-20 15:21:53 +053068
Rushabh Mehtad7a5b732015-04-01 23:38:13 +053069 if not party:
70 return {}
Nabin Hait5ef121b2015-06-08 12:26:52 +053071 if not frappe.db.exists(party_type, party):
72 frappe.throw(_("{0}: {1} does not exists").format(party_type, party))
Ankush Menat494bd9e2022-03-28 18:52:46 +053073 return _get_party_details(
74 party,
75 account,
76 party_type,
77 company,
78 posting_date,
79 bill_date,
80 price_list,
81 currency,
82 doctype,
83 ignore_permissions,
84 fetch_payment_terms_template,
85 party_address,
86 company_address,
87 shipping_address,
88 pos_profile,
89 )
Anand Doshi201dbbd2014-02-20 15:21:53 +053090
Ankush Menat494bd9e2022-03-28 18:52:46 +053091
92def _get_party_details(
93 party=None,
94 account=None,
95 party_type="Customer",
96 company=None,
97 posting_date=None,
98 bill_date=None,
99 price_list=None,
100 currency=None,
101 doctype=None,
102 ignore_permissions=False,
103 fetch_payment_terms_template=True,
104 party_address=None,
105 company_address=None,
106 shipping_address=None,
107 pos_profile=None,
108):
109 party_details = frappe._dict(
110 set_account_and_due_date(party, account, party_type, company, posting_date, bill_date, doctype)
111 )
Deepesh Garg6e2c13f2019-12-10 15:55:05 +0530112 party = party_details[party_type.lower()]
Rushabh Mehtacc008cc2014-02-03 16:14:56 +0530113
Ankush Menat494bd9e2022-03-28 18:52:46 +0530114 if not ignore_permissions and not (
115 frappe.has_permission(party_type, "read", party)
116 or frappe.has_permission(party_type, "select", party)
117 ):
Rushabh Mehta2d708872015-11-27 11:35:35 +0530118 frappe.throw(_("Not permitted for {0}").format(party), frappe.PermissionError)
Rushabh Mehtacc008cc2014-02-03 16:14:56 +0530119
Nabin Hait365ae272014-04-03 17:38:54 +0530120 party = frappe.get_doc(party_type, party)
Deepesh Gargb72cdb42022-01-21 18:00:35 +0530121 currency = party.get("default_currency") or currency or get_company_currency(company)
Rushabh Mehtacc008cc2014-02-03 16:14:56 +0530122
Ankush Menat494bd9e2022-03-28 18:52:46 +0530123 party_address, shipping_address = set_address_details(
124 party_details,
125 party,
126 party_type,
127 doctype,
128 company,
129 party_address,
130 company_address,
131 shipping_address,
132 )
Deepesh Gargcf9347d2020-03-31 17:28:43 +0530133 set_contact_details(party_details, party, party_type)
Deepesh Garg6e2c13f2019-12-10 15:55:05 +0530134 set_other_values(party_details, party, party_type)
135 set_price_list(party_details, party, party_type, price_list, pos_profile)
Anand Doshi13ae5482014-04-10 18:40:57 +0530136
Ankush Menat494bd9e2022-03-28 18:52:46 +0530137 tax_template = set_taxes(
138 party.name,
139 party_type,
140 posting_date,
141 company,
142 customer_group=party_details.customer_group,
143 supplier_group=party_details.supplier_group,
144 tax_category=party_details.tax_category,
145 billing_address=party_address,
146 shipping_address=shipping_address,
147 )
Deepesh Gargf12be302021-11-30 20:34:53 +0530148
149 if tax_template:
Ankush Menat494bd9e2022-03-28 18:52:46 +0530150 party_details["taxes_and_charges"] = tax_template
rohitwaghchaure3ffe8962018-07-13 17:40:48 +0530151
Deepesh Gargbcf56e62021-08-06 23:53:16 +0530152 if cint(fetch_payment_terms_template):
Ankush Menat494bd9e2022-03-28 18:52:46 +0530153 party_details["payment_terms_template"] = get_payment_terms_template(
154 party.name, party_type, company
155 )
Rushabh Mehtacc008cc2014-02-03 16:14:56 +0530156
Deepesh Garg6e2c13f2019-12-10 15:55:05 +0530157 if not party_details.get("currency"):
158 party_details["currency"] = currency
Anand Doshi13ae5482014-04-10 18:40:57 +0530159
Rushabh Mehtacc008cc2014-02-03 16:14:56 +0530160 # sales team
Ankush Menat494bd9e2022-03-28 18:52:46 +0530161 if party_type == "Customer":
162 party_details["sales_team"] = [
163 {
164 "sales_person": d.sales_person,
165 "allocated_percentage": d.allocated_percentage or None,
166 "commission_rate": d.commission_rate,
167 }
168 for d in party.get("sales_team")
169 ]
Anand Doshi13ae5482014-04-10 18:40:57 +0530170
Zarrar7f8024c2018-08-01 17:45:05 +0530171 # supplier tax withholding category
172 if party_type == "Supplier" and party:
Ankush Menat494bd9e2022-03-28 18:52:46 +0530173 party_details["supplier_tds"] = frappe.get_value(
174 party_type, party.name, "tax_withholding_category"
175 )
Zarrar7f8024c2018-08-01 17:45:05 +0530176
Vishal Dhayagude7aafc902023-03-28 16:48:03 +0530177 if not party_details.get("tax_category") and pos_profile:
178 party_details["tax_category"] = frappe.get_value("POS Profile", pos_profile, "tax_category")
179
Deepesh Garg6e2c13f2019-12-10 15:55:05 +0530180 return party_details
Rushabh Mehtacc008cc2014-02-03 16:14:56 +0530181
Ankush Menat494bd9e2022-03-28 18:52:46 +0530182
183def set_address_details(
184 party_details,
185 party,
186 party_type,
187 doctype=None,
188 company=None,
189 party_address=None,
190 company_address=None,
191 shipping_address=None,
192):
193 billing_address_field = (
194 "customer_address" if party_type == "Lead" else party_type.lower() + "_address"
195 )
196 party_details[billing_address_field] = party_address or get_default_address(
197 party_type, party.name
198 )
Nabin Hait7eba1a32017-10-02 15:59:27 +0530199 if doctype:
Ankush Menat494bd9e2022-03-28 18:52:46 +0530200 party_details.update(
201 get_fetch_values(doctype, billing_address_field, party_details[billing_address_field])
202 )
Rushabh Mehtacc008cc2014-02-03 16:14:56 +0530203 # address display
Deepesh Garg6e2c13f2019-12-10 15:55:05 +0530204 party_details.address_display = get_address_display(party_details[billing_address_field])
Nabin Hait9d1f0772014-02-19 17:43:24 +0530205 # shipping address
206 if party_type in ["Customer", "Lead"]:
Ankush Menat494bd9e2022-03-28 18:52:46 +0530207 party_details.shipping_address_name = shipping_address or get_party_shipping_address(
208 party_type, party.name
209 )
Deepesh Garg6e2c13f2019-12-10 15:55:05 +0530210 party_details.shipping_address = get_address_display(party_details["shipping_address_name"])
Nabin Hait7eba1a32017-10-02 15:59:27 +0530211 if doctype:
Ankush Menat494bd9e2022-03-28 18:52:46 +0530212 party_details.update(
213 get_fetch_values(doctype, "shipping_address_name", party_details.shipping_address_name)
214 )
Rushabh Mehta919a74a2017-06-22 16:37:04 +0530215
Deepesh Garg6e2c13f2019-12-10 15:55:05 +0530216 if company_address:
Sagar Voraa3625b32022-07-29 12:41:40 +0530217 party_details.company_address = company_address
Deepesh Garg6e2c13f2019-12-10 15:55:05 +0530218 else:
219 party_details.update(get_company_address(company))
Shreya Shah4fa600a2018-06-05 11:27:53 +0530220
Sagar Vora5c066202023-03-13 14:02:50 +0000221 if doctype in SALES_TRANSACTION_TYPES and party_details.company_address:
222 party_details.update(get_fetch_values(doctype, "company_address", party_details.company_address))
Shreya Shah4fa600a2018-06-05 11:27:53 +0530223
Sagar Vora5c066202023-03-13 14:02:50 +0000224 if doctype in PURCHASE_TRANSACTION_TYPES:
Sagar Voraa3625b32022-07-29 12:41:40 +0530225 if shipping_address:
Ankush Menat494bd9e2022-03-28 18:52:46 +0530226 party_details.update(
Sagar Voraa3625b32022-07-29 12:41:40 +0530227 shipping_address=shipping_address,
228 shipping_address_display=get_address_display(shipping_address),
229 **get_fetch_values(doctype, "shipping_address", shipping_address)
Ankush Menat494bd9e2022-03-28 18:52:46 +0530230 )
Sagar Voraa3625b32022-07-29 12:41:40 +0530231
232 if party_details.company_address:
233 # billing address
234 party_details.update(
235 billing_address=party_details.company_address,
236 billing_address_display=(
237 party_details.company_address_display or get_address_display(party_details.company_address)
238 ),
239 **get_fetch_values(doctype, "billing_address", party_details.company_address)
240 )
241
242 # shipping address - if not already set
243 if not party_details.shipping_address:
244 party_details.update(
245 shipping_address=party_details.billing_address,
246 shipping_address_display=party_details.billing_address_display,
247 **get_fetch_values(doctype, "shipping_address", party_details.billing_address)
248 )
249
Sagar Vora5c066202023-03-13 14:02:50 +0000250 party_address, shipping_address = (
251 party_details.get(billing_address_field),
252 party_details.shipping_address_name,
253 )
254
255 party_details["tax_category"] = get_address_tax_category(
256 party.get("tax_category"),
257 party_address,
258 shipping_address if party_type != "Supplier" else party_address,
259 )
260
261 if doctype in TRANSACTION_TYPES:
Sagar Vora17ef3c92023-04-04 17:49:50 +0530262 # required to set correct region
263 frappe.flags.company = company
Deepesh Garg6e2c13f2019-12-10 15:55:05 +0530264 get_regional_address_details(party_details, doctype, company)
265
Sagar Vora5c066202023-03-13 14:02:50 +0000266 return party_address, shipping_address
Saif Ur Rehman67786682018-12-27 02:11:07 +0500267
Ankush Menat494bd9e2022-03-28 18:52:46 +0530268
Shreya Shah4fa600a2018-06-05 11:27:53 +0530269@erpnext.allow_regional
Deepesh Garg6e2c13f2019-12-10 15:55:05 +0530270def get_regional_address_details(party_details, doctype, company):
Shreya Shah4fa600a2018-06-05 11:27:53 +0530271 pass
Anand Doshi13ae5482014-04-10 18:40:57 +0530272
Ankush Menat494bd9e2022-03-28 18:52:46 +0530273
Deepesh Gargcf9347d2020-03-31 17:28:43 +0530274def set_contact_details(party_details, party, party_type):
275 party_details.contact_person = get_default_contact(party_type, party.name)
Anand Doshi13ae5482014-04-10 18:40:57 +0530276
Deepesh Garg6e2c13f2019-12-10 15:55:05 +0530277 if not party_details.contact_person:
Ankush Menat494bd9e2022-03-28 18:52:46 +0530278 party_details.update(
279 {
280 "contact_person": None,
281 "contact_display": None,
282 "contact_email": None,
283 "contact_mobile": None,
284 "contact_phone": None,
285 "contact_designation": None,
286 "contact_department": None,
287 }
288 )
Neil Trini Lasradofe2ffae2015-07-08 18:16:51 +0530289 else:
Deepesh Garg6e2c13f2019-12-10 15:55:05 +0530290 party_details.update(get_contact_details(party_details.contact_person))
Rushabh Mehtacc008cc2014-02-03 16:14:56 +0530291
Ankush Menat494bd9e2022-03-28 18:52:46 +0530292
Deepesh Garg6e2c13f2019-12-10 15:55:05 +0530293def set_other_values(party_details, party, party_type):
Rushabh Mehtacc008cc2014-02-03 16:14:56 +0530294 # copy
ChillarAnand9ace7d62022-03-07 16:53:59 +0530295 if party_type == "Customer":
saurabh8e499512016-02-19 11:08:45 +0530296 to_copy = ["customer_name", "customer_group", "territory", "language"]
Rushabh Mehta49dd7be2014-01-28 17:43:10 +0530297 else:
Zlash6589070782018-04-19 18:37:29 +0530298 to_copy = ["supplier_name", "supplier_group", "language"]
Rushabh Mehtacc008cc2014-02-03 16:14:56 +0530299 for f in to_copy:
Deepesh Garg6e2c13f2019-12-10 15:55:05 +0530300 party_details[f] = party.get(f)
Anand Doshi13ae5482014-04-10 18:40:57 +0530301
Rushabh Mehtacc008cc2014-02-03 16:14:56 +0530302 # fields prepended with default in Customer doctype
Ankush Menat494bd9e2022-03-28 18:52:46 +0530303 for f in ["currency"] + (
304 ["sales_partner", "commission_rate"] if party_type == "Customer" else []
305 ):
Rushabh Mehtacc008cc2014-02-03 16:14:56 +0530306 if party.get("default_" + f):
Deepesh Garg6e2c13f2019-12-10 15:55:05 +0530307 party_details[f] = party.get("default_" + f)
Rushabh Mehtacc008cc2014-02-03 16:14:56 +0530308
Ankush Menat494bd9e2022-03-28 18:52:46 +0530309
Rushabh Mehta72fbf902015-09-17 18:29:44 +0530310def get_default_price_list(party):
311 """Return default price list for party (Document object)"""
Nabin Hait34c551d2019-07-03 10:34:31 +0530312 if party.get("default_price_list"):
Rushabh Mehta72fbf902015-09-17 18:29:44 +0530313 return party.default_price_list
314
315 if party.doctype == "Customer":
Daizy Modi27df4552022-11-03 13:38:48 +0530316 return frappe.get_cached_value("Customer Group", party.customer_group, "default_price_list")
Rushabh Mehta72fbf902015-09-17 18:29:44 +0530317
Rushabh Mehta72fbf902015-09-17 18:29:44 +0530318
Deepesh Garg6e2c13f2019-12-10 15:55:05 +0530319def set_price_list(party_details, party, party_type, given_price_list, pos=None):
Anand Doshi13ae5482014-04-10 18:40:57 +0530320 # price list
Ankush Menat494bd9e2022-03-28 18:52:46 +0530321 price_list = get_permitted_documents("Price List")
rohitwaghchaure52107612020-05-05 12:12:33 +0530322
Faris Ansari64f01bd2020-04-14 11:51:48 +0530323 # if there is only one permitted document based on user permissions, set it
324 if price_list and len(price_list) == 1:
Suraj Shettydcc90e32018-05-04 17:52:57 +0530325 price_list = price_list[0]
Ankush Menat494bd9e2022-03-28 18:52:46 +0530326 elif pos and party_type == "Customer":
327 customer_price_list = frappe.get_value("Customer", party.name, "default_price_list")
deepeshgarg007c48efab2019-01-24 17:15:38 +0530328
329 if customer_price_list:
330 price_list = customer_price_list
331 else:
Ankush Menat494bd9e2022-03-28 18:52:46 +0530332 pos_price_list = frappe.get_value("POS Profile", pos, "selling_price_list")
deepeshgarg0071f9a6fe2019-01-25 11:53:55 +0530333 price_list = pos_price_list or given_price_list
Suraj Shettydcc90e32018-05-04 17:52:57 +0530334 else:
335 price_list = get_default_price_list(party) or given_price_list
Rushabh Mehtacc008cc2014-02-03 16:14:56 +0530336
337 if price_list:
Ankush Menat494bd9e2022-03-28 18:52:46 +0530338 party_details.price_list_currency = frappe.db.get_value(
339 "Price List", price_list, "currency", cache=True
340 )
Anand Doshi13ae5482014-04-10 18:40:57 +0530341
Ankush Menat494bd9e2022-03-28 18:52:46 +0530342 party_details[
343 "selling_price_list" if party.doctype == "Customer" else "buying_price_list"
344 ] = price_list
Anand Doshi13ae5482014-04-10 18:40:57 +0530345
Rushabh Mehtacc008cc2014-02-03 16:14:56 +0530346
Ankush Menat494bd9e2022-03-28 18:52:46 +0530347def set_account_and_due_date(
348 party, account, party_type, company, posting_date, bill_date, doctype
349):
Saqiba6f98d42020-07-23 18:51:26 +0530350 if doctype not in ["POS Invoice", "Sales Invoice", "Purchase Invoice"]:
Rushabh Mehtacc008cc2014-02-03 16:14:56 +0530351 # not an invoice
Ankush Menat494bd9e2022-03-28 18:52:46 +0530352 return {party_type.lower(): party}
Anand Doshi13ae5482014-04-10 18:40:57 +0530353
Rushabh Mehta49dd7be2014-01-28 17:43:10 +0530354 if party:
Anand Doshib20baf82015-09-25 16:17:50 +0530355 account = get_party_account(party_type, party, company)
Rushabh Mehta49dd7be2014-01-28 17:43:10 +0530356
Ankush Menat494bd9e2022-03-28 18:52:46 +0530357 account_fieldname = "debit_to" if party_type == "Customer" else "credit_to"
Rushabh Mehta49dd7be2014-01-28 17:43:10 +0530358 out = {
359 party_type.lower(): party,
Ankush Menat494bd9e2022-03-28 18:52:46 +0530360 account_fieldname: account,
361 "due_date": get_due_date(posting_date, party_type, party, company, bill_date),
Rushabh Mehtacc008cc2014-02-03 16:14:56 +0530362 }
Shreya Shah3a9eec22018-02-16 13:05:21 +0530363
Rushabh Mehta49dd7be2014-01-28 17:43:10 +0530364 return out
Rushabh Mehta361df892015-09-18 12:59:51 +0530365
Ankush Menat494bd9e2022-03-28 18:52:46 +0530366
Nabin Haitdb030d12014-09-10 17:11:30 +0530367@frappe.whitelist()
Gursheen Anand7591f102023-06-12 11:06:03 +0530368def get_party_account(party_type, party=None, company=None, include_advance=False):
Rushabh Mehta364054a2015-02-21 14:39:35 +0530369 """Returns the account for the given `party`.
Ankush Menat494bd9e2022-03-28 18:52:46 +0530370 Will first search in party (Customer / Supplier) record, if not found,
371 will search in group (Customer Group / Supplier Group),
372 finally will return default."""
Rushabh Mehta49dd7be2014-01-28 17:43:10 +0530373 if not company:
Anand Doshib20baf82015-09-25 16:17:50 +0530374 frappe.throw(_("Please select a Company"))
Rushabh Mehta49dd7be2014-01-28 17:43:10 +0530375
Ankush Menat494bd9e2022-03-28 18:52:46 +0530376 if not party and party_type in ["Customer", "Supplier"]:
377 default_account_name = (
378 "default_receivable_account" if party_type == "Customer" else "default_payable_account"
379 )
Deepesh Garg88648572021-11-12 12:39:30 +0530380
Ankush Menat494bd9e2022-03-28 18:52:46 +0530381 return frappe.get_cached_value("Company", company, default_account_name)
Saurabh0f86d862017-11-10 19:21:09 +0530382
Ankush Menat494bd9e2022-03-28 18:52:46 +0530383 account = frappe.db.get_value(
384 "Party Account", {"parenttype": party_type, "parent": party, "company": company}, "account"
385 )
Saurabh0f86d862017-11-10 19:21:09 +0530386
Ankush Menat494bd9e2022-03-28 18:52:46 +0530387 if not account and party_type in ["Customer", "Supplier"]:
388 party_group_doctype = "Customer Group" if party_type == "Customer" else "Supplier Group"
Nabin Hait9a33bc62018-08-09 10:47:09 +0530389 group = frappe.get_cached_value(party_type, party, scrub(party_group_doctype))
Ankush Menat494bd9e2022-03-28 18:52:46 +0530390 account = frappe.db.get_value(
391 "Party Account",
392 {"parenttype": party_group_doctype, "parent": group, "company": company},
393 "account",
394 )
Rushabh Mehta49dd7be2014-01-28 17:43:10 +0530395
Ankush Menat494bd9e2022-03-28 18:52:46 +0530396 if not account and party_type in ["Customer", "Supplier"]:
397 default_account_name = (
398 "default_receivable_account" if party_type == "Customer" else "default_payable_account"
399 )
400 account = frappe.get_cached_value("Company", company, default_account_name)
Rushabh Mehta364054a2015-02-21 14:39:35 +0530401
Saurabh0f86d862017-11-10 19:21:09 +0530402 existing_gle_currency = get_party_gle_currency(party_type, party, company)
403 if existing_gle_currency:
404 if account:
Daizy Modi010bd9c2022-11-03 14:36:48 +0530405 account_currency = frappe.get_cached_value("Account", account, "account_currency")
Saurabh0f86d862017-11-10 19:21:09 +0530406 if (account and account_currency != existing_gle_currency) or not account:
Ankush Menat494bd9e2022-03-28 18:52:46 +0530407 account = get_party_gle_account(party_type, party, company)
Rushabh Mehtab92087c2017-01-13 18:53:11 +0530408
Gursheen Anand7591f102023-06-12 11:06:03 +0530409 if include_advance and party_type in ["Customer", "Supplier"]:
410 advance_account = get_party_advance_account(party_type, party, company)
411 return [account, advance_account]
Saurabh0f86d862017-11-10 19:21:09 +0530412 return account
Rushabh Mehta49dd7be2014-01-28 17:43:10 +0530413
Ankush Menat494bd9e2022-03-28 18:52:46 +0530414
Gursheen Anand74619262023-06-02 17:13:51 +0530415def get_party_advance_account(party_type, party, company):
Gursheen Anand74619262023-06-02 17:13:51 +0530416 account = frappe.db.get_value(
Gursheen Anand4ee16372023-06-08 13:15:23 +0530417 "Party Account",
418 {"parenttype": party_type, "parent": party, "company": company},
419 "advance_account",
Gursheen Anand74619262023-06-02 17:13:51 +0530420 )
421
422 if not account:
423 party_group_doctype = "Customer Group" if party_type == "Customer" else "Supplier Group"
424 group = frappe.get_cached_value(party_type, party, scrub(party_group_doctype))
425 account = frappe.db.get_value(
426 "Party Account",
427 {"parenttype": party_group_doctype, "parent": group, "company": company},
Gursheen Anand4ee16372023-06-08 13:15:23 +0530428 "advance_account",
Gursheen Anand74619262023-06-02 17:13:51 +0530429 )
Gursheen Anand4ee16372023-06-08 13:15:23 +0530430
Gursheen Anand74619262023-06-02 17:13:51 +0530431 if not account:
Gursheen Anand4ee16372023-06-08 13:15:23 +0530432 account = frappe.get_cached_value("Company", company, "default_advance_account")
Gursheen Anand74619262023-06-02 17:13:51 +0530433
434 return account
Gursheen Anand4ee16372023-06-08 13:15:23 +0530435
436
rohitwaghchaure713cfc72018-09-11 17:40:37 +0530437@frappe.whitelist()
438def get_party_bank_account(party_type, party):
Ankush Menat494bd9e2022-03-28 18:52:46 +0530439 return frappe.db.get_value(
440 "Bank Account", {"party_type": party_type, "party": party, "is_default": 1}
441 )
442
rohitwaghchaure713cfc72018-09-11 17:40:37 +0530443
Anand Doshib20baf82015-09-25 16:17:50 +0530444def get_party_account_currency(party_type, party, company):
445 def generator():
446 party_account = get_party_account(party_type, party, company)
Daizy Modi010bd9c2022-11-03 14:36:48 +0530447 return frappe.get_cached_value("Account", party_account, "account_currency")
Anand Doshib20baf82015-09-25 16:17:50 +0530448
449 return frappe.local_cache("party_account_currency", (party_type, party, company), generator)
450
Ankush Menat494bd9e2022-03-28 18:52:46 +0530451
Anand Doshi4945b942015-09-30 16:41:15 +0530452def get_party_gle_currency(party_type, party, company):
453 def generator():
Ankush Menat494bd9e2022-03-28 18:52:46 +0530454 existing_gle_currency = frappe.db.sql(
455 """select account_currency from `tabGL Entry`
Anand Doshi4945b942015-09-30 16:41:15 +0530456 where docstatus=1 and company=%(company)s and party_type=%(party_type)s and party=%(party)s
Ankush Menat494bd9e2022-03-28 18:52:46 +0530457 limit 1""",
458 {"company": company, "party_type": party_type, "party": party},
459 )
Anand Doshi4945b942015-09-30 16:41:15 +0530460
461 return existing_gle_currency[0][0] if existing_gle_currency else None
462
Ankush Menat494bd9e2022-03-28 18:52:46 +0530463 return frappe.local_cache(
464 "party_gle_currency", (party_type, party, company), generator, regenerate_if_none=True
465 )
466
Rushabh Mehtab92087c2017-01-13 18:53:11 +0530467
Nabin Hait16d69592016-06-28 16:15:58 +0530468def get_party_gle_account(party_type, party, company):
469 def generator():
Ankush Menat494bd9e2022-03-28 18:52:46 +0530470 existing_gle_account = frappe.db.sql(
471 """select account from `tabGL Entry`
Nabin Hait16d69592016-06-28 16:15:58 +0530472 where docstatus=1 and company=%(company)s and party_type=%(party_type)s and party=%(party)s
Ankush Menat494bd9e2022-03-28 18:52:46 +0530473 limit 1""",
474 {"company": company, "party_type": party_type, "party": party},
475 )
Nabin Hait16d69592016-06-28 16:15:58 +0530476
477 return existing_gle_account[0][0] if existing_gle_account else None
478
Ankush Menat494bd9e2022-03-28 18:52:46 +0530479 return frappe.local_cache(
480 "party_gle_account", (party_type, party, company), generator, regenerate_if_none=True
481 )
482
Anand Doshi4945b942015-09-30 16:41:15 +0530483
Anand Doshid8bc40d2015-10-22 17:54:50 +0530484def validate_party_gle_currency(party_type, party, company, party_account_currency=None):
Anand Doshi4945b942015-09-30 16:41:15 +0530485 """Validate party account currency with existing GL Entry's currency"""
Anand Doshid8bc40d2015-10-22 17:54:50 +0530486 if not party_account_currency:
487 party_account_currency = get_party_account_currency(party_type, party, company)
488
Anand Doshi4945b942015-09-30 16:41:15 +0530489 existing_gle_currency = get_party_gle_currency(party_type, party, company)
490
491 if existing_gle_currency and party_account_currency != existing_gle_currency:
Ankush Menat494bd9e2022-03-28 18:52:46 +0530492 frappe.throw(
493 _(
494 "{0} {1} has accounting entries in currency {2} for company {3}. Please select a receivable or payable account with currency {2}."
495 ).format(
496 frappe.bold(party_type),
497 frappe.bold(party),
498 frappe.bold(existing_gle_currency),
499 frappe.bold(company),
500 ),
501 InvalidAccountCurrency,
502 )
503
Anand Doshi4945b942015-09-30 16:41:15 +0530504
Anand Doshida98ab62015-09-28 15:13:38 +0530505def validate_party_accounts(doc):
Deepesh Garg5a2b5712022-02-18 20:05:49 +0530506 from erpnext.controllers.accounts_controller import validate_account_head
Ankush Menat494bd9e2022-03-28 18:52:46 +0530507
Anand Doshida98ab62015-09-28 15:13:38 +0530508 companies = []
509
510 for account in doc.get("accounts"):
511 if account.company in companies:
Ankush Menat494bd9e2022-03-28 18:52:46 +0530512 frappe.throw(
513 _("There can only be 1 Account per Company in {0} {1}").format(doc.doctype, doc.name),
514 DuplicatePartyAccountError,
515 )
Anand Doshida98ab62015-09-28 15:13:38 +0530516 else:
517 companies.append(account.company)
Anand Doshid8bc40d2015-10-22 17:54:50 +0530518
Daizy Modi010bd9c2022-11-03 14:36:48 +0530519 party_account_currency = frappe.get_cached_value("Account", account.account, "account_currency")
hendrikc257ce82019-09-05 16:44:09 +0700520 if frappe.db.get_default("Company"):
Ankush Menat494bd9e2022-03-28 18:52:46 +0530521 company_default_currency = frappe.get_cached_value(
522 "Company", frappe.db.get_default("Company"), "default_currency"
523 )
hendrikc257ce82019-09-05 16:44:09 +0700524 else:
Daizy Modi27df4552022-11-03 13:38:48 +0530525 company_default_currency = frappe.get_cached_value(
526 "Company", account.company, "default_currency"
527 )
Anand Doshid8bc40d2015-10-22 17:54:50 +0530528
Deepesh Garg1a2cf5c2020-03-28 21:26:16 +0530529 validate_party_gle_currency(doc.doctype, doc.name, account.company, party_account_currency)
Anand Doshida98ab62015-09-28 15:13:38 +0530530
rohitwaghchaureea092a72017-02-01 12:02:08 +0530531 if doc.get("default_currency") and party_account_currency and company_default_currency:
Ankush Menat494bd9e2022-03-28 18:52:46 +0530532 if (
533 doc.default_currency != party_account_currency
534 and doc.default_currency != company_default_currency
535 ):
536 frappe.throw(
537 _(
538 "Billing currency must be equal to either default company's currency or party account currency"
539 )
540 )
tunde3b4bd372017-08-31 16:28:47 +0100541
Deepesh Garg5a2b5712022-02-18 20:05:49 +0530542 # validate if account is mapped for same company
Gursheen Anand74619262023-06-02 17:13:51 +0530543 if account.account:
544 validate_account_head(account.idx, account.account, account.company)
545 if account.advance_account:
546 validate_account_head(account.idx, account.advance_account, account.company)
Deepesh Garg5a2b5712022-02-18 20:05:49 +0530547
rohitwaghchaure62fea032016-03-30 13:24:42 +0530548
Nabin Hait4770a1a2015-07-09 16:35:46 +0530549@frappe.whitelist()
Shreya Shah3a9eec22018-02-16 13:05:21 +0530550def get_due_date(posting_date, party_type, party, company=None, bill_date=None):
tunde3b4bd372017-08-31 16:28:47 +0100551 """Get due date from `Payment Terms Template`"""
Rushabh Mehta49dd7be2014-01-28 17:43:10 +0530552 due_date = None
Shreya Shah3a9eec22018-02-16 13:05:21 +0530553 if (bill_date or posting_date) and party:
554 due_date = bill_date or posting_date
marinationfa085d72020-10-27 13:18:30 +0530555 template_name = get_payment_terms_template(party, party_type, company)
rohitwaghchaure3ffe8962018-07-13 17:40:48 +0530556
tunde3b4bd372017-08-31 16:28:47 +0100557 if template_name:
Ankush Menat494bd9e2022-03-28 18:52:46 +0530558 due_date = get_due_date_from_template(template_name, posting_date, bill_date).strftime(
559 "%Y-%m-%d"
560 )
tundeed86efb2017-09-05 01:15:31 +0100561 else:
562 if party_type == "Supplier":
Nabin Hait9a33bc62018-08-09 10:47:09 +0530563 supplier_group = frappe.get_cached_value(party_type, party, "supplier_group")
564 template_name = frappe.get_cached_value("Supplier Group", supplier_group, "payment_terms")
tundee5973e42017-09-05 18:11:58 +0100565 if template_name:
Ankush Menat494bd9e2022-03-28 18:52:46 +0530566 due_date = get_due_date_from_template(template_name, posting_date, bill_date).strftime(
567 "%Y-%m-%d"
568 )
Shreya Shah3a9eec22018-02-16 13:05:21 +0530569 # If due date is calculated from bill_date, check this condition
570 if getdate(due_date) < getdate(posting_date):
571 due_date = posting_date
Anand Doshi13ae5482014-04-10 18:40:57 +0530572 return due_date
Rushabh Mehta49dd7be2014-01-28 17:43:10 +0530573
Ankush Menat494bd9e2022-03-28 18:52:46 +0530574
Shreya Shah3a9eec22018-02-16 13:05:21 +0530575def get_due_date_from_template(template_name, posting_date, bill_date):
tunde3b4bd372017-08-31 16:28:47 +0100576 """
577 Inspects all `Payment Term`s from the a `Payment Terms Template` and returns the due
578 date after considering all the `Payment Term`s requirements.
579 :param template_name: Name of the `Payment Terms Template`
580 :return: String representing the calculated due date
581 """
Shreya Shah3a9eec22018-02-16 13:05:21 +0530582 due_date = getdate(bill_date or posting_date)
583
Ankush Menat494bd9e2022-03-28 18:52:46 +0530584 template = frappe.get_doc("Payment Terms Template", template_name)
tunde3b4bd372017-08-31 16:28:47 +0100585
586 for term in template.terms:
Ankush Menat494bd9e2022-03-28 18:52:46 +0530587 if term.due_date_based_on == "Day(s) after invoice date":
tunde3b4bd372017-08-31 16:28:47 +0100588 due_date = max(due_date, add_days(due_date, term.credit_days))
Ankush Menat494bd9e2022-03-28 18:52:46 +0530589 elif term.due_date_based_on == "Day(s) after the end of the invoice month":
tunde3b4bd372017-08-31 16:28:47 +0100590 due_date = max(due_date, add_days(get_last_day(due_date), term.credit_days))
591 else:
developsessionsce8a1082023-02-03 11:30:29 +0100592 due_date = max(due_date, get_last_day(add_months(due_date, term.credit_months)))
tunde3b4bd372017-08-31 16:28:47 +0100593 return due_date
594
Ankush Menat494bd9e2022-03-28 18:52:46 +0530595
596def validate_due_date(
597 posting_date, due_date, party_type, party, company=None, bill_date=None, template_name=None
598):
Nabin Hait4770a1a2015-07-09 16:35:46 +0530599 if getdate(due_date) < getdate(posting_date):
Rohit Waghchaured1a85a32018-11-26 18:42:29 +0530600 frappe.throw(_("Due Date cannot be before Posting / Supplier Invoice Date"))
Nabin Hait4770a1a2015-07-09 16:35:46 +0530601 else:
Ankush Menat494bd9e2022-03-28 18:52:46 +0530602 if not template_name:
603 return
rohitwaghchaure3ffe8962018-07-13 17:40:48 +0530604
Ankush Menat494bd9e2022-03-28 18:52:46 +0530605 default_due_date = get_due_date_from_template(template_name, posting_date, bill_date).strftime(
606 "%Y-%m-%d"
607 )
Saurabhd7897f12018-07-18 17:08:16 +0530608
Anand Doshi0ca587e2015-09-25 16:32:14 +0530609 if not default_due_date:
610 return
611
Nabin Hait93d3c822015-07-10 17:11:58 +0530612 if default_due_date != posting_date and getdate(due_date) > getdate(default_due_date):
Ankush Menat494bd9e2022-03-28 18:52:46 +0530613 is_credit_controller = (
614 frappe.db.get_single_value("Accounts Settings", "credit_controller") in frappe.get_roles()
615 )
Nabin Hait4770a1a2015-07-09 16:35:46 +0530616 if is_credit_controller:
Ankush Menat494bd9e2022-03-28 18:52:46 +0530617 msgprint(
618 _("Note: Due / Reference Date exceeds allowed customer credit days by {0} day(s)").format(
619 date_diff(due_date, default_due_date)
620 )
621 )
Nabin Hait4770a1a2015-07-09 16:35:46 +0530622 else:
Ankush Menat494bd9e2022-03-28 18:52:46 +0530623 frappe.throw(
624 _("Due / Reference Date cannot be after {0}").format(formatdate(default_due_date))
625 )
626
Rushabh Mehta361df892015-09-18 12:59:51 +0530627
Neil Trini Lasrado09f9c962015-08-26 10:41:31 +0530628@frappe.whitelist()
Nabin Hait16a7ec92019-09-05 13:01:15 +0530629def get_address_tax_category(tax_category=None, billing_address=None, shipping_address=None):
Ankush Menat494bd9e2022-03-28 18:52:46 +0530630 addr_tax_category_from = frappe.db.get_single_value(
631 "Accounts Settings", "determine_address_tax_category_from"
632 )
Saif Ur Rehmanfd531a62018-12-29 01:49:11 +0500633 if addr_tax_category_from == "Shipping Address":
634 if shipping_address:
635 tax_category = frappe.db.get_value("Address", shipping_address, "tax_category") or tax_category
636 else:
637 if billing_address:
638 tax_category = frappe.db.get_value("Address", billing_address, "tax_category") or tax_category
639
640 return cstr(tax_category)
Saif Ur Rehman67786682018-12-27 02:11:07 +0500641
Ankush Menat494bd9e2022-03-28 18:52:46 +0530642
Neil Trini Lasrado09f9c962015-08-26 10:41:31 +0530643@frappe.whitelist()
Ankush Menat494bd9e2022-03-28 18:52:46 +0530644def set_taxes(
645 party,
646 party_type,
647 posting_date,
648 company,
649 customer_group=None,
650 supplier_group=None,
651 tax_category=None,
652 billing_address=None,
653 shipping_address=None,
654 use_for_shopping_cart=None,
655):
Chillar Anand915b3432021-09-02 16:44:59 +0530656 from erpnext.accounts.doctype.tax_rule.tax_rule import get_party_details, get_tax_template
Ankush Menat494bd9e2022-03-28 18:52:46 +0530657
658 args = {party_type.lower(): party, "company": company}
Rushabh Mehta361df892015-09-18 12:59:51 +0530659
Saif Ur Rehman67786682018-12-27 02:11:07 +0500660 if tax_category:
Ankush Menat494bd9e2022-03-28 18:52:46 +0530661 args["tax_category"] = tax_category
Saif Ur Rehman67786682018-12-27 02:11:07 +0500662
Rushabh Mehta3c14c5a2017-09-29 13:21:22 +0530663 if customer_group:
Ankush Menat494bd9e2022-03-28 18:52:46 +0530664 args["customer_group"] = customer_group
Rushabh Mehta3c14c5a2017-09-29 13:21:22 +0530665
Zlash6589070782018-04-19 18:37:29 +0530666 if supplier_group:
Ankush Menat494bd9e2022-03-28 18:52:46 +0530667 args["supplier_group"] = supplier_group
Rushabh Mehta3c14c5a2017-09-29 13:21:22 +0530668
Neil Trini Lasrado09f9c962015-08-26 10:41:31 +0530669 if billing_address or shipping_address:
Ankush Menat494bd9e2022-03-28 18:52:46 +0530670 args.update(
671 get_party_details(
672 party, party_type, {"billing_address": billing_address, "shipping_address": shipping_address}
673 )
674 )
Neil Trini Lasrado09f9c962015-08-26 10:41:31 +0530675 else:
676 args.update(get_party_details(party, party_type))
Rushabh Mehta361df892015-09-18 12:59:51 +0530677
Anand Doshi2f957f22016-04-08 17:36:10 +0530678 if party_type in ("Customer", "Lead"):
Neil Trini Lasrado810bd352015-08-21 15:04:57 +0530679 args.update({"tax_type": "Sales"})
Anand Doshi2f957f22016-04-08 17:36:10 +0530680
Ankush Menat494bd9e2022-03-28 18:52:46 +0530681 if party_type == "Lead":
682 args["customer"] = None
683 del args["lead"]
Neil Trini Lasrado810bd352015-08-21 15:04:57 +0530684 else:
685 args.update({"tax_type": "Purchase"})
Rushabh Mehta361df892015-09-18 12:59:51 +0530686
Saurabh957e7a32015-09-11 15:44:06 +0530687 if use_for_shopping_cart:
Saurabh957e7a32015-09-11 15:44:06 +0530688 args.update({"use_for_shopping_cart": use_for_shopping_cart})
Rushabh Mehta361df892015-09-18 12:59:51 +0530689
690 return get_tax_template(posting_date, args)
shreyas29b565f2016-01-25 17:30:49 +0530691
tunde400d0462017-08-31 13:44:57 +0100692
693@frappe.whitelist()
marinationfa085d72020-10-27 13:18:30 +0530694def get_payment_terms_template(party_name, party_type, company=None):
Nabin Haitcfa9d1a2018-01-29 16:07:21 +0530695 if party_type not in ("Customer", "Supplier"):
696 return
tunde400d0462017-08-31 13:44:57 +0100697 template = None
Ankush Menat494bd9e2022-03-28 18:52:46 +0530698 if party_type == "Customer":
699 customer = frappe.get_cached_value(
700 "Customer", party_name, fieldname=["payment_terms", "customer_group"], as_dict=1
701 )
Nabin Haitcfa9d1a2018-01-29 16:07:21 +0530702 template = customer.payment_terms
703
704 if not template and customer.customer_group:
Ankush Menat494bd9e2022-03-28 18:52:46 +0530705 template = frappe.get_cached_value("Customer Group", customer.customer_group, "payment_terms")
Nabin Haitcfa9d1a2018-01-29 16:07:21 +0530706 else:
Ankush Menat494bd9e2022-03-28 18:52:46 +0530707 supplier = frappe.get_cached_value(
708 "Supplier", party_name, fieldname=["payment_terms", "supplier_group"], as_dict=1
709 )
Nabin Haitcfa9d1a2018-01-29 16:07:21 +0530710 template = supplier.payment_terms
Zlash6589070782018-04-19 18:37:29 +0530711 if not template and supplier.supplier_group:
Ankush Menat494bd9e2022-03-28 18:52:46 +0530712 template = frappe.get_cached_value("Supplier Group", supplier.supplier_group, "payment_terms")
Nabin Haitcfa9d1a2018-01-29 16:07:21 +0530713
714 if not template and company:
Ankush Menat494bd9e2022-03-28 18:52:46 +0530715 template = frappe.get_cached_value("Company", company, fieldname="payment_terms")
tunde400d0462017-08-31 13:44:57 +0100716 return template
717
Ankush Menat494bd9e2022-03-28 18:52:46 +0530718
shreyaseba9ca42016-01-26 14:56:52 +0530719def validate_party_frozen_disabled(party_type, party_name):
Subin Tomb8845b92021-07-30 16:30:18 +0530720
721 if frappe.flags.ignore_party_validation:
722 return
723
shreyas79872bf2016-01-26 13:57:06 +0530724 if party_type and party_name:
KanchanChauhanfbaa6192017-01-30 15:15:58 +0530725 if party_type in ("Customer", "Supplier"):
Nabin Hait9a33bc62018-08-09 10:47:09 +0530726 party = frappe.get_cached_value(party_type, party_name, ["is_frozen", "disabled"], as_dict=True)
deepeshgarg007737ec6b2019-10-20 17:36:36 +0530727 if party.disabled:
728 frappe.throw(_("{0} {1} is disabled").format(party_type, party_name), PartyDisabled)
729 elif party.get("is_frozen"):
Ankush Menat494bd9e2022-03-28 18:52:46 +0530730 frozen_accounts_modifier = frappe.db.get_single_value(
731 "Accounts Settings", "frozen_accounts_modifier"
732 )
KanchanChauhanfbaa6192017-01-30 15:15:58 +0530733 if not frozen_accounts_modifier in frappe.get_roles():
734 frappe.throw(_("{0} {1} is frozen").format(party_type, party_name), PartyFrozen)
735
736 elif party_type == "Employee":
Rucha Mahabala38147a2021-06-12 13:33:21 +0530737 if frappe.db.get_value("Employee", party_name, "status") != "Active":
Kanchan Chauhan95108ac2017-04-11 15:55:34 +0530738 frappe.msgprint(_("{0} {1} is not active").format(party_type, party_name), alert=True)
Rushabh Mehta15a7f212016-04-14 17:30:40 +0530739
Ankush Menat494bd9e2022-03-28 18:52:46 +0530740
Rushabh Mehta15a7f212016-04-14 17:30:40 +0530741def get_timeline_data(doctype, name):
Ankush Menat494bd9e2022-03-28 18:52:46 +0530742 """returns timeline data for the past one year"""
Rushabh Mehta15a7f212016-04-14 17:30:40 +0530743 from frappe.desk.form.load import get_communication_data
mbauskare7b87ad2017-02-16 13:12:29 +0530744
745 out = {}
Ankush Menat494bd9e2022-03-28 18:52:46 +0530746 fields = "creation, count(*)"
747 after = add_years(None, -1).strftime("%Y-%m-%d")
748 group_by = "group by Date(creation)"
Zarrar58200182018-05-30 11:56:23 +0530749
Ankush Menat494bd9e2022-03-28 18:52:46 +0530750 data = get_communication_data(
751 doctype,
752 name,
753 after=after,
754 group_by="group by creation",
755 fields="C.creation as creation, count(C.name)",
756 as_dict=False,
757 )
Zarrar58200182018-05-30 11:56:23 +0530758
759 # fetch and append data from Activity Log
Ankush Menat494bd9e2022-03-28 18:52:46 +0530760 data += frappe.db.sql(
761 """select {fields}
Zarrar58200182018-05-30 11:56:23 +0530762 from `tabActivity Log`
rohitwaghchaure52107612020-05-05 12:12:33 +0530763 where (reference_doctype=%(doctype)s and reference_name=%(name)s)
764 or (timeline_doctype in (%(doctype)s) and timeline_name=%(name)s)
765 or (reference_doctype in ("Quotation", "Opportunity") and timeline_name=%(name)s)
Zarrar58200182018-05-30 11:56:23 +0530766 and status!='Success' and creation > {after}
767 {group_by} order by creation desc
Ankush Menat494bd9e2022-03-28 18:52:46 +0530768 """.format(
769 fields=fields, group_by=group_by, after=after
770 ),
771 {"doctype": doctype, "name": name},
772 as_dict=False,
773 )
mbauskare7b87ad2017-02-16 13:12:29 +0530774
775 timeline_items = dict(data)
776
Ankush Menat8fe5feb2021-11-04 19:48:32 +0530777 for date, count in timeline_items.items():
mbauskare7b87ad2017-02-16 13:12:29 +0530778 timestamp = get_timestamp(date)
Ankush Menat494bd9e2022-03-28 18:52:46 +0530779 out.update({timestamp: count})
mbauskare7b87ad2017-02-16 13:12:29 +0530780
Nabin Hait2d79a642017-05-24 12:41:14 +0530781 return out
Rushabh Mehta919a74a2017-06-22 16:37:04 +0530782
Ankush Menat494bd9e2022-03-28 18:52:46 +0530783
deepeshgarg00712f5cef2018-12-25 16:06:19 +0530784def get_dashboard_info(party_type, party, loyalty_program=None):
Nabin Hait2d79a642017-05-24 12:41:14 +0530785 current_fiscal_year = get_fiscal_year(nowdate(), as_dict=True)
Rushabh Mehta919a74a2017-06-22 16:37:04 +0530786
Ankush Menat494bd9e2022-03-28 18:52:46 +0530787 doctype = "Sales Invoice" if party_type == "Customer" else "Purchase Invoice"
Rushabh Mehta919a74a2017-06-22 16:37:04 +0530788
Ankush Menat494bd9e2022-03-28 18:52:46 +0530789 companies = frappe.get_all(
790 doctype, filters={"docstatus": 1, party_type.lower(): party}, distinct=1, fields=["company"]
791 )
Rushabh Mehta919a74a2017-06-22 16:37:04 +0530792
deepeshgarg007920dc142018-11-23 10:17:28 +0530793 company_wise_info = []
794
Ankush Menat494bd9e2022-03-28 18:52:46 +0530795 company_wise_grand_total = frappe.get_all(
796 doctype,
deepeshgarg007ee05e352018-11-29 16:24:28 +0530797 filters={
Ankush Menat494bd9e2022-03-28 18:52:46 +0530798 "docstatus": 1,
deepeshgarg007ee05e352018-11-29 16:24:28 +0530799 party_type.lower(): party,
Ankush Menat494bd9e2022-03-28 18:52:46 +0530800 "posting_date": (
801 "between",
802 [current_fiscal_year.year_start_date, current_fiscal_year.year_end_date],
803 ),
804 },
805 group_by="company",
806 fields=[
807 "company",
808 "sum(grand_total) as grand_total",
809 "sum(base_grand_total) as base_grand_total",
810 ],
811 )
deepeshgarg007920dc142018-11-23 10:17:28 +0530812
deepeshgarg007a1d015c2018-12-26 11:01:02 +0530813 loyalty_point_details = []
814
deepeshgarg00712f5cef2018-12-25 16:06:19 +0530815 if party_type == "Customer":
Ankush Menat494bd9e2022-03-28 18:52:46 +0530816 loyalty_point_details = frappe._dict(
817 frappe.get_all(
818 "Loyalty Point Entry",
819 filters={
820 "customer": party,
821 "expiry_date": (">=", getdate()),
deepeshgarg00712f5cef2018-12-25 16:06:19 +0530822 },
823 group_by="company",
824 fields=["company", "sum(loyalty_points) as loyalty_points"],
Ankush Menat494bd9e2022-03-28 18:52:46 +0530825 as_list=1,
826 )
827 )
deepeshgarg00712f5cef2018-12-25 16:06:19 +0530828
deepeshgarg007f31caff2018-11-27 15:04:12 +0530829 company_wise_billing_this_year = frappe._dict()
830
831 for d in company_wise_grand_total:
832 company_wise_billing_this_year.setdefault(
Ankush Menat494bd9e2022-03-28 18:52:46 +0530833 d.company, {"grand_total": d.grand_total, "base_grand_total": d.base_grand_total}
834 )
deepeshgarg007f31caff2018-11-27 15:04:12 +0530835
Ankush Menat494bd9e2022-03-28 18:52:46 +0530836 company_wise_total_unpaid = frappe._dict(
837 frappe.db.sql(
838 """
deepeshgarg007920dc142018-11-23 10:17:28 +0530839 select company, sum(debit_in_account_currency) - sum(credit_in_account_currency)
Nabin Hait24f0b132017-05-24 13:01:26 +0530840 from `tabGL Entry`
deepeshgarg007920dc142018-11-23 10:17:28 +0530841 where party_type = %s and party=%s
Deepesh Garg802e63a2021-06-28 11:24:32 +0530842 and is_cancelled = 0
Ankush Menat494bd9e2022-03-28 18:52:46 +0530843 group by company""",
844 (party_type, party),
845 )
846 )
Nabin Hait2d79a642017-05-24 12:41:14 +0530847
deepeshgarg007920dc142018-11-23 10:17:28 +0530848 for d in companies:
Daizy Modi27df4552022-11-03 13:38:48 +0530849 company_default_currency = frappe.get_cached_value("Company", d.company, "default_currency")
deepeshgarg007920dc142018-11-23 10:17:28 +0530850 party_account_currency = get_party_account_currency(party_type, party, d.company)
Rushabh Mehta919a74a2017-06-22 16:37:04 +0530851
Ankush Menat494bd9e2022-03-28 18:52:46 +0530852 if party_account_currency == company_default_currency:
853 billing_this_year = flt(
854 company_wise_billing_this_year.get(d.company, {}).get("base_grand_total")
855 )
deepeshgarg007920dc142018-11-23 10:17:28 +0530856 else:
Ankush Menat494bd9e2022-03-28 18:52:46 +0530857 billing_this_year = flt(company_wise_billing_this_year.get(d.company, {}).get("grand_total"))
deepeshgarg007920dc142018-11-23 10:17:28 +0530858
859 total_unpaid = flt(company_wise_total_unpaid.get(d.company))
860
deepeshgarg00712f5cef2018-12-25 16:06:19 +0530861 if loyalty_point_details:
862 loyalty_points = loyalty_point_details.get(d.company)
863
deepeshgarg007920dc142018-11-23 10:17:28 +0530864 info = {}
865 info["billing_this_year"] = flt(billing_this_year) if billing_this_year else 0
866 info["currency"] = party_account_currency
867 info["total_unpaid"] = flt(total_unpaid) if total_unpaid else 0
868 info["company"] = d.company
869
deepeshgarg00712f5cef2018-12-25 16:06:19 +0530870 if party_type == "Customer" and loyalty_point_details:
871 info["loyalty_points"] = loyalty_points
872
deepeshgarg007920dc142018-11-23 10:17:28 +0530873 if party_type == "Supplier":
874 info["total_unpaid"] = -1 * info["total_unpaid"]
875
876 company_wise_info.append(info)
877
878 return company_wise_info
tundebabzy40a02762017-10-25 07:54:34 +0100879
Ankush Menat494bd9e2022-03-28 18:52:46 +0530880
tundebabzy40a02762017-10-25 07:54:34 +0100881def get_party_shipping_address(doctype, name):
882 """
883 Returns an Address name (best guess) for the given doctype and name for which `address_type == 'Shipping'` is true.
884 and/or `is_shipping_address = 1`.
885
886 It returns an empty string if there is no matching record.
887
888 :param doctype: Party Doctype
889 :param name: Party name
890 :return: String
891 """
892 out = frappe.db.sql(
Ankush Menat494bd9e2022-03-28 18:52:46 +0530893 "SELECT dl.parent "
894 "from `tabDynamic Link` dl join `tabAddress` ta on dl.parent=ta.name "
895 "where "
896 "dl.link_doctype=%s "
897 "and dl.link_name=%s "
Ankush Menat88e257f2022-04-24 20:17:17 +0530898 "and dl.parenttype='Address' "
Ankush Menat494bd9e2022-03-28 18:52:46 +0530899 "and ifnull(ta.disabled, 0) = 0 and"
Ankush Menat88e257f2022-04-24 20:17:17 +0530900 "(ta.address_type='Shipping' or ta.is_shipping_address=1) "
Ankush Menat494bd9e2022-03-28 18:52:46 +0530901 "order by ta.is_shipping_address desc, ta.address_type desc limit 1",
902 (doctype, name),
tundebabzy40a02762017-10-25 07:54:34 +0100903 )
904 if out:
905 return out[0][0]
906 else:
Ankush Menat494bd9e2022-03-28 18:52:46 +0530907 return ""
Rohit Waghchaureaffeb3d2019-01-15 17:38:31 +0530908
Ankush Menat494bd9e2022-03-28 18:52:46 +0530909
910def get_partywise_advanced_payment_amount(
Nabin Hait3504bf72023-05-29 09:23:40 +0530911 party_type, posting_date=None, future_payment=0, company=None, party=None
Ankush Menat494bd9e2022-03-28 18:52:46 +0530912):
Rohit Waghchaure4ed7d032019-03-25 15:37:25 +0530913 cond = "1=1"
914 if posting_date:
Deepesh Garged2c1802020-05-27 12:46:12 +0530915 if future_payment:
Nabin Hait3504bf72023-05-29 09:23:40 +0530916 cond = "(posting_date <= '{0}' OR DATE(creation) <= '{0}')" "".format(posting_date)
Deepesh Garged2c1802020-05-27 12:46:12 +0530917 else:
UrvashiKishnani810a3612021-03-02 08:20:03 +0400918 cond = "posting_date <= '{0}'".format(posting_date)
Deepesh Garged2c1802020-05-27 12:46:12 +0530919
Saqib39805912020-05-01 18:15:13 +0530920 if company:
UrvashiKishnani810a3612021-03-02 08:20:03 +0400921 cond += "and company = {0}".format(frappe.db.escape(company))
Rohit Waghchaure4ed7d032019-03-25 15:37:25 +0530922
Nabin Hait3504bf72023-05-29 09:23:40 +0530923 if party:
924 cond += "and party = {0}".format(frappe.db.escape(party))
925
Ankush Menat494bd9e2022-03-28 18:52:46 +0530926 data = frappe.db.sql(
927 """ SELECT party, sum({0}) as amount
UrvashiKishnani810a3612021-03-02 08:20:03 +0400928 FROM `tabGL Entry`
Rohit Waghchaure1a6e0152019-03-19 15:06:01 +0530929 WHERE
UrvashiKishnani810a3612021-03-02 08:20:03 +0400930 party_type = %s and against_voucher is null
931 and is_cancelled = 0
Ankush Menat494bd9e2022-03-28 18:52:46 +0530932 and {1} GROUP BY party""".format(
933 ("credit") if party_type == "Customer" else "debit", cond
934 ),
935 party_type,
936 )
Rohit Waghchaureaffeb3d2019-01-15 17:38:31 +0530937 if data:
hendrikc257ce82019-09-05 16:44:09 +0700938 return frappe._dict(data)
Ronel Cabrerafcb54762019-11-18 17:00:07 +0800939
Ankush Menat494bd9e2022-03-28 18:52:46 +0530940
Deepesh Gargcf9347d2020-03-31 17:28:43 +0530941def get_default_contact(doctype, name):
942 """
Ankush Menat494bd9e2022-03-28 18:52:46 +0530943 Returns default contact for the given doctype and name.
944 Can be ordered by `contact_type` to either is_primary_contact or is_billing_contact.
Ronel Cabrerafcb54762019-11-18 17:00:07 +0800945 """
Ankush Menat494bd9e2022-03-28 18:52:46 +0530946 out = frappe.db.sql(
947 """
Ronel Cabrerafcb54762019-11-18 17:00:07 +0800948 SELECT dl.parent, c.is_primary_contact, c.is_billing_contact
949 FROM `tabDynamic Link` dl
Ankush Menata90e7e32022-04-24 20:05:36 +0530950 INNER JOIN `tabContact` c ON c.name = dl.parent
Deepesh Gargcf9347d2020-03-31 17:28:43 +0530951 WHERE
Ronel Cabrerafcb54762019-11-18 17:00:07 +0800952 dl.link_doctype=%s AND
953 dl.link_name=%s AND
Ankush Menata90e7e32022-04-24 20:05:36 +0530954 dl.parenttype = 'Contact'
Deepesh Gargcf9347d2020-03-31 17:28:43 +0530955 ORDER BY is_primary_contact DESC, is_billing_contact DESC
Ankush Menat494bd9e2022-03-28 18:52:46 +0530956 """,
957 (doctype, name),
958 )
Ronel Cabrerafcb54762019-11-18 17:00:07 +0800959 if out:
960 try:
961 return out[0][0]
Ankush Menat694ae812021-09-01 14:40:56 +0530962 except Exception:
Ronel Cabrerafcb54762019-11-18 17:00:07 +0800963 return None
964 else:
Faris Ansari64f01bd2020-04-14 11:51:48 +0530965 return None
Deepesh Gargbc347372022-05-25 15:42:47 +0530966
967
968def add_party_account(party_type, party, company, account):
969 doc = frappe.get_doc(party_type, party)
970 account_exists = False
971 for d in doc.get("accounts"):
972 if d.account == account:
973 account_exists = True
974
975 if not account_exists:
976 accounts = {"company": company, "account": account}
977
978 doc.append("accounts", accounts)
979
980 doc.save()