Skip to content

m-india: India Regional Adapter

India-specific compliance (GST, E-Invoice, E-Way Bill, Payroll) for Framework M.


This module is the India Adapter, implementing the m-regional port. It handles all regulatory requirements for businesses operating in India.

Depends on: m-regional, m-invoice, m-hr-core.


m-india implements the core regional protocols:

  • RegionalTaxProvider: Computes CGST, SGST, IGST based on Place of Supply.
  • RegionalComplianceRegistry: Integrates with NIC/GSTN portals for IRN and EGV.
  • RegionalIDValidator:
    • validate_tax_id: Validates GSTIN (using checksum).
    • validate_compliance_id: Validates IRN, E-Way Bill No.
    • validate_entity_id: Validates PAN, TAN, Aadhaar.

Extends m-invoice and finance DocTypes via Mixins.

Added to SalesInvoice, PurchaseInvoice.

  • gstin: Party’s GST Number.
  • place_of_supply: GST State Code (e.g., “27”).
  • gst_category: Regular, SEZ, Deemed Export.

Added to InvoiceItem.

  • hsn_code: HSN (Goods) or SAC (Services).
  • gst_rate: Tax percentage (5%, 12%, 18%, 28%).

Integrates India compliance into warehouse movements.

Triggered on DeliveryNote submission in wms.

  • Logic: If transaction value > ₹50,000 (standard threshold) and involves transport, prompt/auto-generate E-Way Bill.
  • DocType: EWayBill records are linked to the Distribution Center’s DeliveryNote.

Handles Indian statutory deductions.

  • Professional Tax (PT): State-based slabs.
  • Provident Fund (PF): Employer/Employee contributions (12%).
  • ESI: Health insurance contributions.
  • Income Tax (TDS): Section 192 compliance.

Feature Provider API Base URL
E-Invoice (IRN) GSTN einvoice1.gst.gov.in
E-Way Bill NIC ewebill1.nic.in
GSTR Filing GSTN gst.gov.in

  • Metadata Registration: Register India-specific fields (gstin, hsn_code) with the MetadataDecoratorRegistry for Address and Item.
  • E-Way Bill Integration (CQRS): Implement EWayBillSubscriber to listen for Distribution Center DeliveryNote updates and trigger NIC portal sync.
  • India-specific Salary Components: Port standard PT/PF/ESI slabs into the m-india provider.
  • Statutory Reports: GSTR-1 & GSTR-3B generation via background workers.