Header of a GSTR-9 annual return for one GSTIN and financial year, created automatically by the GST-return provisioning job (one per GSTIN per year; ISD registrations are excluded under section 44). The PerformGSTR9Summary action computes the annual figures: it rolls up the already-filed monthly GSTR-1 and GSTR-3B returns into the Computed lane of the child GSTR9Summary rows, reads the TaxTransaction books ledger into the Books lane, and materializes the variance - which rows exist and how each is produced is data, described by the tenant's GSTR9Config catalog, not code. Status runs Draft, Computed, Validated, Filed (plus Amended); the pre-file checklist requires all 12 GSTR-1 and GSTR-3B of the year to be filed and locks the portal-owned rows. Filing is record-only (no GSTN transport): the return is filed on the portal and the ARN and date are recorded here, after which the return is a frozen statutory snapshot - recompute and line overrides are refused. Creating or editing a header validates the GSTIN format and requires the financial year.
Fields
| Field | Label | Type | Required | What it does |
|---|
AATO | AATO | Currency | | |
ARN | ARN | Text | | |
ComputedAt | Computed At | Date | | |
CreatedById | Created By | Lookup → UserAccount | | |
CreatedDateTime | Created Date | DateAndTime | Yes | |
FiledOn | Filed On | Date | | |
FinancialYear | Financial Year | Text | | The Indian financial year the return covers, in start-end form such as 2024-25 - required on save and the key (with GSTIN) the provisioning job uses to create the header once per year. Also selects which year's form-catalog rows drive the compute, since the GSTR-9 form is renotified most years. |
GSTIN | GSTIN | Text | | |
GSTRegistrationId | GST Registration | Lookup | | |
Id | Id | Guid | Yes | |
IsFiled | Is Filed | Boolean | | |
LegalName | Legal Name | Text | | |
ModifiedById | Modified By | Lookup → UserAccount | | |
Name | Name | Text | Yes | |
OTP | OTP | Number | | |
OwnerId | Owner | Lookup → UserAccount | | |
PeriodFrom | Period From | Date | | |
PeriodTo | Period To | Date | | |
PrerequisiteStatus | Prerequisite Status | Text | | |
RecordTypeId | Record Type | Guid, hidden | | |
Status | Status | PickList | | Annual-return lifecycle: Draft, Computed (lanes filled), Validated (pre-file checklist passed), Filed (frozen statutory snapshot), Amended (superseded by a later amendment). Filed blocks recompute and line overrides. Values: Draft, Filed, Locked. |
SubscriptionKey | Subscription Key | Guid, hidden | Yes | |
UpdatedDateTime | Modified Date | DateAndTime | Yes | |
Actions
| Action | Label | Type | What it does |
|---|
Clone | Clone | ServerAction (Clone) | Create a copy of this record |
ComputeGSTR9 | Compute GSTR9 | ServerAction (ComputeGSTR9) | Roll up the annual GSTR-9 summary from the filed GSTR-1/3B, GSTR-2B and the books ledger. |
Edit | Edit | Edit | Edit |
EditInLine | Edit | UIAction | Edit |
ExportGSTR9Json | Export GSTR9 JSON | ServerAction (ExportGSTR9Json) | Emit the GSTN offline-utility JSON payload for the GSTR-9 return. |
FileToGSTN | File To GSTN | ServerAction (FileToGSTN) | Push to GSTRN |
GetGSTR9 | Get GSTR9 | ServerAction (GetGSTR9) | Get the GSTR-9 table-wise summary (blocks/rows). |
New | New | New | New GSTR 9 Return |
OverrideGSTR9Line | Override GSTR9 Line | ServerAction (OverrideGSTR9Line) | Override a GSTR-9 summary line with a mandatory reason (audit trail). |
PerformGSTR9Summary | Get Records | ServerAction (PerformGSTR9Summary) | Computes the annual return (legacy name kept as an alias of the compute): wipes and rebuilds the non-overridden GSTR9Summary rows for this header from the tenant's GSTR9Config catalog - rolling up the filed monthly GSTR-1/GSTR-3B returns into the Computed lane and the TaxTransaction books ledger into the Books lane, materializing the variance and rebuilding the HSN tables from the filed GSTR-1 HSN summaries. Overridden rows are preserved and the row version is bumped; a Filed return is refused. Requires the header to exist with a valid GSTIN and financial year. |
ValidateGSTR9 | Validate GSTR9 | ServerAction (ValidateGSTR9) | Run the GSTR-9 pre-file checklist and lock the portal-owned rows. |
