Skip to content

GSTReturn

GSTReturn DocType definition.

Attributes:
name: Unique identifier for this GSTReturn.

Source: doctype.py

Field Type Required Description Validators
return_type str Return Type (GSTR-1, GSTR-3B, etc.) -
period str Period (MMYYYY) -
total_taxable Decimal Total Taxable -
total_cgst Decimal Total CGST -
total_sgst Decimal Total SGST -
total_igst Decimal Total IGST -
total_cess Decimal Total CESS -
filed_date None Date Filed -
arn None Acknowledgement Reference Number -
status str Status (Draft, Filed, Accepted) -
Role Create Delete Read Write
All
Setting Value
Submittable False
Track Changes True

Controller hooks are implemented in *_controller.py files. Available lifecycle hooks:

  • validate() - Called before save, raise exceptions for validation errors
  • before_insert() - Called before inserting a new document
  • after_insert() - Called after successfully inserting
  • before_save() - Called before saving (insert or update)
  • after_save() - Called after saving
  • before_delete() - Called before deleting
  • after_delete() - Called after deleting