Merge pull request resilient-tech#3742 from ljain112/fix-gsr3b-excel

Author: vorasmit

india_compliance/gst_india/data/gstr3b_excel_utility_v5.7.xlsx

@@ -25,7 +25,7 @@ frappe.ui.form.on("GSTR 3B Report", {
         frm.set_intro(__("Please save the report again to rebuild or update"));
         frm.doc.__unsaved = 1;
 
-        // Download Button
+        // Download JSON Button
         frm.add_custom_button(__("Download JSON"), function () {
             var w = window.open(
                 frappe.urllib.get_full_url(
@@ -41,6 +41,22 @@ frappe.ui.form.on("GSTR 3B Report", {
             }
         });
 
+        // Download Excel Button
+        frm.add_custom_button(__("Download Excel"), function () {
+            var w = window.open(
+                frappe.urllib.get_full_url(
+                    "/api/method/india_compliance.gst_india.doctype.gstr_3b_report.gstr_3b_report.download_gstr3b_as_excel?" +
+                        "name=" +
+                        encodeURIComponent(frm.doc.name)
+                )
+            );
+
+            if (!w) {
+                frappe.msgprint(__("Please enable pop-ups"));
+                return;
+            }
+        });
+
         // View Form Button
         frm.add_custom_button(__("View Form"), function () {
             frappe.call({

india_compliance/gst_india/doctype/gstr_3b_report/gstr_3b_report.js

@@ -2,10 +2,13 @@
 # For license information, please see license.txt
 
 
+import calendar
 import json
 import os
 from collections import defaultdict
 
+from openpyxl.cell.cell import MergedCell
+
 import frappe
 from frappe import _
 from frappe.model.document import Document
@@ -17,7 +20,12 @@
 from india_compliance.gst_india.report.gstr_3b_details.gstr_3b_details import (
     IneligibleITC,
 )
-from india_compliance.gst_india.utils import get_gst_accounts_by_type, get_period
+from india_compliance.gst_india.utils import (
+    get_data_file_path,
+    get_gst_accounts_by_type,
+    get_period,
+)
+from india_compliance.gst_india.utils.exporter import ExcelExporter
 from india_compliance.gst_india.utils.gstr_1.gstr_1_data import GSTR11A11BData
 
 VALUES_TO_UPDATE = ["iamt", "camt", "samt", "csamt"]
@@ -749,3 +757,296 @@ def make_json(name):
     frappe.local.response.filename = file_name
     frappe.local.response.filecontent = json_data
     frappe.local.response.type = "download"
+
+
+@frappe.whitelist()
+def download_gstr3b_as_excel(name):
+    """Download GSTR 3B report as Excel file"""
+    frappe.has_permission("GSTR 3B Report", throw=True)
+    json_data = frappe.get_value("GSTR 3B Report", name, "json_output")
+
+    if not json_data:
+        frappe.throw(_("Report data not found. Please generate the report."))
+
+    data = json.loads(json_data)
+    exporter = GSTR3BExcelExporter(data)
+    exporter.generate_excel()
+
+
+class GSTR3BExcelExporter:
+    """
+    Export GSTR-3B data to Excel format using the official template.
+
+    This class handles data transformation and mapping from JSON to Excel cells
+    following the official GSTR-3B offline utility format.
+    """
+
+    TEMPLATE_FILE = get_data_file_path("gstr3b_excel_utility_v5.7.xlsx")
+    WORKSHEET_NAME = "GSTR-3B"
+
+    _STATE_CODE_TO_NAME = {code: state for state, code in STATE_NUMBERS.items()}
+
+    # Row mappings for each section (consistent with JSON keys)
+    ROWS = {
+        # Header info
+        "gstin": 5,
+        "year": 5,
+        "month": 6,
+        # Section 3.1 - Outward supplies
+        "osup_det": 11,
+        "osup_zero": 12,
+        "osup_nil_exmp": 13,
+        "isup_rev": 14,
+        "osup_nongst": 15,
+        "eco_reg_sup": 23,
+        # Section 3.2 - Inter-state
+        "inter_state_start": 88,
+        # Section 4 - ITC
+        "itc_import_goods": 31,
+        "itc_import_services": 32,
+        "itc_reverse_charge": 33,
+        "itc_isd": 34,
+        "itc_others": 35,
+        "itc_reversed_rules": 37,
+        "itc_reversed_others": 38,
+        # Section 5 - Inward supplies
+        "inward_gst": 48,
+        "inward_non_gst": 49,
+    }
+
+    HEADER_COLUMNS = {
+        "gstin": 3,
+        "year": 7,
+        "month": 7,
+    }
+
+    # Section 3.1 - Tax columns
+    TAX_COLUMNS = {
+        "txval": 3,
+        "iamt": 4,
+        "camt": 5,
+        "csamt": 7,
+    }
+
+    # Section 4 - ITC columns
+    ITC_COLUMNS = {
+        "iamt": 3,
+        "camt": 4,
+        "csamt": 6,
+    }
+
+    # Section 5 - Inward supplies columns
+    INWARD_COLUMNS = {
+        "inter": 4,
+        "intra": 5,
+    }
+
+    # ITC type mappings based on 'ty' field in JSON
+    ITC_AVAILABLE_TYPES = {
+        "IMPG": "itc_import_goods",
+        "IMPS": "itc_import_services",
+        "ISRC": "itc_reverse_charge",
+        "ISD": "itc_isd",
+        "OTH": "itc_others",
+    }
+
+    ITC_REVERSED_TYPES = {
+        "RUL": "itc_reversed_rules",
+        "OTH": "itc_reversed_others",
+    }
+
+    INWARD_SUPPLY_TYPES = {
+        "GST": "inward_gst",
+        "NONGST": "inward_non_gst",
+    }
+
+    COLUMN_SETS = {
+        "tax": ["txval", "iamt", "camt", "csamt"],
+        "itc": ["iamt", "camt", "csamt"],
+        "import_itc": ["iamt", "csamt"],
+        "inward": ["inter", "intra"],
+        "zero_rated": ["txval", "iamt", "csamt"],
+        "taxable_only": ["txval"],
+    }
+
+    def __init__(self, data):
+        self.data = data
+        self.gstin = data.get("gstin")
+        self.worksheet = None
+        self.month = None
+        self.fiscal_year = None
+
+    def generate_excel(self):
+        """Generate and export Excel file"""
+        if not os.path.exists(self.TEMPLATE_FILE):
+            frappe.throw(_("GSTR 3B Excel template not found"))
+
+        excel = ExcelExporter(file=self.TEMPLATE_FILE)
+        self._update_worksheet(excel)
+
+        file_name = self._get_filename()
+        excel.export(file_name)
+
+    def _get_filename(self):
+        return f"GSTR-3B-{self.gstin}-{self.month}-{self.fiscal_year}.xlsx"
+
+    def _update_worksheet(self, excel):
+        self.worksheet = excel.wb[self.WORKSHEET_NAME]
+
+        self._set_header_info()
+        self._set_outward_supplies()
+        self._set_ecommerce_supplies()
+        self._set_inter_state_supplies()
+        self._set_itc_details()
+        self._set_inward_supplies()
+
+    def _set_header_info(self):
+        """Set header information"""
+        period = self.data.get("ret_period", "")
+        if not period or len(period) < 6:
+            return
+
+        month_num = int(period[:2])
+        calendar_year = int(period[2:6])
+
+        self.month = calendar.month_name[month_num]
+        self.fiscal_year = self._get_fiscal_year(month_num, calendar_year)
+
+        self._set_cell(self.ROWS["gstin"], self.HEADER_COLUMNS["gstin"], self.gstin)
+        self._set_cell(self.ROWS["year"], self.HEADER_COLUMNS["year"], self.fiscal_year)
+        self._set_cell(self.ROWS["month"], self.HEADER_COLUMNS["month"], self.month)
+
+    def _get_fiscal_year(self, month_num, calendar_year):
+        if month_num >= 4:
+            fiscal_year_start = str(calendar_year)
+            fiscal_year_end = str(calendar_year + 1)[2:]
+        else:
+            fiscal_year_start = str(calendar_year - 1)
+            fiscal_year_end = str(calendar_year)[2:]
+
+        return f"{fiscal_year_start}-{fiscal_year_end}"
+
+    def _set_outward_supplies(self):
+        sup_details = self.data.get("sup_details", {})
+
+        section_mappings = [
+            ("osup_det", "tax"),
+            ("osup_zero", "zero_rated"),
+            ("osup_nil_exmp", "taxable_only"),
+            ("isup_rev", "tax"),
+            ("osup_nongst", "taxable_only"),
+        ]
+
+        for json_key, column_set in section_mappings:
+            data = sup_details.get(json_key, {})
+            self._set_section_data(json_key, data, column_set)
+
+    def _set_ecommerce_supplies(self):
+        eco_dtls = self.data.get("eco_dtls", {})
+        self._set_section_data(
+            "eco_reg_sup", eco_dtls.get("eco_reg_sup", {}), "taxable_only"
+        )
+
+    def _set_inter_state_supplies(self):
+        inter_sup = self.data.get("inter_sup", {})
+        pos_data = self._group_by_place_of_supply(inter_sup)
+
+        if not pos_data:
+            return
+
+        for i, (pos, data) in enumerate(sorted(pos_data.items())):
+            row = self.ROWS["inter_state_start"] + i
+            self._set_inter_state_row(row, pos, data)
+
+    def _group_by_place_of_supply(self, inter_sup):
+        pos_data = {}
+        categories = {
+            "unreg_details": "unreg",
+            "comp_details": "comp",
+            "uin_details": "uin",
+        }
+
+        for category_key, category_name in categories.items():
+            for item in inter_sup.get(category_key, []):
+                state_code = item.get("pos", "00")
+                state_name = self._format_place_of_supply(state_code)
+
+                if state_name not in pos_data:
+                    pos_data[state_name] = {
+                        "unreg": {"txval": 0, "iamt": 0},
+                        "comp": {"txval": 0, "iamt": 0},
+                        "uin": {"txval": 0, "iamt": 0},
+                    }
+
+                pos_data[state_name][category_name]["txval"] += flt(
+                    item.get("txval", 0), 2
+                )
+                pos_data[state_name][category_name]["iamt"] += flt(
+                    item.get("iamt", 0), 2
+                )
+
+        return pos_data
+
+    def _set_inter_state_row(self, row, pos, data):
+        self._set_cell(row, 2, pos)
+
+        categories = [
+            ("unreg", 3, 4),
+            ("comp", 5, 6),
+            ("uin", 7, 8),
+        ]
+
+        for category, val_col, tax_col in categories:
+            category_data = data.get(category, {"txval": 0, "iamt": 0})
+            self._set_cell(row, val_col, category_data["txval"])
+            self._set_cell(row, tax_col, category_data["iamt"])
+
+    def _set_itc_details(self):
+        itc_elg = self.data.get("itc_elg", {})
+        self._populate_itc_sections(
+            itc_elg.get("itc_avl", []), self.ITC_AVAILABLE_TYPES
+        )
+        self._populate_itc_sections(itc_elg.get("itc_rev", []), self.ITC_REVERSED_TYPES)
+
+    def _populate_itc_sections(self, itc_entries, type_mapping):
+        for itc_entry in itc_entries:
+            itc_type = itc_entry.get("ty", "")
+            if itc_type not in type_mapping:
+                continue
+
+            row_key = type_mapping[itc_type]
+            column_set = "import_itc" if itc_type in ["IMPG", "IMPS"] else "itc"
+            self._set_section_data(row_key, itc_entry, column_set, self.ITC_COLUMNS)
+
+    def _set_inward_supplies(self):
+        inward_sup = self.data.get("inward_sup", {})
+        isup_details = inward_sup.get("isup_details", [])
+
+        for supply_data in isup_details:
+            supply_type = supply_data.get("ty")
+            if supply_type in self.INWARD_SUPPLY_TYPES:
+                row_key = self.INWARD_SUPPLY_TYPES[supply_type]
+                self._set_section_data(
+                    row_key, supply_data, "inward", self.INWARD_COLUMNS
+                )
+
+    def _set_section_data(self, row_key, data, column_set, columns_dict=None):
+        row = self.ROWS[row_key]
+        columns = self.COLUMN_SETS[column_set]
+        mapping = columns_dict or self.TAX_COLUMNS
+
+        for key in columns:
+            if key in mapping:
+                value = flt(data.get(key, 0), 2)
+                self._set_cell(row, mapping[key], value)
+
+    def _set_cell(self, row, column, value):
+        cell = self.worksheet.cell(row, column)
+        if not isinstance(cell, MergedCell):
+            cell.value = value
+
+    @classmethod
+    def _format_place_of_supply(cls, state_code):
+        formatted_code = state_code.zfill(2)
+        state_name = cls._STATE_CODE_TO_NAME.get(formatted_code, "Other Territory")
+        return f"{formatted_code}-{state_name}"

india_compliance/gst_india/doctype/gstr_3b_report/gstr_3b_report.py

@@ -7,6 +7,9 @@
 from frappe.tests import IntegrationTestCase, change_settings
 from frappe.utils import getdate
 
+from india_compliance.gst_india.doctype.gstr_3b_report.gstr_3b_report import (
+    GSTR3BExcelExporter,
+)
 from india_compliance.gst_india.utils.tests import (
     create_purchase_invoice,
     create_sales_invoice,
@@ -190,6 +193,9 @@ def test_gstr_3b_report(self):
             },
         )
 
+        exporter = GSTR3BExcelExporter(output)
+        exporter.generate_excel()
+
     def test_gst_rounding(self):
         gst_settings = frappe.get_cached_doc("GST Settings")
         gst_settings.round_off_gst_values = 1