blob: 95ff29151688621c89a004dd1865bc185daa47c0 [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
Deepesh Garga7670852020-12-04 18:07:46 +053015from frappe.model.utils import get_fetch_values
Rushabh Mehtab3c8f442017-06-21 17:22:38 +053016
17def validate_gstin_for_india(doc, method):
rushin2908a209b2019-03-15 15:28:50 +053018 if hasattr(doc, 'gst_state') and doc.gst_state:
19 doc.gst_state_number = state_numbers[doc.gst_state]
FinByz Tech Pvt. Ltd237a8712019-01-22 20:49:06 +053020 if not hasattr(doc, 'gstin') or not doc.gstin:
Rushabh Mehtab3c8f442017-06-21 17:22:38 +053021 return
22
Deepesh Garg459155f2019-06-14 12:01:34 +053023 gst_category = []
24
25 if len(doc.links):
26 link_doctype = doc.links[0].get("link_doctype")
27 link_name = doc.links[0].get("link_name")
28
29 if link_doctype in ["Customer", "Supplier"]:
30 gst_category = frappe.db.get_value(link_doctype, {'name': link_name}, ['gst_category'])
31
Sagar Vorad75095b2019-01-23 14:40:01 +053032 doc.gstin = doc.gstin.upper().strip()
Sagar Vora07cf4e82019-01-10 11:07:51 +053033 if not doc.gstin or doc.gstin == 'NA':
34 return
Rushabh Mehtab3c8f442017-06-21 17:22:38 +053035
Sagar Vora07cf4e82019-01-10 11:07:51 +053036 if len(doc.gstin) != 15:
37 frappe.throw(_("Invalid GSTIN! A GSTIN must have 15 characters."))
Rushabh Mehtab3c8f442017-06-21 17:22:38 +053038
Deepesh Garg459155f2019-06-14 12:01:34 +053039 if gst_category and gst_category == 'UIN Holders':
40 p = re.compile("^[0-9]{4}[A-Z]{3}[0-9]{5}[0-9A-Z]{3}")
41 if not p.match(doc.gstin):
42 frappe.throw(_("Invalid GSTIN! The input you've entered doesn't match the GSTIN format for UIN Holders or Non-Resident OIDAR Service Providers"))
43 else:
44 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}$")
45 if not p.match(doc.gstin):
46 frappe.throw(_("Invalid GSTIN! The input you've entered doesn't match the format of GSTIN."))
Rushabh Mehta7231f292017-07-13 15:00:56 +053047
Deepesh Garg459155f2019-06-14 12:01:34 +053048 validate_gstin_check_digit(doc.gstin)
Nabin Hait34c551d2019-07-03 10:34:31 +053049 set_gst_state_and_state_number(doc)
Rushabh Mehtab3c8f442017-06-21 17:22:38 +053050
Deepesh Garg459155f2019-06-14 12:01:34 +053051 if doc.gst_state_number != doc.gstin[:2]:
52 frappe.throw(_("Invalid GSTIN! First 2 digits of GSTIN should match with State number {0}.")
53 .format(doc.gst_state_number))
Sagar Vora07cf4e82019-01-10 11:07:51 +053054
Deepesh Gargd07447a2020-11-24 08:09:17 +053055def validate_tax_category(doc, method):
Deepesh Garge77e3aa2020-12-17 18:46:59 +053056 if doc.get('gst_state') and frappe.db.get_value('Tax Category', {'gst_state': doc.gst_state, 'is_inter_state': doc.is_inter_state}):
Deepesh Gargd07447a2020-11-24 08:09:17 +053057 if doc.is_inter_state:
58 frappe.throw(_("Inter State tax category for GST State {0} already exists").format(doc.gst_state))
59 else:
60 frappe.throw(_("Intra State tax category for GST State {0} already exists").format(doc.gst_state))
61
Deepesh Garg6e2c13f2019-12-10 15:55:05 +053062def update_gst_category(doc, method):
63 for link in doc.links:
64 if link.link_doctype in ['Customer', 'Supplier']:
65 if doc.get('gstin'):
66 frappe.db.sql("""
67 UPDATE `tab{0}` SET gst_category = %s WHERE name = %s AND gst_category = 'Unregistered'
68 """.format(link.link_doctype), ("Registered Regular", link.link_name)) #nosec
69
Nabin Hait34c551d2019-07-03 10:34:31 +053070def set_gst_state_and_state_number(doc):
71 if not doc.gst_state:
72 if not doc.state:
73 return
74 state = doc.state.lower()
75 states_lowercase = {s.lower():s for s in states}
76 if state in states_lowercase:
77 doc.gst_state = states_lowercase[state]
78 else:
79 return
80
81 doc.gst_state_number = state_numbers[doc.gst_state]
82
83def validate_gstin_check_digit(gstin, label='GSTIN'):
Sagar Vora07cf4e82019-01-10 11:07:51 +053084 ''' Function to validate the check digit of the GSTIN.'''
karthikeyan52825b922019-01-09 19:15:10 +053085 factor = 1
86 total = 0
87 code_point_chars = '0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ'
karthikeyan52825b922019-01-09 19:15:10 +053088 mod = len(code_point_chars)
Sagar Vora07cf4e82019-01-10 11:07:51 +053089 input_chars = gstin[:-1]
karthikeyan52825b922019-01-09 19:15:10 +053090 for char in input_chars:
91 digit = factor * code_point_chars.find(char)
Sagar Vora07cf4e82019-01-10 11:07:51 +053092 digit = (digit // mod) + (digit % mod)
karthikeyan52825b922019-01-09 19:15:10 +053093 total += digit
94 factor = 2 if factor == 1 else 1
Sagar Vora07cf4e82019-01-10 11:07:51 +053095 if gstin[-1] != code_point_chars[((mod - (total % mod)) % mod)]:
Deepesh Gargd07447a2020-11-24 08:09:17 +053096 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 +053097
Nabin Haitb962fc12017-07-17 18:02:31 +053098def get_itemised_tax_breakup_header(item_doctype, tax_accounts):
99 if frappe.get_meta(item_doctype).has_field('gst_hsn_code'):
100 return [_("HSN/SAC"), _("Taxable Amount")] + tax_accounts
101 else:
102 return [_("Item"), _("Taxable Amount")] + tax_accounts
Nabin Haitb95ecd72018-02-16 13:19:04 +0530103
Nabin Hait34c551d2019-07-03 10:34:31 +0530104def get_itemised_tax_breakup_data(doc, account_wise=False):
105 itemised_tax = get_itemised_tax(doc.taxes, with_tax_account=account_wise)
Nabin Haitb962fc12017-07-17 18:02:31 +0530106
107 itemised_taxable_amount = get_itemised_taxable_amount(doc.items)
Nabin Haitb95ecd72018-02-16 13:19:04 +0530108
Nabin Haitb962fc12017-07-17 18:02:31 +0530109 if not frappe.get_meta(doc.doctype + " Item").has_field('gst_hsn_code'):
110 return itemised_tax, itemised_taxable_amount
111
112 item_hsn_map = frappe._dict()
113 for d in doc.items:
114 item_hsn_map.setdefault(d.item_code or d.item_name, d.get("gst_hsn_code"))
115
116 hsn_tax = {}
117 for item, taxes in itemised_tax.items():
118 hsn_code = item_hsn_map.get(item)
119 hsn_tax.setdefault(hsn_code, frappe._dict())
Nabin Hait34c551d2019-07-03 10:34:31 +0530120 for tax_desc, tax_detail in taxes.items():
121 key = tax_desc
122 if account_wise:
123 key = tax_detail.get('tax_account')
124 hsn_tax[hsn_code].setdefault(key, {"tax_rate": 0, "tax_amount": 0})
125 hsn_tax[hsn_code][key]["tax_rate"] = tax_detail.get("tax_rate")
126 hsn_tax[hsn_code][key]["tax_amount"] += tax_detail.get("tax_amount")
Nabin Haitb962fc12017-07-17 18:02:31 +0530127
128 # set taxable amount
129 hsn_taxable_amount = frappe._dict()
Nabin Hait34c551d2019-07-03 10:34:31 +0530130 for item in itemised_taxable_amount:
Nabin Haitb962fc12017-07-17 18:02:31 +0530131 hsn_code = item_hsn_map.get(item)
132 hsn_taxable_amount.setdefault(hsn_code, 0)
133 hsn_taxable_amount[hsn_code] += itemised_taxable_amount.get(item)
134
135 return hsn_tax, hsn_taxable_amount
136
Shreya Shah4fa600a2018-06-05 11:27:53 +0530137def set_place_of_supply(doc, method=None):
138 doc.place_of_supply = get_place_of_supply(doc, doc.doctype)
Nabin Haitb95ecd72018-02-16 13:19:04 +0530139
Rushabh Mehta7231f292017-07-13 15:00:56 +0530140# don't remove this function it is used in tests
141def test_method():
142 '''test function'''
Nabin Haitb95ecd72018-02-16 13:19:04 +0530143 return 'overridden'
Shreya Shah4fa600a2018-06-05 11:27:53 +0530144
Deepesh Garg6e2c13f2019-12-10 15:55:05 +0530145def get_place_of_supply(party_details, doctype):
Shreya Shah4fa600a2018-06-05 11:27:53 +0530146 if not frappe.get_meta('Address').has_field('gst_state'): return
147
Deepesh Garg6e2c13f2019-12-10 15:55:05 +0530148 if doctype in ("Sales Invoice", "Delivery Note", "Sales Order"):
Deepesh Gargeacfd792020-10-30 22:12:24 +0530149 address_name = party_details.customer_address or party_details.shipping_address_name
Deepesh Garg6e2c13f2019-12-10 15:55:05 +0530150 elif doctype in ("Purchase Invoice", "Purchase Order", "Purchase Receipt"):
151 address_name = party_details.shipping_address or party_details.supplier_address
Shreya Shah4fa600a2018-06-05 11:27:53 +0530152
153 if address_name:
Deepesh Garg15ff6a52020-02-18 12:28:41 +0530154 address = frappe.db.get_value("Address", address_name, ["gst_state", "gst_state_number", "gstin"], as_dict=1)
Rohit Waghchaureb6a735e2018-10-11 10:40:34 +0530155 if address and address.gst_state and address.gst_state_number:
Deepesh Garg15ff6a52020-02-18 12:28:41 +0530156 party_details.gstin = address.gstin
Nabin Hait2390da62018-08-30 16:16:35 +0530157 return cstr(address.gst_state_number) + "-" + cstr(address.gst_state)
Shreya Shah4fa600a2018-06-05 11:27:53 +0530158
Deepesh Garg6e2c13f2019-12-10 15:55:05 +0530159@frappe.whitelist()
pateljannat1d5d8632020-11-19 20:11:45 +0530160def get_regional_address_details(party_details, doctype, company):
Deepesh Garg6e2c13f2019-12-10 15:55:05 +0530161 if isinstance(party_details, string_types):
162 party_details = json.loads(party_details)
163 party_details = frappe._dict(party_details)
Shreya Shah4fa600a2018-06-05 11:27:53 +0530164
Deepesh Garga7670852020-12-04 18:07:46 +0530165 update_party_details(party_details, doctype)
166
Deepesh Garg6e2c13f2019-12-10 15:55:05 +0530167 party_details.place_of_supply = get_place_of_supply(party_details, doctype)
Deepesh Garg15ff6a52020-02-18 12:28:41 +0530168
169 if is_internal_transfer(party_details, doctype):
170 party_details.taxes_and_charges = ''
171 party_details.taxes = ''
pateljannatcd05b342020-11-19 11:37:08 +0530172 return party_details
Deepesh Garg15ff6a52020-02-18 12:28:41 +0530173
Deepesh Garg6e2c13f2019-12-10 15:55:05 +0530174 if doctype in ("Sales Invoice", "Delivery Note", "Sales Order"):
Shreya Shah4fa600a2018-06-05 11:27:53 +0530175 master_doctype = "Sales Taxes and Charges Template"
Deepesh Garg6e2c13f2019-12-10 15:55:05 +0530176
177 get_tax_template_for_sez(party_details, master_doctype, company, 'Customer')
178 get_tax_template_based_on_category(master_doctype, company, party_details)
179
pateljannatcd05b342020-11-19 11:37:08 +0530180 if party_details.get('taxes_and_charges'):
Deepesh Garg6e2c13f2019-12-10 15:55:05 +0530181 return party_details
182
183 if not party_details.company_gstin:
pateljannatcd05b342020-11-19 11:37:08 +0530184 return party_details
Shreya Shah4fa600a2018-06-05 11:27:53 +0530185
Deepesh Garg6e2c13f2019-12-10 15:55:05 +0530186 elif doctype in ("Purchase Invoice", "Purchase Order", "Purchase Receipt"):
187 master_doctype = "Purchase Taxes and Charges Template"
Deepesh Garg6e2c13f2019-12-10 15:55:05 +0530188 get_tax_template_for_sez(party_details, master_doctype, company, 'Supplier')
189 get_tax_template_based_on_category(master_doctype, company, party_details)
190
pateljannatcd05b342020-11-19 11:37:08 +0530191 if party_details.get('taxes_and_charges'):
Deepesh Garg6e2c13f2019-12-10 15:55:05 +0530192 return party_details
193
194 if not party_details.supplier_gstin:
pateljannatcd05b342020-11-19 11:37:08 +0530195 return party_details
Deepesh Garg6e2c13f2019-12-10 15:55:05 +0530196
pateljannatcd05b342020-11-19 11:37:08 +0530197 if not party_details.place_of_supply: return party_details
Deepesh Garg6e2c13f2019-12-10 15:55:05 +0530198
pateljannatcd05b342020-11-19 11:37:08 +0530199 if not party_details.company_gstin: return party_details
deepeshgarg007c58dc872019-12-12 14:55:57 +0530200
Deepesh Garg6e2c13f2019-12-10 15:55:05 +0530201 if ((doctype in ("Sales Invoice", "Delivery Note", "Sales Order") and party_details.company_gstin
202 and party_details.company_gstin[:2] != party_details.place_of_supply[:2]) or (doctype in ("Purchase Invoice",
203 "Purchase Order", "Purchase Receipt") and party_details.supplier_gstin and party_details.supplier_gstin[:2] != party_details.place_of_supply[:2])):
204 default_tax = get_tax_template(master_doctype, company, 1, party_details.company_gstin[:2])
Shreya Shah4fa600a2018-06-05 11:27:53 +0530205 else:
Deepesh Garg6e2c13f2019-12-10 15:55:05 +0530206 default_tax = get_tax_template(master_doctype, company, 0, party_details.company_gstin[:2])
Shreya Shah4fa600a2018-06-05 11:27:53 +0530207
208 if not default_tax:
pateljannatcd05b342020-11-19 11:37:08 +0530209 return party_details
Deepesh Garg6e2c13f2019-12-10 15:55:05 +0530210 party_details["taxes_and_charges"] = default_tax
211 party_details.taxes = get_taxes_and_charges(master_doctype, default_tax)
212
pateljannatcd05b342020-11-19 11:37:08 +0530213 return party_details
Deepesh Garg6e2c13f2019-12-10 15:55:05 +0530214
Deepesh Garga7670852020-12-04 18:07:46 +0530215def update_party_details(party_details, doctype):
216 for address_field in ['shipping_address', 'company_address', 'supplier_address', 'shipping_address_name', 'customer_address']:
217 if party_details.get(address_field):
218 party_details.update(get_fetch_values(doctype, address_field, party_details.get(address_field)))
Deepesh Garg6e2c13f2019-12-10 15:55:05 +0530219
Deepesh Garg15ff6a52020-02-18 12:28:41 +0530220def is_internal_transfer(party_details, doctype):
221 if doctype in ("Sales Invoice", "Delivery Note", "Sales Order"):
222 destination_gstin = party_details.company_gstin
223 elif doctype in ("Purchase Invoice", "Purchase Order", "Purchase Receipt"):
224 destination_gstin = party_details.supplier_gstin
225
226 if party_details.gstin == destination_gstin:
227 return True
228 else:
229 False
230
Deepesh Garg6e2c13f2019-12-10 15:55:05 +0530231def get_tax_template_based_on_category(master_doctype, company, party_details):
232 if not party_details.get('tax_category'):
233 return
234
235 default_tax = frappe.db.get_value(master_doctype, {'company': company, 'tax_category': party_details.get('tax_category')},
236 'name')
237
238 if default_tax:
239 party_details["taxes_and_charges"] = default_tax
240 party_details.taxes = get_taxes_and_charges(master_doctype, default_tax)
241
242def get_tax_template(master_doctype, company, is_inter_state, state_code):
243 tax_categories = frappe.get_all('Tax Category', fields = ['name', 'is_inter_state', 'gst_state'],
244 filters = {'is_inter_state': is_inter_state})
245
246 default_tax = ''
247
248 for tax_category in tax_categories:
249 if tax_category.gst_state == number_state_mapping[state_code] or \
250 (not default_tax and not tax_category.gst_state):
251 default_tax = frappe.db.get_value(master_doctype,
Deepesh Garg59ccb642020-11-05 16:29:34 +0530252 {'company': company, 'disabled': 0, 'tax_category': tax_category.name}, 'name')
Deepesh Garg6e2c13f2019-12-10 15:55:05 +0530253 return default_tax
254
255def get_tax_template_for_sez(party_details, master_doctype, company, party_type):
256
257 gst_details = frappe.db.get_value(party_type, {'name': party_details.get(frappe.scrub(party_type))},
258 ['gst_category', 'export_type'], as_dict=1)
259
260 if gst_details:
261 if gst_details.gst_category == 'SEZ' and gst_details.export_type == 'With Payment of Tax':
262 default_tax = frappe.db.get_value(master_doctype, {"company": company, "is_inter_state":1, "disabled":0,
263 "gst_state": number_state_mapping[party_details.company_gstin[:2]]})
264
265 party_details["taxes_and_charges"] = default_tax
266 party_details.taxes = get_taxes_and_charges(master_doctype, default_tax)
267
Ranjith Kurungadama8e047a2018-06-14 17:56:16 +0530268
269def calculate_annual_eligible_hra_exemption(doc):
Nabin Hait10df3d52020-05-14 17:15:16 +0530270 basic_component, hra_component = frappe.db.get_value('Company', doc.company, ["basic_component", "hra_component"])
Nabin Hait04e7bf42019-04-25 18:44:10 +0530271 if not (basic_component and hra_component):
272 frappe.throw(_("Please mention Basic and HRA component in Company"))
Ranjith Kurungadama8e047a2018-06-14 17:56:16 +0530273 annual_exemption, monthly_exemption, hra_amount = 0, 0, 0
Ranjith Kurungadamb1a756c2018-07-01 16:42:38 +0530274 if hra_component and basic_component:
Nabin Hait04e7bf42019-04-25 18:44:10 +0530275 assignment = get_salary_assignment(doc.employee, nowdate())
Nabin Hait04e7bf42019-04-25 18:44:10 +0530276 if assignment:
277 hra_component_exists = frappe.db.exists("Salary Detail", {
278 "parent": assignment.salary_structure,
279 "salary_component": hra_component,
280 "parentfield": "earnings",
281 "parenttype": "Salary Structure"
282 })
Nabin Hait6b9d64c2019-05-16 11:23:04 +0530283
Nabin Hait04e7bf42019-04-25 18:44:10 +0530284 if hra_component_exists:
285 basic_amount, hra_amount = get_component_amt_from_salary_slip(doc.employee,
286 assignment.salary_structure, basic_component, hra_component)
287 if hra_amount:
288 if doc.monthly_house_rent:
289 annual_exemption = calculate_hra_exemption(assignment.salary_structure,
Nabin Hait6b9d64c2019-05-16 11:23:04 +0530290 basic_amount, hra_amount, doc.monthly_house_rent, doc.rented_in_metro_city)
Nabin Hait04e7bf42019-04-25 18:44:10 +0530291 if annual_exemption > 0:
292 monthly_exemption = annual_exemption / 12
293 else:
294 annual_exemption = 0
Nabin Hait6b9d64c2019-05-16 11:23:04 +0530295
Nabin Hait04e7bf42019-04-25 18:44:10 +0530296 elif doc.docstatus == 1:
297 frappe.throw(_("Salary Structure must be submitted before submission of Tax Ememption Declaration"))
298
299 return frappe._dict({
300 "hra_amount": hra_amount,
301 "annual_exemption": annual_exemption,
302 "monthly_exemption": monthly_exemption
303 })
Ranjith Kurungadama8e047a2018-06-14 17:56:16 +0530304
Ranjith Kurungadamb1a756c2018-07-01 16:42:38 +0530305def get_component_amt_from_salary_slip(employee, salary_structure, basic_component, hra_component):
Anurag Mishra33793d42020-04-29 11:48:41 +0530306 salary_slip = make_salary_slip(salary_structure, employee=employee, for_preview=1, ignore_permissions=True)
Ranjith Kurungadamb1a756c2018-07-01 16:42:38 +0530307 basic_amt, hra_amt = 0, 0
Ranjith Kurungadama8e047a2018-06-14 17:56:16 +0530308 for earning in salary_slip.earnings:
Ranjith Kurungadamb1a756c2018-07-01 16:42:38 +0530309 if earning.salary_component == basic_component:
310 basic_amt = earning.amount
311 elif earning.salary_component == hra_component:
312 hra_amt = earning.amount
313 if basic_amt and hra_amt:
314 return basic_amt, hra_amt
Ranjith Kurungadam14e94f82018-07-16 16:12:46 +0530315 return basic_amt, hra_amt
Ranjith Kurungadama8e047a2018-06-14 17:56:16 +0530316
Ranjith Kurungadamb1a756c2018-07-01 16:42:38 +0530317def calculate_hra_exemption(salary_structure, basic, monthly_hra, monthly_house_rent, rented_in_metro_city):
Ranjith Kurungadama8e047a2018-06-14 17:56:16 +0530318 # TODO make this configurable
319 exemptions = []
320 frequency = frappe.get_value("Salary Structure", salary_structure, "payroll_frequency")
321 # case 1: The actual amount allotted by the employer as the HRA.
322 exemptions.append(get_annual_component_pay(frequency, monthly_hra))
Nabin Hait04e7bf42019-04-25 18:44:10 +0530323
Ranjith Kurungadama8e047a2018-06-14 17:56:16 +0530324 actual_annual_rent = monthly_house_rent * 12
Ranjith Kurungadamb1a756c2018-07-01 16:42:38 +0530325 annual_basic = get_annual_component_pay(frequency, basic)
Nabin Hait04e7bf42019-04-25 18:44:10 +0530326
Ranjith Kurungadama8e047a2018-06-14 17:56:16 +0530327 # case 2: Actual rent paid less 10% of the basic salary.
Ranjith Kurungadamb1a756c2018-07-01 16:42:38 +0530328 exemptions.append(flt(actual_annual_rent) - flt(annual_basic * 0.1))
Ranjith Kurungadama8e047a2018-06-14 17:56:16 +0530329 # 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 +0530330 exemptions.append(annual_basic * 0.5 if rented_in_metro_city else annual_basic * 0.4)
Ranjith Kurungadama8e047a2018-06-14 17:56:16 +0530331 # return minimum of 3 cases
332 return min(exemptions)
333
334def get_annual_component_pay(frequency, amount):
335 if frequency == "Daily":
336 return amount * 365
337 elif frequency == "Weekly":
338 return amount * 52
339 elif frequency == "Fortnightly":
340 return amount * 26
341 elif frequency == "Monthly":
342 return amount * 12
343 elif frequency == "Bimonthly":
344 return amount * 6
345
346def validate_house_rent_dates(doc):
347 if not doc.rented_to_date or not doc.rented_from_date:
348 frappe.throw(_("House rented dates required for exemption calculation"))
Nabin Hait04e7bf42019-04-25 18:44:10 +0530349
Ranjith Kurungadama8e047a2018-06-14 17:56:16 +0530350 if date_diff(doc.rented_to_date, doc.rented_from_date) < 14:
351 frappe.throw(_("House rented dates should be atleast 15 days apart"))
Nabin Hait04e7bf42019-04-25 18:44:10 +0530352
353 proofs = frappe.db.sql("""
354 select name
355 from `tabEmployee Tax Exemption Proof Submission`
356 where
Nabin Hait49446ba2019-04-25 19:54:20 +0530357 docstatus=1 and employee=%(employee)s and payroll_period=%(payroll_period)s
358 and (rented_from_date between %(from_date)s and %(to_date)s or rented_to_date between %(from_date)s and %(to_date)s)
359 """, {
360 "employee": doc.employee,
361 "payroll_period": doc.payroll_period,
362 "from_date": doc.rented_from_date,
363 "to_date": doc.rented_to_date
364 })
Nabin Hait04e7bf42019-04-25 18:44:10 +0530365
Ranjith Kurungadama8e047a2018-06-14 17:56:16 +0530366 if proofs:
Nabin Hait49446ba2019-04-25 19:54:20 +0530367 frappe.throw(_("House rent paid days overlapping with {0}").format(proofs[0][0]))
Ranjith Kurungadama8e047a2018-06-14 17:56:16 +0530368
369def calculate_hra_exemption_for_period(doc):
370 monthly_rent, eligible_hra = 0, 0
371 if doc.house_rent_payment_amount:
372 validate_house_rent_dates(doc)
373 # TODO receive rented months or validate dates are start and end of months?
374 # Calc monthly rent, round to nearest .5
375 factor = flt(date_diff(doc.rented_to_date, doc.rented_from_date) + 1)/30
376 factor = round(factor * 2)/2
377 monthly_rent = doc.house_rent_payment_amount / factor
378 # update field used by calculate_annual_eligible_hra_exemption
379 doc.monthly_house_rent = monthly_rent
380 exemptions = calculate_annual_eligible_hra_exemption(doc)
381
382 if exemptions["monthly_exemption"]:
383 # calc total exemption amount
384 eligible_hra = exemptions["monthly_exemption"] * factor
Ranjith Kurungadam4f9744a2018-06-20 11:10:56 +0530385 exemptions["monthly_house_rent"] = monthly_rent
386 exemptions["total_eligible_hra_exemption"] = eligible_hra
387 return exemptions
Prasann Shah829172c2019-06-06 12:08:09 +0530388
Nabin Hait34c551d2019-07-03 10:34:31 +0530389def get_ewb_data(dt, dn):
Nabin Hait34c551d2019-07-03 10:34:31 +0530390
391 ewaybills = []
392 for doc_name in dn:
393 doc = frappe.get_doc(dt, doc_name)
394
Deepesh Garg15ff6a52020-02-18 12:28:41 +0530395 validate_doc(doc)
Nabin Hait34c551d2019-07-03 10:34:31 +0530396
397 data = frappe._dict({
398 "transporterId": "",
399 "TotNonAdvolVal": 0,
400 })
401
402 data.userGstin = data.fromGstin = doc.company_gstin
403 data.supplyType = 'O'
404
Deepesh Garg15ff6a52020-02-18 12:28:41 +0530405 if dt == 'Delivery Note':
406 data.subSupplyType = 1
407 elif doc.gst_category in ['Registered Regular', 'SEZ']:
Nabin Hait34c551d2019-07-03 10:34:31 +0530408 data.subSupplyType = 1
409 elif doc.gst_category in ['Overseas', 'Deemed Export']:
410 data.subSupplyType = 3
411 else:
Deepesh Gargcce3ac92020-02-02 21:25:58 +0530412 frappe.throw(_('Unsupported GST Category for E-Way Bill JSON generation'))
Nabin Hait34c551d2019-07-03 10:34:31 +0530413
414 data.docType = 'INV'
415 data.docDate = frappe.utils.formatdate(doc.posting_date, 'dd/mm/yyyy')
416
417 company_address = frappe.get_doc('Address', doc.company_address)
418 billing_address = frappe.get_doc('Address', doc.customer_address)
419
420 shipping_address = frappe.get_doc('Address', doc.shipping_address_name)
421
422 data = get_address_details(data, doc, company_address, billing_address)
423
424 data.itemList = []
425 data.totalValue = doc.total
426
427 data = get_item_list(data, doc)
428
429 disable_rounded = frappe.db.get_single_value('Global Defaults', 'disable_rounded_total')
430 data.totInvValue = doc.grand_total if disable_rounded else doc.rounded_total
431
432 data = get_transport_details(data, doc)
433
434 fields = {
435 "/. -": {
436 'docNo': doc.name,
437 'fromTrdName': doc.company,
438 'toTrdName': doc.customer_name,
439 'transDocNo': doc.lr_no,
440 },
441 "@#/,&. -": {
442 'fromAddr1': company_address.address_line1,
443 'fromAddr2': company_address.address_line2,
444 'fromPlace': company_address.city,
445 'toAddr1': shipping_address.address_line1,
446 'toAddr2': shipping_address.address_line2,
447 'toPlace': shipping_address.city,
448 'transporterName': doc.transporter_name
449 }
450 }
451
452 for allowed_chars, field_map in fields.items():
453 for key, value in field_map.items():
454 if not value:
455 data[key] = ''
456 else:
457 data[key] = re.sub(r'[^\w' + allowed_chars + ']', '', value)
458
459 ewaybills.append(data)
460
461 data = {
462 'version': '1.0.1118',
463 'billLists': ewaybills
464 }
465
466 return data
467
468@frappe.whitelist()
469def generate_ewb_json(dt, dn):
Deepesh Garg00ea59b2020-04-27 10:50:40 +0530470 dn = json.loads(dn)
471 return get_ewb_data(dt, dn)
Nabin Hait34c551d2019-07-03 10:34:31 +0530472
Deepesh Garg00ea59b2020-04-27 10:50:40 +0530473@frappe.whitelist()
474def download_ewb_json():
Sagar Vorac9b4ba62020-07-11 17:44:20 +0530475 data = json.loads(frappe.local.form_dict.data)
476 frappe.local.response.filecontent = json.dumps(data, indent=4, sort_keys=True)
Nabin Hait34c551d2019-07-03 10:34:31 +0530477 frappe.local.response.type = 'download'
478
Sagar Vorac9b4ba62020-07-11 17:44:20 +0530479 filename_prefix = 'Bulk'
480 docname = frappe.local.form_dict.docname
481 if docname:
482 if docname.startswith('['):
483 docname = json.loads(docname)
484 if len(docname) == 1:
485 docname = docname[0]
Deepesh Garg00ea59b2020-04-27 10:50:40 +0530486
Sagar Vorac9b4ba62020-07-11 17:44:20 +0530487 if not isinstance(docname, list):
488 # removes characters not allowed in a filename (https://stackoverflow.com/a/38766141/4767738)
489 filename_prefix = re.sub('[^\w_.)( -]', '', docname)
Nabin Hait34c551d2019-07-03 10:34:31 +0530490
Sagar Vorac9b4ba62020-07-11 17:44:20 +0530491 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 +0530492
Prasann Shah829172c2019-06-06 12:08:09 +0530493@frappe.whitelist()
494def get_gstins_for_company(company):
495 company_gstins =[]
496 if company:
497 company_gstins = frappe.db.sql("""select
498 distinct `tabAddress`.gstin
499 from
500 `tabAddress`, `tabDynamic Link`
501 where
502 `tabDynamic Link`.parent = `tabAddress`.name and
503 `tabDynamic Link`.parenttype = 'Address' and
504 `tabDynamic Link`.link_doctype = 'Company' and
Don-Leopardo2b6a20a2020-03-16 14:06:44 -0300505 `tabDynamic Link`.link_name = %(company)s""", {"company": company})
Prasann Shah829172c2019-06-06 12:08:09 +0530506 return company_gstins
507
Nabin Hait34c551d2019-07-03 10:34:31 +0530508def get_address_details(data, doc, company_address, billing_address):
509 data.fromPincode = validate_pincode(company_address.pincode, 'Company Address')
510 data.fromStateCode = data.actualFromStateCode = validate_state_code(
511 company_address.gst_state_number, 'Company Address')
512
513 if not doc.billing_address_gstin or len(doc.billing_address_gstin) < 15:
514 data.toGstin = 'URP'
515 set_gst_state_and_state_number(billing_address)
516 else:
517 data.toGstin = doc.billing_address_gstin
518
519 data.toPincode = validate_pincode(billing_address.pincode, 'Customer Address')
520 data.toStateCode = validate_state_code(billing_address.gst_state_number, 'Customer Address')
521
522 if doc.customer_address != doc.shipping_address_name:
523 data.transType = 2
524 shipping_address = frappe.get_doc('Address', doc.shipping_address_name)
525 set_gst_state_and_state_number(shipping_address)
526 data.toPincode = validate_pincode(shipping_address.pincode, 'Shipping Address')
527 data.actualToStateCode = validate_state_code(shipping_address.gst_state_number, 'Shipping Address')
528 else:
529 data.transType = 1
530 data.actualToStateCode = data.toStateCode
531 shipping_address = billing_address
532
Smit Vorabbe49332020-11-18 20:58:59 +0530533 if doc.gst_category == 'SEZ':
534 data.toStateCode = 99
Nabin Hait34c551d2019-07-03 10:34:31 +0530535
536 return data
537
538def get_item_list(data, doc):
539 for attr in ['cgstValue', 'sgstValue', 'igstValue', 'cessValue', 'OthValue']:
540 data[attr] = 0
541
542 gst_accounts = get_gst_accounts(doc.company, account_wise=True)
543 tax_map = {
544 'sgst_account': ['sgstRate', 'sgstValue'],
545 'cgst_account': ['cgstRate', 'cgstValue'],
546 'igst_account': ['igstRate', 'igstValue'],
547 'cess_account': ['cessRate', 'cessValue']
548 }
549 item_data_attrs = ['sgstRate', 'cgstRate', 'igstRate', 'cessRate', 'cessNonAdvol']
550 hsn_wise_charges, hsn_taxable_amount = get_itemised_tax_breakup_data(doc, account_wise=True)
551 for hsn_code, taxable_amount in hsn_taxable_amount.items():
552 item_data = frappe._dict()
553 if not hsn_code:
554 frappe.throw(_('GST HSN Code does not exist for one or more items'))
555 item_data.hsnCode = int(hsn_code)
556 item_data.taxableAmount = taxable_amount
557 item_data.qtyUnit = ""
558 for attr in item_data_attrs:
559 item_data[attr] = 0
560
561 for account, tax_detail in hsn_wise_charges.get(hsn_code, {}).items():
562 account_type = gst_accounts.get(account, '')
563 for tax_acc, attrs in tax_map.items():
564 if account_type == tax_acc:
565 item_data[attrs[0]] = tax_detail.get('tax_rate')
566 data[attrs[1]] += tax_detail.get('tax_amount')
567 break
568 else:
569 data.OthValue += tax_detail.get('tax_amount')
570
571 data.itemList.append(item_data)
572
573 # Tax amounts rounded to 2 decimals to avoid exceeding max character limit
574 for attr in ['sgstValue', 'cgstValue', 'igstValue', 'cessValue']:
575 data[attr] = flt(data[attr], 2)
576
577 return data
578
Deepesh Garg15ff6a52020-02-18 12:28:41 +0530579def validate_doc(doc):
Nabin Hait34c551d2019-07-03 10:34:31 +0530580 if doc.docstatus != 1:
Deepesh Gargcce3ac92020-02-02 21:25:58 +0530581 frappe.throw(_('E-Way Bill JSON can only be generated from submitted document'))
Nabin Hait34c551d2019-07-03 10:34:31 +0530582
583 if doc.is_return:
Deepesh Gargcce3ac92020-02-02 21:25:58 +0530584 frappe.throw(_('E-Way Bill JSON cannot be generated for Sales Return as of now'))
Nabin Hait34c551d2019-07-03 10:34:31 +0530585
586 if doc.ewaybill:
587 frappe.throw(_('e-Way Bill already exists for this document'))
588
589 reqd_fields = ['company_gstin', 'company_address', 'customer_address',
590 'shipping_address_name', 'mode_of_transport', 'distance']
591
592 for fieldname in reqd_fields:
593 if not doc.get(fieldname):
Deepesh Gargcce3ac92020-02-02 21:25:58 +0530594 frappe.throw(_('{} is required to generate E-Way Bill JSON').format(
Nabin Hait34c551d2019-07-03 10:34:31 +0530595 doc.meta.get_label(fieldname)
Suraj Shettyda2c69e2020-01-29 15:34:06 +0530596 ))
Nabin Hait34c551d2019-07-03 10:34:31 +0530597
598 if len(doc.company_gstin) < 15:
599 frappe.throw(_('You must be a registered supplier to generate e-Way Bill'))
600
601def get_transport_details(data, doc):
602 if doc.distance > 4000:
603 frappe.throw(_('Distance cannot be greater than 4000 kms'))
604
605 data.transDistance = int(round(doc.distance))
606
607 transport_modes = {
608 'Road': 1,
609 'Rail': 2,
610 'Air': 3,
611 'Ship': 4
612 }
613
614 vehicle_types = {
615 'Regular': 'R',
616 'Over Dimensional Cargo (ODC)': 'O'
617 }
618
619 data.transMode = transport_modes.get(doc.mode_of_transport)
620
621 if doc.mode_of_transport == 'Road':
622 if not doc.gst_transporter_id and not doc.vehicle_no:
623 frappe.throw(_('Either GST Transporter ID or Vehicle No is required if Mode of Transport is Road'))
624 if doc.vehicle_no:
625 data.vehicleNo = doc.vehicle_no.replace(' ', '')
626 if not doc.gst_vehicle_type:
627 frappe.throw(_('Vehicle Type is required if Mode of Transport is Road'))
628 else:
629 data.vehicleType = vehicle_types.get(doc.gst_vehicle_type)
630 else:
631 if not doc.lr_no or not doc.lr_date:
632 frappe.throw(_('Transport Receipt No and Date are mandatory for your chosen Mode of Transport'))
633
634 if doc.lr_no:
635 data.transDocNo = doc.lr_no
636
637 if doc.lr_date:
638 data.transDocDate = frappe.utils.formatdate(doc.lr_date, 'dd/mm/yyyy')
639
640 if doc.gst_transporter_id:
karthikeyan5ca46bed2020-05-30 15:00:56 +0530641 if doc.gst_transporter_id[0:2] != "88":
642 validate_gstin_check_digit(doc.gst_transporter_id, label='GST Transporter ID')
643 data.transporterId = doc.gst_transporter_id
Nabin Hait34c551d2019-07-03 10:34:31 +0530644
645 return data
646
647
648def validate_pincode(pincode, address):
649 pin_not_found = "Pin Code doesn't exist for {}"
650 incorrect_pin = "Pin Code for {} is incorrecty formatted. It must be 6 digits (without spaces)"
651
652 if not pincode:
653 frappe.throw(_(pin_not_found.format(address)))
654
655 pincode = pincode.replace(' ', '')
656 if not pincode.isdigit() or len(pincode) != 6:
657 frappe.throw(_(incorrect_pin.format(address)))
658 else:
659 return int(pincode)
660
661def validate_state_code(state_code, address):
662 no_state_code = "GST State Code not found for {0}. Please set GST State in {0}"
663 if not state_code:
664 frappe.throw(_(no_state_code.format(address)))
665 else:
666 return int(state_code)
667
Deepesh Garg3c004ad2020-07-02 21:18:29 +0530668@frappe.whitelist()
Nabin Hait34c551d2019-07-03 10:34:31 +0530669def get_gst_accounts(company, account_wise=False):
670 gst_accounts = frappe._dict()
671 gst_settings_accounts = frappe.get_all("GST Account",
672 filters={"parent": "GST Settings", "company": company},
673 fields=["cgst_account", "sgst_account", "igst_account", "cess_account"])
674
Deepesh Garg6e2c13f2019-12-10 15:55:05 +0530675 if not gst_settings_accounts and not frappe.flags.in_test:
Nabin Hait34c551d2019-07-03 10:34:31 +0530676 frappe.throw(_("Please set GST Accounts in GST Settings"))
677
678 for d in gst_settings_accounts:
679 for acc, val in d.items():
680 if not account_wise:
681 gst_accounts.setdefault(acc, []).append(val)
682 elif val:
683 gst_accounts[val] = acc
684
Nabin Hait34c551d2019-07-03 10:34:31 +0530685 return gst_accounts
Deepesh Garg24f9a802020-06-03 10:59:37 +0530686
Deepesh Garg3c004ad2020-07-02 21:18:29 +0530687def update_grand_total_for_rcm(doc, method):
Deepesh Garg52c319c2020-07-15 23:57:03 +0530688 country = frappe.get_cached_value('Company', doc.company, 'country')
689
690 if country != 'India':
691 return
692
Deepesh Gargc3fb6822020-08-19 18:30:18 +0530693 if not doc.total_taxes_and_charges:
694 return
695
Deepesh Garg3c004ad2020-07-02 21:18:29 +0530696 if doc.reverse_charge == 'Y':
697 gst_accounts = get_gst_accounts(doc.company)
698 gst_account_list = gst_accounts.get('cgst_account') + gst_accounts.get('sgst_account') \
699 + gst_accounts.get('igst_account')
700
Deepesh Garg1c146062020-08-18 19:32:52 +0530701 base_gst_tax = 0
Deepesh Garg3c004ad2020-07-02 21:18:29 +0530702 gst_tax = 0
Deepesh Garg1c146062020-08-18 19:32:52 +0530703
Deepesh Garg3c004ad2020-07-02 21:18:29 +0530704 for tax in doc.get('taxes'):
705 if tax.category not in ("Total", "Valuation and Total"):
706 continue
707
708 if flt(tax.base_tax_amount_after_discount_amount) and tax.account_head in gst_account_list:
Deepesh Garg1c146062020-08-18 19:32:52 +0530709 base_gst_tax += tax.base_tax_amount_after_discount_amount
710 gst_tax += tax.tax_amount_after_discount_amount
Deepesh Garg3c004ad2020-07-02 21:18:29 +0530711
712 doc.taxes_and_charges_added -= gst_tax
713 doc.total_taxes_and_charges -= gst_tax
Deepesh Garg1c146062020-08-18 19:32:52 +0530714 doc.base_taxes_and_charges_added -= base_gst_tax
715 doc.base_total_taxes_and_charges -= base_gst_tax
Deepesh Garg3c004ad2020-07-02 21:18:29 +0530716
Deepesh Garg1c146062020-08-18 19:32:52 +0530717 update_totals(gst_tax, base_gst_tax, doc)
Deepesh Garg3c004ad2020-07-02 21:18:29 +0530718
Deepesh Garg1c146062020-08-18 19:32:52 +0530719def update_totals(gst_tax, base_gst_tax, doc):
720 doc.base_grand_total -= base_gst_tax
Deepesh Garg3c004ad2020-07-02 21:18:29 +0530721 doc.grand_total -= gst_tax
722
723 if doc.meta.get_field("rounded_total"):
724 if doc.is_rounded_total_disabled():
725 doc.outstanding_amount = doc.grand_total
726 else:
727 doc.rounded_total = round_based_on_smallest_currency_fraction(doc.grand_total,
728 doc.currency, doc.precision("rounded_total"))
729
730 doc.rounding_adjustment += flt(doc.rounded_total - doc.grand_total,
731 doc.precision("rounding_adjustment"))
732
Deepesh Garg18827352020-07-17 11:31:15 +0530733 doc.outstanding_amount = doc.rounded_total or doc.grand_total
Deepesh Garg3c004ad2020-07-02 21:18:29 +0530734
735 doc.in_words = money_in_words(doc.grand_total, doc.currency)
Deepesh Garg1c146062020-08-18 19:32:52 +0530736 doc.base_in_words = money_in_words(doc.base_grand_total, erpnext.get_company_currency(doc.company))
Deepesh Garg18827352020-07-17 11:31:15 +0530737 doc.set_payment_schedule()
Deepesh Garg3c004ad2020-07-02 21:18:29 +0530738
739def make_regional_gl_entries(gl_entries, doc):
Deepesh Garg24f9a802020-06-03 10:59:37 +0530740 country = frappe.get_cached_value('Company', doc.company, 'country')
741
742 if country != 'India':
Deepesh Gargc3fb6822020-08-19 18:30:18 +0530743 return gl_entries
744
745 if not doc.total_taxes_and_charges:
746 return gl_entries
Deepesh Garg24f9a802020-06-03 10:59:37 +0530747
748 if doc.reverse_charge == 'Y':
Deepesh Garg24f9a802020-06-03 10:59:37 +0530749 gst_accounts = get_gst_accounts(doc.company)
750 gst_account_list = gst_accounts.get('cgst_account') + gst_accounts.get('sgst_account') \
751 + gst_accounts.get('igst_account')
752
753 for tax in doc.get('taxes'):
754 if tax.category not in ("Total", "Valuation and Total"):
755 continue
756
Deepesh Gargafd2dd32020-08-20 16:31:38 +0530757 dr_or_cr = "credit" if tax.add_deduct_tax == "Add" else "debit"
Deepesh Garg24f9a802020-06-03 10:59:37 +0530758 if flt(tax.base_tax_amount_after_discount_amount) and tax.account_head in gst_account_list:
759 account_currency = get_account_currency(tax.account_head)
760
761 gl_entries.append(doc.get_gl_dict(
762 {
763 "account": tax.account_head,
764 "cost_center": tax.cost_center,
765 "posting_date": doc.posting_date,
766 "against": doc.supplier,
Deepesh Gargafd2dd32020-08-20 16:31:38 +0530767 dr_or_cr: tax.base_tax_amount_after_discount_amount,
768 dr_or_cr + "_in_account_currency": tax.base_tax_amount_after_discount_amount \
Deepesh Garg24f9a802020-06-03 10:59:37 +0530769 if account_currency==doc.company_currency \
770 else tax.tax_amount_after_discount_amount
771 }, account_currency, item=tax)
772 )
773
Deepesh Gargd07447a2020-11-24 08:09:17 +0530774 return gl_entries