blob: 62487ba2aa0933ec5065f8b1bab7a09802c0cbcd [file] [log] [blame]
Aditya Hasef3c22f32019-01-22 18:22:20 +05301from __future__ import unicode_literals
Nabin Hait34c551d2019-07-03 10:34:31 +05302import frappe, re, json
Rushabh Mehtab3c8f442017-06-21 17:22:38 +05303from frappe import _
Deepesh Garg1c146062020-08-18 19:32:52 +05304import erpnext
Deepesh Garg3c004ad2020-07-02 21:18:29 +05305from frappe.utils import cstr, flt, date_diff, nowdate, round_based_on_smallest_currency_fraction, money_in_words
Rushabh Mehtab3c8f442017-06-21 17:22:38 +05306from erpnext.regional.india import states, state_numbers
Nabin Haitb962fc12017-07-17 18:02:31 +05307from erpnext.controllers.taxes_and_totals import get_itemised_tax, get_itemised_taxable_amount
Shreya Shah4fa600a2018-06-05 11:27:53 +05308from erpnext.controllers.accounts_controller import get_taxes_and_charges
Ranjith Kurungadama8e047a2018-06-14 17:56:16 +05309from erpnext.hr.utils import get_salary_assignment
Anurag Mishra289c8222020-06-19 19:17:57 +053010from erpnext.payroll.doctype.salary_structure.salary_structure import make_salary_slip
Deepesh Garg6e2c13f2019-12-10 15:55:05 +053011from erpnext.regional.india import number_state_mapping
12from six import string_types
Deepesh Garg24f9a802020-06-03 10:59:37 +053013from erpnext.accounts.general_ledger import make_gl_entries
14from erpnext.accounts.utils import get_account_currency
Rushabh Mehtab3c8f442017-06-21 17:22:38 +053015
16def validate_gstin_for_india(doc, method):
rushin2908a209b2019-03-15 15:28:50 +053017 if hasattr(doc, 'gst_state') and doc.gst_state:
18 doc.gst_state_number = state_numbers[doc.gst_state]
FinByz Tech Pvt. Ltd237a8712019-01-22 20:49:06 +053019 if not hasattr(doc, 'gstin') or not doc.gstin:
Rushabh Mehtab3c8f442017-06-21 17:22:38 +053020 return
21
Deepesh Garg459155f2019-06-14 12:01:34 +053022 gst_category = []
23
24 if len(doc.links):
25 link_doctype = doc.links[0].get("link_doctype")
26 link_name = doc.links[0].get("link_name")
27
28 if link_doctype in ["Customer", "Supplier"]:
29 gst_category = frappe.db.get_value(link_doctype, {'name': link_name}, ['gst_category'])
30
Sagar Vorad75095b2019-01-23 14:40:01 +053031 doc.gstin = doc.gstin.upper().strip()
Sagar Vora07cf4e82019-01-10 11:07:51 +053032 if not doc.gstin or doc.gstin == 'NA':
33 return
Rushabh Mehtab3c8f442017-06-21 17:22:38 +053034
Sagar Vora07cf4e82019-01-10 11:07:51 +053035 if len(doc.gstin) != 15:
36 frappe.throw(_("Invalid GSTIN! A GSTIN must have 15 characters."))
Rushabh Mehtab3c8f442017-06-21 17:22:38 +053037
Deepesh Garg459155f2019-06-14 12:01:34 +053038 if gst_category and gst_category == 'UIN Holders':
39 p = re.compile("^[0-9]{4}[A-Z]{3}[0-9]{5}[0-9A-Z]{3}")
40 if not p.match(doc.gstin):
41 frappe.throw(_("Invalid GSTIN! The input you've entered doesn't match the GSTIN format for UIN Holders or Non-Resident OIDAR Service Providers"))
42 else:
43 p = re.compile("^[0-9]{2}[A-Z]{4}[0-9A-Z]{1}[0-9]{4}[A-Z]{1}[1-9A-Z]{1}[1-9A-Z]{1}[0-9A-Z]{1}$")
44 if not p.match(doc.gstin):
45 frappe.throw(_("Invalid GSTIN! The input you've entered doesn't match the format of GSTIN."))
Rushabh Mehta7231f292017-07-13 15:00:56 +053046
Deepesh Garg459155f2019-06-14 12:01:34 +053047 validate_gstin_check_digit(doc.gstin)
Nabin Hait34c551d2019-07-03 10:34:31 +053048 set_gst_state_and_state_number(doc)
Rushabh Mehtab3c8f442017-06-21 17:22:38 +053049
Deepesh Garg459155f2019-06-14 12:01:34 +053050 if doc.gst_state_number != doc.gstin[:2]:
51 frappe.throw(_("Invalid GSTIN! First 2 digits of GSTIN should match with State number {0}.")
52 .format(doc.gst_state_number))
Sagar Vora07cf4e82019-01-10 11:07:51 +053053
Deepesh Gargd07447a2020-11-24 08:09:17 +053054def validate_tax_category(doc, method):
55 if doc.get('gst_state') and frappe.db.get_value('Tax category', {'gst_state': doc.gst_state, 'is_inter_state': doc.is_inter_state}):
56 if doc.is_inter_state:
57 frappe.throw(_("Inter State tax category for GST State {0} already exists").format(doc.gst_state))
58 else:
59 frappe.throw(_("Intra State tax category for GST State {0} already exists").format(doc.gst_state))
60
Deepesh Garg6e2c13f2019-12-10 15:55:05 +053061def update_gst_category(doc, method):
62 for link in doc.links:
63 if link.link_doctype in ['Customer', 'Supplier']:
64 if doc.get('gstin'):
65 frappe.db.sql("""
66 UPDATE `tab{0}` SET gst_category = %s WHERE name = %s AND gst_category = 'Unregistered'
67 """.format(link.link_doctype), ("Registered Regular", link.link_name)) #nosec
68
Nabin Hait34c551d2019-07-03 10:34:31 +053069def set_gst_state_and_state_number(doc):
70 if not doc.gst_state:
71 if not doc.state:
72 return
73 state = doc.state.lower()
74 states_lowercase = {s.lower():s for s in states}
75 if state in states_lowercase:
76 doc.gst_state = states_lowercase[state]
77 else:
78 return
79
80 doc.gst_state_number = state_numbers[doc.gst_state]
81
82def validate_gstin_check_digit(gstin, label='GSTIN'):
Sagar Vora07cf4e82019-01-10 11:07:51 +053083 ''' Function to validate the check digit of the GSTIN.'''
karthikeyan52825b922019-01-09 19:15:10 +053084 factor = 1
85 total = 0
86 code_point_chars = '0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ'
karthikeyan52825b922019-01-09 19:15:10 +053087 mod = len(code_point_chars)
Sagar Vora07cf4e82019-01-10 11:07:51 +053088 input_chars = gstin[:-1]
karthikeyan52825b922019-01-09 19:15:10 +053089 for char in input_chars:
90 digit = factor * code_point_chars.find(char)
Sagar Vora07cf4e82019-01-10 11:07:51 +053091 digit = (digit // mod) + (digit % mod)
karthikeyan52825b922019-01-09 19:15:10 +053092 total += digit
93 factor = 2 if factor == 1 else 1
Sagar Vora07cf4e82019-01-10 11:07:51 +053094 if gstin[-1] != code_point_chars[((mod - (total % mod)) % mod)]:
Deepesh Gargd07447a2020-11-24 08:09:17 +053095 frappe.throw(_("""Invalid {0}! The check digit validation has failed. Please ensure you've typed the {0} correctly.""").format(label))
Rushabh Mehta7231f292017-07-13 15:00:56 +053096
Nabin Haitb962fc12017-07-17 18:02:31 +053097def get_itemised_tax_breakup_header(item_doctype, tax_accounts):
98 if frappe.get_meta(item_doctype).has_field('gst_hsn_code'):
99 return [_("HSN/SAC"), _("Taxable Amount")] + tax_accounts
100 else:
101 return [_("Item"), _("Taxable Amount")] + tax_accounts
Nabin Haitb95ecd72018-02-16 13:19:04 +0530102
Nabin Hait34c551d2019-07-03 10:34:31 +0530103def get_itemised_tax_breakup_data(doc, account_wise=False):
104 itemised_tax = get_itemised_tax(doc.taxes, with_tax_account=account_wise)
Nabin Haitb962fc12017-07-17 18:02:31 +0530105
106 itemised_taxable_amount = get_itemised_taxable_amount(doc.items)
Nabin Haitb95ecd72018-02-16 13:19:04 +0530107
Nabin Haitb962fc12017-07-17 18:02:31 +0530108 if not frappe.get_meta(doc.doctype + " Item").has_field('gst_hsn_code'):
109 return itemised_tax, itemised_taxable_amount
110
111 item_hsn_map = frappe._dict()
112 for d in doc.items:
113 item_hsn_map.setdefault(d.item_code or d.item_name, d.get("gst_hsn_code"))
114
115 hsn_tax = {}
116 for item, taxes in itemised_tax.items():
117 hsn_code = item_hsn_map.get(item)
118 hsn_tax.setdefault(hsn_code, frappe._dict())
Nabin Hait34c551d2019-07-03 10:34:31 +0530119 for tax_desc, tax_detail in taxes.items():
120 key = tax_desc
121 if account_wise:
122 key = tax_detail.get('tax_account')
123 hsn_tax[hsn_code].setdefault(key, {"tax_rate": 0, "tax_amount": 0})
124 hsn_tax[hsn_code][key]["tax_rate"] = tax_detail.get("tax_rate")
125 hsn_tax[hsn_code][key]["tax_amount"] += tax_detail.get("tax_amount")
Nabin Haitb962fc12017-07-17 18:02:31 +0530126
127 # set taxable amount
128 hsn_taxable_amount = frappe._dict()
Nabin Hait34c551d2019-07-03 10:34:31 +0530129 for item in itemised_taxable_amount:
Nabin Haitb962fc12017-07-17 18:02:31 +0530130 hsn_code = item_hsn_map.get(item)
131 hsn_taxable_amount.setdefault(hsn_code, 0)
132 hsn_taxable_amount[hsn_code] += itemised_taxable_amount.get(item)
133
134 return hsn_tax, hsn_taxable_amount
135
Shreya Shah4fa600a2018-06-05 11:27:53 +0530136def set_place_of_supply(doc, method=None):
137 doc.place_of_supply = get_place_of_supply(doc, doc.doctype)
Nabin Haitb95ecd72018-02-16 13:19:04 +0530138
Rushabh Mehta7231f292017-07-13 15:00:56 +0530139# don't remove this function it is used in tests
140def test_method():
141 '''test function'''
Nabin Haitb95ecd72018-02-16 13:19:04 +0530142 return 'overridden'
Shreya Shah4fa600a2018-06-05 11:27:53 +0530143
Deepesh Garg6e2c13f2019-12-10 15:55:05 +0530144def get_place_of_supply(party_details, doctype):
Shreya Shah4fa600a2018-06-05 11:27:53 +0530145 if not frappe.get_meta('Address').has_field('gst_state'): return
146
Deepesh Garg6e2c13f2019-12-10 15:55:05 +0530147 if doctype in ("Sales Invoice", "Delivery Note", "Sales Order"):
Deepesh Gargeacfd792020-10-30 22:12:24 +0530148 address_name = party_details.customer_address or party_details.shipping_address_name
Deepesh Garg6e2c13f2019-12-10 15:55:05 +0530149 elif doctype in ("Purchase Invoice", "Purchase Order", "Purchase Receipt"):
150 address_name = party_details.shipping_address or party_details.supplier_address
Shreya Shah4fa600a2018-06-05 11:27:53 +0530151
152 if address_name:
Deepesh Garg15ff6a52020-02-18 12:28:41 +0530153 address = frappe.db.get_value("Address", address_name, ["gst_state", "gst_state_number", "gstin"], as_dict=1)
Rohit Waghchaureb6a735e2018-10-11 10:40:34 +0530154 if address and address.gst_state and address.gst_state_number:
Deepesh Garg15ff6a52020-02-18 12:28:41 +0530155 party_details.gstin = address.gstin
Nabin Hait2390da62018-08-30 16:16:35 +0530156 return cstr(address.gst_state_number) + "-" + cstr(address.gst_state)
Shreya Shah4fa600a2018-06-05 11:27:53 +0530157
Deepesh Garg6e2c13f2019-12-10 15:55:05 +0530158@frappe.whitelist()
pateljannat1d5d8632020-11-19 20:11:45 +0530159def get_regional_address_details(party_details, doctype, company):
Deepesh Garg6e2c13f2019-12-10 15:55:05 +0530160 if isinstance(party_details, string_types):
161 party_details = json.loads(party_details)
162 party_details = frappe._dict(party_details)
Shreya Shah4fa600a2018-06-05 11:27:53 +0530163
Deepesh Garg6e2c13f2019-12-10 15:55:05 +0530164 party_details.place_of_supply = get_place_of_supply(party_details, doctype)
Deepesh Garg15ff6a52020-02-18 12:28:41 +0530165
166 if is_internal_transfer(party_details, doctype):
167 party_details.taxes_and_charges = ''
168 party_details.taxes = ''
pateljannatcd05b342020-11-19 11:37:08 +0530169 return party_details
Deepesh Garg15ff6a52020-02-18 12:28:41 +0530170
Deepesh Garg6e2c13f2019-12-10 15:55:05 +0530171 if doctype in ("Sales Invoice", "Delivery Note", "Sales Order"):
Shreya Shah4fa600a2018-06-05 11:27:53 +0530172 master_doctype = "Sales Taxes and Charges Template"
Deepesh Garg6e2c13f2019-12-10 15:55:05 +0530173
174 get_tax_template_for_sez(party_details, master_doctype, company, 'Customer')
175 get_tax_template_based_on_category(master_doctype, company, party_details)
176
pateljannatcd05b342020-11-19 11:37:08 +0530177 if party_details.get('taxes_and_charges'):
Deepesh Garg6e2c13f2019-12-10 15:55:05 +0530178 return party_details
179
180 if not party_details.company_gstin:
pateljannatcd05b342020-11-19 11:37:08 +0530181 return party_details
Shreya Shah4fa600a2018-06-05 11:27:53 +0530182
Deepesh Garg6e2c13f2019-12-10 15:55:05 +0530183 elif doctype in ("Purchase Invoice", "Purchase Order", "Purchase Receipt"):
184 master_doctype = "Purchase Taxes and Charges Template"
Deepesh Garg6e2c13f2019-12-10 15:55:05 +0530185 get_tax_template_for_sez(party_details, master_doctype, company, 'Supplier')
186 get_tax_template_based_on_category(master_doctype, company, party_details)
187
pateljannatcd05b342020-11-19 11:37:08 +0530188 if party_details.get('taxes_and_charges'):
Deepesh Garg6e2c13f2019-12-10 15:55:05 +0530189 return party_details
190
191 if not party_details.supplier_gstin:
pateljannatcd05b342020-11-19 11:37:08 +0530192 return party_details
Deepesh Garg6e2c13f2019-12-10 15:55:05 +0530193
pateljannatcd05b342020-11-19 11:37:08 +0530194 if not party_details.place_of_supply: return party_details
Deepesh Garg6e2c13f2019-12-10 15:55:05 +0530195
pateljannatcd05b342020-11-19 11:37:08 +0530196 if not party_details.company_gstin: return party_details
deepeshgarg007c58dc872019-12-12 14:55:57 +0530197
Deepesh Garg6e2c13f2019-12-10 15:55:05 +0530198 if ((doctype in ("Sales Invoice", "Delivery Note", "Sales Order") and party_details.company_gstin
199 and party_details.company_gstin[:2] != party_details.place_of_supply[:2]) or (doctype in ("Purchase Invoice",
200 "Purchase Order", "Purchase Receipt") and party_details.supplier_gstin and party_details.supplier_gstin[:2] != party_details.place_of_supply[:2])):
201 default_tax = get_tax_template(master_doctype, company, 1, party_details.company_gstin[:2])
Shreya Shah4fa600a2018-06-05 11:27:53 +0530202 else:
Deepesh Garg6e2c13f2019-12-10 15:55:05 +0530203 default_tax = get_tax_template(master_doctype, company, 0, party_details.company_gstin[:2])
Shreya Shah4fa600a2018-06-05 11:27:53 +0530204
205 if not default_tax:
pateljannatcd05b342020-11-19 11:37:08 +0530206 return party_details
Deepesh Garg6e2c13f2019-12-10 15:55:05 +0530207 party_details["taxes_and_charges"] = default_tax
208 party_details.taxes = get_taxes_and_charges(master_doctype, default_tax)
209
pateljannatcd05b342020-11-19 11:37:08 +0530210 return party_details
Deepesh Garg6e2c13f2019-12-10 15:55:05 +0530211
Deepesh Garg15ff6a52020-02-18 12:28:41 +0530212def is_internal_transfer(party_details, doctype):
213 if doctype in ("Sales Invoice", "Delivery Note", "Sales Order"):
214 destination_gstin = party_details.company_gstin
215 elif doctype in ("Purchase Invoice", "Purchase Order", "Purchase Receipt"):
216 destination_gstin = party_details.supplier_gstin
217
218 if party_details.gstin == destination_gstin:
219 return True
220 else:
221 False
222
Deepesh Garg6e2c13f2019-12-10 15:55:05 +0530223def get_tax_template_based_on_category(master_doctype, company, party_details):
224 if not party_details.get('tax_category'):
225 return
226
227 default_tax = frappe.db.get_value(master_doctype, {'company': company, 'tax_category': party_details.get('tax_category')},
228 'name')
229
230 if default_tax:
231 party_details["taxes_and_charges"] = default_tax
232 party_details.taxes = get_taxes_and_charges(master_doctype, default_tax)
233
234def get_tax_template(master_doctype, company, is_inter_state, state_code):
235 tax_categories = frappe.get_all('Tax Category', fields = ['name', 'is_inter_state', 'gst_state'],
236 filters = {'is_inter_state': is_inter_state})
237
238 default_tax = ''
239
240 for tax_category in tax_categories:
241 if tax_category.gst_state == number_state_mapping[state_code] or \
242 (not default_tax and not tax_category.gst_state):
243 default_tax = frappe.db.get_value(master_doctype,
Deepesh Garg59ccb642020-11-05 16:29:34 +0530244 {'company': company, 'disabled': 0, 'tax_category': tax_category.name}, 'name')
Deepesh Garg6e2c13f2019-12-10 15:55:05 +0530245 return default_tax
246
247def get_tax_template_for_sez(party_details, master_doctype, company, party_type):
248
249 gst_details = frappe.db.get_value(party_type, {'name': party_details.get(frappe.scrub(party_type))},
250 ['gst_category', 'export_type'], as_dict=1)
251
252 if gst_details:
253 if gst_details.gst_category == 'SEZ' and gst_details.export_type == 'With Payment of Tax':
254 default_tax = frappe.db.get_value(master_doctype, {"company": company, "is_inter_state":1, "disabled":0,
255 "gst_state": number_state_mapping[party_details.company_gstin[:2]]})
256
257 party_details["taxes_and_charges"] = default_tax
258 party_details.taxes = get_taxes_and_charges(master_doctype, default_tax)
259
Ranjith Kurungadama8e047a2018-06-14 17:56:16 +0530260
261def calculate_annual_eligible_hra_exemption(doc):
Nabin Hait10df3d52020-05-14 17:15:16 +0530262 basic_component, hra_component = frappe.db.get_value('Company', doc.company, ["basic_component", "hra_component"])
Nabin Hait04e7bf42019-04-25 18:44:10 +0530263 if not (basic_component and hra_component):
264 frappe.throw(_("Please mention Basic and HRA component in Company"))
Ranjith Kurungadama8e047a2018-06-14 17:56:16 +0530265 annual_exemption, monthly_exemption, hra_amount = 0, 0, 0
Ranjith Kurungadamb1a756c2018-07-01 16:42:38 +0530266 if hra_component and basic_component:
Nabin Hait04e7bf42019-04-25 18:44:10 +0530267 assignment = get_salary_assignment(doc.employee, nowdate())
Nabin Hait04e7bf42019-04-25 18:44:10 +0530268 if assignment:
269 hra_component_exists = frappe.db.exists("Salary Detail", {
270 "parent": assignment.salary_structure,
271 "salary_component": hra_component,
272 "parentfield": "earnings",
273 "parenttype": "Salary Structure"
274 })
Nabin Hait6b9d64c2019-05-16 11:23:04 +0530275
Nabin Hait04e7bf42019-04-25 18:44:10 +0530276 if hra_component_exists:
277 basic_amount, hra_amount = get_component_amt_from_salary_slip(doc.employee,
278 assignment.salary_structure, basic_component, hra_component)
279 if hra_amount:
280 if doc.monthly_house_rent:
281 annual_exemption = calculate_hra_exemption(assignment.salary_structure,
Nabin Hait6b9d64c2019-05-16 11:23:04 +0530282 basic_amount, hra_amount, doc.monthly_house_rent, doc.rented_in_metro_city)
Nabin Hait04e7bf42019-04-25 18:44:10 +0530283 if annual_exemption > 0:
284 monthly_exemption = annual_exemption / 12
285 else:
286 annual_exemption = 0
Nabin Hait6b9d64c2019-05-16 11:23:04 +0530287
Nabin Hait04e7bf42019-04-25 18:44:10 +0530288 elif doc.docstatus == 1:
289 frappe.throw(_("Salary Structure must be submitted before submission of Tax Ememption Declaration"))
290
291 return frappe._dict({
292 "hra_amount": hra_amount,
293 "annual_exemption": annual_exemption,
294 "monthly_exemption": monthly_exemption
295 })
Ranjith Kurungadama8e047a2018-06-14 17:56:16 +0530296
Ranjith Kurungadamb1a756c2018-07-01 16:42:38 +0530297def get_component_amt_from_salary_slip(employee, salary_structure, basic_component, hra_component):
Anurag Mishra33793d42020-04-29 11:48:41 +0530298 salary_slip = make_salary_slip(salary_structure, employee=employee, for_preview=1, ignore_permissions=True)
Ranjith Kurungadamb1a756c2018-07-01 16:42:38 +0530299 basic_amt, hra_amt = 0, 0
Ranjith Kurungadama8e047a2018-06-14 17:56:16 +0530300 for earning in salary_slip.earnings:
Ranjith Kurungadamb1a756c2018-07-01 16:42:38 +0530301 if earning.salary_component == basic_component:
302 basic_amt = earning.amount
303 elif earning.salary_component == hra_component:
304 hra_amt = earning.amount
305 if basic_amt and hra_amt:
306 return basic_amt, hra_amt
Ranjith Kurungadam14e94f82018-07-16 16:12:46 +0530307 return basic_amt, hra_amt
Ranjith Kurungadama8e047a2018-06-14 17:56:16 +0530308
Ranjith Kurungadamb1a756c2018-07-01 16:42:38 +0530309def calculate_hra_exemption(salary_structure, basic, monthly_hra, monthly_house_rent, rented_in_metro_city):
Ranjith Kurungadama8e047a2018-06-14 17:56:16 +0530310 # TODO make this configurable
311 exemptions = []
312 frequency = frappe.get_value("Salary Structure", salary_structure, "payroll_frequency")
313 # case 1: The actual amount allotted by the employer as the HRA.
314 exemptions.append(get_annual_component_pay(frequency, monthly_hra))
Nabin Hait04e7bf42019-04-25 18:44:10 +0530315
Ranjith Kurungadama8e047a2018-06-14 17:56:16 +0530316 actual_annual_rent = monthly_house_rent * 12
Ranjith Kurungadamb1a756c2018-07-01 16:42:38 +0530317 annual_basic = get_annual_component_pay(frequency, basic)
Nabin Hait04e7bf42019-04-25 18:44:10 +0530318
Ranjith Kurungadama8e047a2018-06-14 17:56:16 +0530319 # case 2: Actual rent paid less 10% of the basic salary.
Ranjith Kurungadamb1a756c2018-07-01 16:42:38 +0530320 exemptions.append(flt(actual_annual_rent) - flt(annual_basic * 0.1))
Ranjith Kurungadama8e047a2018-06-14 17:56:16 +0530321 # case 3: 50% of the basic salary, if the employee is staying in a metro city (40% for a non-metro city).
Ranjith Kurungadamb1a756c2018-07-01 16:42:38 +0530322 exemptions.append(annual_basic * 0.5 if rented_in_metro_city else annual_basic * 0.4)
Ranjith Kurungadama8e047a2018-06-14 17:56:16 +0530323 # return minimum of 3 cases
324 return min(exemptions)
325
326def get_annual_component_pay(frequency, amount):
327 if frequency == "Daily":
328 return amount * 365
329 elif frequency == "Weekly":
330 return amount * 52
331 elif frequency == "Fortnightly":
332 return amount * 26
333 elif frequency == "Monthly":
334 return amount * 12
335 elif frequency == "Bimonthly":
336 return amount * 6
337
338def validate_house_rent_dates(doc):
339 if not doc.rented_to_date or not doc.rented_from_date:
340 frappe.throw(_("House rented dates required for exemption calculation"))
Nabin Hait04e7bf42019-04-25 18:44:10 +0530341
Ranjith Kurungadama8e047a2018-06-14 17:56:16 +0530342 if date_diff(doc.rented_to_date, doc.rented_from_date) < 14:
343 frappe.throw(_("House rented dates should be atleast 15 days apart"))
Nabin Hait04e7bf42019-04-25 18:44:10 +0530344
345 proofs = frappe.db.sql("""
346 select name
347 from `tabEmployee Tax Exemption Proof Submission`
348 where
Nabin Hait49446ba2019-04-25 19:54:20 +0530349 docstatus=1 and employee=%(employee)s and payroll_period=%(payroll_period)s
350 and (rented_from_date between %(from_date)s and %(to_date)s or rented_to_date between %(from_date)s and %(to_date)s)
351 """, {
352 "employee": doc.employee,
353 "payroll_period": doc.payroll_period,
354 "from_date": doc.rented_from_date,
355 "to_date": doc.rented_to_date
356 })
Nabin Hait04e7bf42019-04-25 18:44:10 +0530357
Ranjith Kurungadama8e047a2018-06-14 17:56:16 +0530358 if proofs:
Nabin Hait49446ba2019-04-25 19:54:20 +0530359 frappe.throw(_("House rent paid days overlapping with {0}").format(proofs[0][0]))
Ranjith Kurungadama8e047a2018-06-14 17:56:16 +0530360
361def calculate_hra_exemption_for_period(doc):
362 monthly_rent, eligible_hra = 0, 0
363 if doc.house_rent_payment_amount:
364 validate_house_rent_dates(doc)
365 # TODO receive rented months or validate dates are start and end of months?
366 # Calc monthly rent, round to nearest .5
367 factor = flt(date_diff(doc.rented_to_date, doc.rented_from_date) + 1)/30
368 factor = round(factor * 2)/2
369 monthly_rent = doc.house_rent_payment_amount / factor
370 # update field used by calculate_annual_eligible_hra_exemption
371 doc.monthly_house_rent = monthly_rent
372 exemptions = calculate_annual_eligible_hra_exemption(doc)
373
374 if exemptions["monthly_exemption"]:
375 # calc total exemption amount
376 eligible_hra = exemptions["monthly_exemption"] * factor
Ranjith Kurungadam4f9744a2018-06-20 11:10:56 +0530377 exemptions["monthly_house_rent"] = monthly_rent
378 exemptions["total_eligible_hra_exemption"] = eligible_hra
379 return exemptions
Prasann Shah829172c2019-06-06 12:08:09 +0530380
Nabin Hait34c551d2019-07-03 10:34:31 +0530381def get_ewb_data(dt, dn):
Nabin Hait34c551d2019-07-03 10:34:31 +0530382
383 ewaybills = []
384 for doc_name in dn:
385 doc = frappe.get_doc(dt, doc_name)
386
Deepesh Garg15ff6a52020-02-18 12:28:41 +0530387 validate_doc(doc)
Nabin Hait34c551d2019-07-03 10:34:31 +0530388
389 data = frappe._dict({
390 "transporterId": "",
391 "TotNonAdvolVal": 0,
392 })
393
394 data.userGstin = data.fromGstin = doc.company_gstin
395 data.supplyType = 'O'
396
Deepesh Garg15ff6a52020-02-18 12:28:41 +0530397 if dt == 'Delivery Note':
398 data.subSupplyType = 1
399 elif doc.gst_category in ['Registered Regular', 'SEZ']:
Nabin Hait34c551d2019-07-03 10:34:31 +0530400 data.subSupplyType = 1
401 elif doc.gst_category in ['Overseas', 'Deemed Export']:
402 data.subSupplyType = 3
403 else:
Deepesh Gargcce3ac92020-02-02 21:25:58 +0530404 frappe.throw(_('Unsupported GST Category for E-Way Bill JSON generation'))
Nabin Hait34c551d2019-07-03 10:34:31 +0530405
406 data.docType = 'INV'
407 data.docDate = frappe.utils.formatdate(doc.posting_date, 'dd/mm/yyyy')
408
409 company_address = frappe.get_doc('Address', doc.company_address)
410 billing_address = frappe.get_doc('Address', doc.customer_address)
411
412 shipping_address = frappe.get_doc('Address', doc.shipping_address_name)
413
414 data = get_address_details(data, doc, company_address, billing_address)
415
416 data.itemList = []
417 data.totalValue = doc.total
418
419 data = get_item_list(data, doc)
420
421 disable_rounded = frappe.db.get_single_value('Global Defaults', 'disable_rounded_total')
422 data.totInvValue = doc.grand_total if disable_rounded else doc.rounded_total
423
424 data = get_transport_details(data, doc)
425
426 fields = {
427 "/. -": {
428 'docNo': doc.name,
429 'fromTrdName': doc.company,
430 'toTrdName': doc.customer_name,
431 'transDocNo': doc.lr_no,
432 },
433 "@#/,&. -": {
434 'fromAddr1': company_address.address_line1,
435 'fromAddr2': company_address.address_line2,
436 'fromPlace': company_address.city,
437 'toAddr1': shipping_address.address_line1,
438 'toAddr2': shipping_address.address_line2,
439 'toPlace': shipping_address.city,
440 'transporterName': doc.transporter_name
441 }
442 }
443
444 for allowed_chars, field_map in fields.items():
445 for key, value in field_map.items():
446 if not value:
447 data[key] = ''
448 else:
449 data[key] = re.sub(r'[^\w' + allowed_chars + ']', '', value)
450
451 ewaybills.append(data)
452
453 data = {
454 'version': '1.0.1118',
455 'billLists': ewaybills
456 }
457
458 return data
459
460@frappe.whitelist()
461def generate_ewb_json(dt, dn):
Deepesh Garg00ea59b2020-04-27 10:50:40 +0530462 dn = json.loads(dn)
463 return get_ewb_data(dt, dn)
Nabin Hait34c551d2019-07-03 10:34:31 +0530464
Deepesh Garg00ea59b2020-04-27 10:50:40 +0530465@frappe.whitelist()
466def download_ewb_json():
Sagar Vorac9b4ba62020-07-11 17:44:20 +0530467 data = json.loads(frappe.local.form_dict.data)
468 frappe.local.response.filecontent = json.dumps(data, indent=4, sort_keys=True)
Nabin Hait34c551d2019-07-03 10:34:31 +0530469 frappe.local.response.type = 'download'
470
Sagar Vorac9b4ba62020-07-11 17:44:20 +0530471 filename_prefix = 'Bulk'
472 docname = frappe.local.form_dict.docname
473 if docname:
474 if docname.startswith('['):
475 docname = json.loads(docname)
476 if len(docname) == 1:
477 docname = docname[0]
Deepesh Garg00ea59b2020-04-27 10:50:40 +0530478
Sagar Vorac9b4ba62020-07-11 17:44:20 +0530479 if not isinstance(docname, list):
480 # removes characters not allowed in a filename (https://stackoverflow.com/a/38766141/4767738)
481 filename_prefix = re.sub('[^\w_.)( -]', '', docname)
Nabin Hait34c551d2019-07-03 10:34:31 +0530482
Sagar Vorac9b4ba62020-07-11 17:44:20 +0530483 frappe.local.response.filename = '{0}_e-WayBill_Data_{1}.json'.format(filename_prefix, frappe.utils.random_string(5))
Nabin Hait34c551d2019-07-03 10:34:31 +0530484
Prasann Shah829172c2019-06-06 12:08:09 +0530485@frappe.whitelist()
486def get_gstins_for_company(company):
487 company_gstins =[]
488 if company:
489 company_gstins = frappe.db.sql("""select
490 distinct `tabAddress`.gstin
491 from
492 `tabAddress`, `tabDynamic Link`
493 where
494 `tabDynamic Link`.parent = `tabAddress`.name and
495 `tabDynamic Link`.parenttype = 'Address' and
496 `tabDynamic Link`.link_doctype = 'Company' and
Don-Leopardo2b6a20a2020-03-16 14:06:44 -0300497 `tabDynamic Link`.link_name = %(company)s""", {"company": company})
Prasann Shah829172c2019-06-06 12:08:09 +0530498 return company_gstins
499
Nabin Hait34c551d2019-07-03 10:34:31 +0530500def get_address_details(data, doc, company_address, billing_address):
501 data.fromPincode = validate_pincode(company_address.pincode, 'Company Address')
502 data.fromStateCode = data.actualFromStateCode = validate_state_code(
503 company_address.gst_state_number, 'Company Address')
504
505 if not doc.billing_address_gstin or len(doc.billing_address_gstin) < 15:
506 data.toGstin = 'URP'
507 set_gst_state_and_state_number(billing_address)
508 else:
509 data.toGstin = doc.billing_address_gstin
510
511 data.toPincode = validate_pincode(billing_address.pincode, 'Customer Address')
512 data.toStateCode = validate_state_code(billing_address.gst_state_number, 'Customer Address')
513
514 if doc.customer_address != doc.shipping_address_name:
515 data.transType = 2
516 shipping_address = frappe.get_doc('Address', doc.shipping_address_name)
517 set_gst_state_and_state_number(shipping_address)
518 data.toPincode = validate_pincode(shipping_address.pincode, 'Shipping Address')
519 data.actualToStateCode = validate_state_code(shipping_address.gst_state_number, 'Shipping Address')
520 else:
521 data.transType = 1
522 data.actualToStateCode = data.toStateCode
523 shipping_address = billing_address
Deepesh Gargd07447a2020-11-24 08:09:17 +0530524
Smit Vorabbe49332020-11-18 20:58:59 +0530525 if doc.gst_category == 'SEZ':
526 data.toStateCode = 99
Nabin Hait34c551d2019-07-03 10:34:31 +0530527
528 return data
529
530def get_item_list(data, doc):
531 for attr in ['cgstValue', 'sgstValue', 'igstValue', 'cessValue', 'OthValue']:
532 data[attr] = 0
533
534 gst_accounts = get_gst_accounts(doc.company, account_wise=True)
535 tax_map = {
536 'sgst_account': ['sgstRate', 'sgstValue'],
537 'cgst_account': ['cgstRate', 'cgstValue'],
538 'igst_account': ['igstRate', 'igstValue'],
539 'cess_account': ['cessRate', 'cessValue']
540 }
541 item_data_attrs = ['sgstRate', 'cgstRate', 'igstRate', 'cessRate', 'cessNonAdvol']
542 hsn_wise_charges, hsn_taxable_amount = get_itemised_tax_breakup_data(doc, account_wise=True)
543 for hsn_code, taxable_amount in hsn_taxable_amount.items():
544 item_data = frappe._dict()
545 if not hsn_code:
546 frappe.throw(_('GST HSN Code does not exist for one or more items'))
547 item_data.hsnCode = int(hsn_code)
548 item_data.taxableAmount = taxable_amount
549 item_data.qtyUnit = ""
550 for attr in item_data_attrs:
551 item_data[attr] = 0
552
553 for account, tax_detail in hsn_wise_charges.get(hsn_code, {}).items():
554 account_type = gst_accounts.get(account, '')
555 for tax_acc, attrs in tax_map.items():
556 if account_type == tax_acc:
557 item_data[attrs[0]] = tax_detail.get('tax_rate')
558 data[attrs[1]] += tax_detail.get('tax_amount')
559 break
560 else:
561 data.OthValue += tax_detail.get('tax_amount')
562
563 data.itemList.append(item_data)
564
565 # Tax amounts rounded to 2 decimals to avoid exceeding max character limit
566 for attr in ['sgstValue', 'cgstValue', 'igstValue', 'cessValue']:
567 data[attr] = flt(data[attr], 2)
568
569 return data
570
Deepesh Garg15ff6a52020-02-18 12:28:41 +0530571def validate_doc(doc):
Nabin Hait34c551d2019-07-03 10:34:31 +0530572 if doc.docstatus != 1:
Deepesh Gargcce3ac92020-02-02 21:25:58 +0530573 frappe.throw(_('E-Way Bill JSON can only be generated from submitted document'))
Nabin Hait34c551d2019-07-03 10:34:31 +0530574
575 if doc.is_return:
Deepesh Gargcce3ac92020-02-02 21:25:58 +0530576 frappe.throw(_('E-Way Bill JSON cannot be generated for Sales Return as of now'))
Nabin Hait34c551d2019-07-03 10:34:31 +0530577
578 if doc.ewaybill:
579 frappe.throw(_('e-Way Bill already exists for this document'))
580
581 reqd_fields = ['company_gstin', 'company_address', 'customer_address',
582 'shipping_address_name', 'mode_of_transport', 'distance']
583
584 for fieldname in reqd_fields:
585 if not doc.get(fieldname):
Deepesh Gargcce3ac92020-02-02 21:25:58 +0530586 frappe.throw(_('{} is required to generate E-Way Bill JSON').format(
Nabin Hait34c551d2019-07-03 10:34:31 +0530587 doc.meta.get_label(fieldname)
Suraj Shettyda2c69e2020-01-29 15:34:06 +0530588 ))
Nabin Hait34c551d2019-07-03 10:34:31 +0530589
590 if len(doc.company_gstin) < 15:
591 frappe.throw(_('You must be a registered supplier to generate e-Way Bill'))
592
593def get_transport_details(data, doc):
594 if doc.distance > 4000:
595 frappe.throw(_('Distance cannot be greater than 4000 kms'))
596
597 data.transDistance = int(round(doc.distance))
598
599 transport_modes = {
600 'Road': 1,
601 'Rail': 2,
602 'Air': 3,
603 'Ship': 4
604 }
605
606 vehicle_types = {
607 'Regular': 'R',
608 'Over Dimensional Cargo (ODC)': 'O'
609 }
610
611 data.transMode = transport_modes.get(doc.mode_of_transport)
612
613 if doc.mode_of_transport == 'Road':
614 if not doc.gst_transporter_id and not doc.vehicle_no:
615 frappe.throw(_('Either GST Transporter ID or Vehicle No is required if Mode of Transport is Road'))
616 if doc.vehicle_no:
617 data.vehicleNo = doc.vehicle_no.replace(' ', '')
618 if not doc.gst_vehicle_type:
619 frappe.throw(_('Vehicle Type is required if Mode of Transport is Road'))
620 else:
621 data.vehicleType = vehicle_types.get(doc.gst_vehicle_type)
622 else:
623 if not doc.lr_no or not doc.lr_date:
624 frappe.throw(_('Transport Receipt No and Date are mandatory for your chosen Mode of Transport'))
625
626 if doc.lr_no:
627 data.transDocNo = doc.lr_no
628
629 if doc.lr_date:
630 data.transDocDate = frappe.utils.formatdate(doc.lr_date, 'dd/mm/yyyy')
631
632 if doc.gst_transporter_id:
karthikeyan5ca46bed2020-05-30 15:00:56 +0530633 if doc.gst_transporter_id[0:2] != "88":
634 validate_gstin_check_digit(doc.gst_transporter_id, label='GST Transporter ID')
635 data.transporterId = doc.gst_transporter_id
Nabin Hait34c551d2019-07-03 10:34:31 +0530636
637 return data
638
639
640def validate_pincode(pincode, address):
641 pin_not_found = "Pin Code doesn't exist for {}"
642 incorrect_pin = "Pin Code for {} is incorrecty formatted. It must be 6 digits (without spaces)"
643
644 if not pincode:
645 frappe.throw(_(pin_not_found.format(address)))
646
647 pincode = pincode.replace(' ', '')
648 if not pincode.isdigit() or len(pincode) != 6:
649 frappe.throw(_(incorrect_pin.format(address)))
650 else:
651 return int(pincode)
652
653def validate_state_code(state_code, address):
654 no_state_code = "GST State Code not found for {0}. Please set GST State in {0}"
655 if not state_code:
656 frappe.throw(_(no_state_code.format(address)))
657 else:
658 return int(state_code)
659
Deepesh Garg3c004ad2020-07-02 21:18:29 +0530660@frappe.whitelist()
Nabin Hait34c551d2019-07-03 10:34:31 +0530661def get_gst_accounts(company, account_wise=False):
662 gst_accounts = frappe._dict()
663 gst_settings_accounts = frappe.get_all("GST Account",
664 filters={"parent": "GST Settings", "company": company},
665 fields=["cgst_account", "sgst_account", "igst_account", "cess_account"])
666
Deepesh Garg6e2c13f2019-12-10 15:55:05 +0530667 if not gst_settings_accounts and not frappe.flags.in_test:
Nabin Hait34c551d2019-07-03 10:34:31 +0530668 frappe.throw(_("Please set GST Accounts in GST Settings"))
669
670 for d in gst_settings_accounts:
671 for acc, val in d.items():
672 if not account_wise:
673 gst_accounts.setdefault(acc, []).append(val)
674 elif val:
675 gst_accounts[val] = acc
676
Nabin Hait34c551d2019-07-03 10:34:31 +0530677 return gst_accounts
Deepesh Garg24f9a802020-06-03 10:59:37 +0530678
Deepesh Garg3c004ad2020-07-02 21:18:29 +0530679def update_grand_total_for_rcm(doc, method):
Deepesh Garg52c319c2020-07-15 23:57:03 +0530680 country = frappe.get_cached_value('Company', doc.company, 'country')
681
682 if country != 'India':
683 return
684
Deepesh Garg8aed48f2020-08-19 18:30:18 +0530685 if not doc.total_taxes_and_charges:
686 return
687
Deepesh Garg3c004ad2020-07-02 21:18:29 +0530688 if doc.reverse_charge == 'Y':
689 gst_accounts = get_gst_accounts(doc.company)
690 gst_account_list = gst_accounts.get('cgst_account') + gst_accounts.get('sgst_account') \
691 + gst_accounts.get('igst_account')
692
Deepesh Garg1c146062020-08-18 19:32:52 +0530693 base_gst_tax = 0
Deepesh Garg3c004ad2020-07-02 21:18:29 +0530694 gst_tax = 0
Deepesh Garg1c146062020-08-18 19:32:52 +0530695
Deepesh Garg3c004ad2020-07-02 21:18:29 +0530696 for tax in doc.get('taxes'):
697 if tax.category not in ("Total", "Valuation and Total"):
698 continue
699
700 if flt(tax.base_tax_amount_after_discount_amount) and tax.account_head in gst_account_list:
Deepesh Garg1c146062020-08-18 19:32:52 +0530701 base_gst_tax += tax.base_tax_amount_after_discount_amount
702 gst_tax += tax.tax_amount_after_discount_amount
Deepesh Garg3c004ad2020-07-02 21:18:29 +0530703
704 doc.taxes_and_charges_added -= gst_tax
705 doc.total_taxes_and_charges -= gst_tax
Deepesh Garg1c146062020-08-18 19:32:52 +0530706 doc.base_taxes_and_charges_added -= base_gst_tax
707 doc.base_total_taxes_and_charges -= base_gst_tax
Deepesh Garg3c004ad2020-07-02 21:18:29 +0530708
Deepesh Garg1c146062020-08-18 19:32:52 +0530709 update_totals(gst_tax, base_gst_tax, doc)
Deepesh Garg3c004ad2020-07-02 21:18:29 +0530710
Deepesh Garg1c146062020-08-18 19:32:52 +0530711def update_totals(gst_tax, base_gst_tax, doc):
712 doc.base_grand_total -= base_gst_tax
Deepesh Garg3c004ad2020-07-02 21:18:29 +0530713 doc.grand_total -= gst_tax
714
715 if doc.meta.get_field("rounded_total"):
716 if doc.is_rounded_total_disabled():
717 doc.outstanding_amount = doc.grand_total
718 else:
719 doc.rounded_total = round_based_on_smallest_currency_fraction(doc.grand_total,
720 doc.currency, doc.precision("rounded_total"))
721
722 doc.rounding_adjustment += flt(doc.rounded_total - doc.grand_total,
723 doc.precision("rounding_adjustment"))
724
Deepesh Garg18827352020-07-17 11:31:15 +0530725 doc.outstanding_amount = doc.rounded_total or doc.grand_total
Deepesh Garg3c004ad2020-07-02 21:18:29 +0530726
727 doc.in_words = money_in_words(doc.grand_total, doc.currency)
Deepesh Garg1c146062020-08-18 19:32:52 +0530728 doc.base_in_words = money_in_words(doc.base_grand_total, erpnext.get_company_currency(doc.company))
Deepesh Garg18827352020-07-17 11:31:15 +0530729 doc.set_payment_schedule()
Deepesh Garg3c004ad2020-07-02 21:18:29 +0530730
731def make_regional_gl_entries(gl_entries, doc):
Deepesh Garg24f9a802020-06-03 10:59:37 +0530732 country = frappe.get_cached_value('Company', doc.company, 'country')
733
734 if country != 'India':
Deepesh Garg8aed48f2020-08-19 18:30:18 +0530735 return gl_entries
736
Deepesh Garg24f9a802020-06-03 10:59:37 +0530737 if doc.reverse_charge == 'Y':
Deepesh Garg24f9a802020-06-03 10:59:37 +0530738 gst_accounts = get_gst_accounts(doc.company)
739 gst_account_list = gst_accounts.get('cgst_account') + gst_accounts.get('sgst_account') \
740 + gst_accounts.get('igst_account')
741
742 for tax in doc.get('taxes'):
743 if tax.category not in ("Total", "Valuation and Total"):
744 continue
745
Deepesh Gargafd2dd32020-08-20 16:31:38 +0530746 dr_or_cr = "credit" if tax.add_deduct_tax == "Add" else "debit"
Deepesh Garg24f9a802020-06-03 10:59:37 +0530747 if flt(tax.base_tax_amount_after_discount_amount) and tax.account_head in gst_account_list:
748 account_currency = get_account_currency(tax.account_head)
749
750 gl_entries.append(doc.get_gl_dict(
751 {
752 "account": tax.account_head,
753 "cost_center": tax.cost_center,
754 "posting_date": doc.posting_date,
755 "against": doc.supplier,
Deepesh Gargafd2dd32020-08-20 16:31:38 +0530756 dr_or_cr: tax.base_tax_amount_after_discount_amount,
757 dr_or_cr + "_in_account_currency": tax.base_tax_amount_after_discount_amount \
Deepesh Garg24f9a802020-06-03 10:59:37 +0530758 if account_currency==doc.company_currency \
759 else tax.tax_amount_after_discount_amount
760 }, account_currency, item=tax)
761 )
762
Deepesh Gargd07447a2020-11-24 08:09:17 +0530763 return gl_entries