xMatix
Sign in Request demo
xMatix
PRODUCTS
SalesField SalesCRMRewardsClaimsInventoryProcurementWarehouse ManagementField ServiceServiceSupportTelephony & MessagingFinance & AccountingPayrollExpense ManagementCommercePortalsAnalytics & ReportingData StudioMobile AppSee all products →
PLATFORM
Platform overviewApp BuilderAutomationIntegrationsSecurity & GovernanceChange ManagementDevelopers
SENSE AI
Sense AI overviewSense AssistSense ControlSense VisionAI StudioTrust & governanceIn Claude & ChatGPTUse cases
SOLUTIONS
FMCG & DistributionManufacturing & Dealer NetworksAutomotive & DealershipsPharma & HealthcareConsumer DurablesAgri-InputsBuilding MaterialsService NetworksWarehousing & 3PLFinancial AccountingERP SoftwareIndia GST ComplianceUAE VAT & e-InvoicingSaudi ZATCA & VATAll solutions →
RESOURCES
Knowledge CenterDeveloper & CLIBlogGuidesWhat is xMatix?Company facts
COMPANY
AboutCareersPartnersEventsContactAuthorsLegal
Sign in Request demo
Home/Docs/Entity Reference/GSTR1 — entity reference
REFERENCE · Last reviewed

GSTR1 — entity reference

Root of a granular GSTR-1 outward-supply return: one filing per filer GSTIN and return period (the period is the linked GSTFiscalPeriod via gstFiscalPeriodId, not a raw MMYYYY string). Draft headers are auto-provisioned per active GSTRegistration each period by the GST-return provisioning service; the table-wise detail (B2B, B2C large/small, credit/debit notes, exports, nil-rated, HSN summary, documents issued) hangs off it as child collections, and every child row carries a Source discriminator separating Books rows (materialized from output TaxTransaction by ProcessGSTR1Data) from Portal rows (pulled from GSTIN) in the same tables. Status runs a filing lifecycle from Draft to Filed - a Filed return is frozen: re-processing is refused and corrections go through an amendment. Incremental processing uses a header watermark (last processed time + source row count) so unchanged periods skip outright.

Fields

FieldLabelTypeRequiredWhat it does
CreatedByIdCreated ByLookup → UserAccountYes
CreatedDateTimeCreated OnDateAndTimeYes
FilingDateFiling DateDate
GSTFiscalPeriodIdGST Fiscal PeriodLookup → GSTFiscalPeriodThe return period, modelled as a link to GSTFiscalPeriod rather than a raw MMYYYY string. Processing is refused while it is empty, and the period's month/year scope the TaxTransaction rows the Books side is built from.
GSTINGSTINTextThe filer's own 15-character GSTIN. Format-validated on save; processing and filing are refused while it is empty. Materialization selects output TaxTransaction rows whose own-GSTIN matches this value.
IdIdGuidYes
IsFiledIs FiledBoolean
LabelLabelText
LastProcessedSourceCountSource Rows ProcessedNumber, hidden
LastProcessedUtcLast ProcessedDateAndTime
ModifiedByIdModified ByLookup → UserAccountYes
NameNameTextYes
OwnerIdOwnerLookup → UserAccountYes
ProcessedInvoiceValueProcessed Invoice ValueDecimalTotal processed outward-supply invoice value for the period, written by materialization and surfaced on the GST console GSTR-1 card. A roll-up, not an input.
RecordTypeIdRecord TypeGuid
StatusStatusPickListFiling lifecycle, Draft to Filed. Filed is load-bearing: it freezes the period against re-processing (ProcessGSTR1Data is refused), the filing action refuses an already-Filed return, and the GSTR-9 filed-returns rollup selects on it. Corrections to a Filed period go through an amendment, not a re-process. Values: Draft, Processed, Submitted, Filed, Error.
UIPropsUI PropsText
UpdatedDateTimeModified OnDateAndTimeYes

Actions

ActionLabelTypeWhat it does
CarryForwardCarry ForwardServerAction (CarryForward)Row-level reconciliation decision on selected document rows of this filing: report them in the NEXT return period's filing instead of this one. Rows are neither moved nor copied - the decision re-points which return counts them, and the HSN summary re-derives on both filings. The next period's filing need not exist yet (one provisioned later picks the documents up), and the action is legal on a Filed filing - the usual case is a document found missing in GSTN after filing. Rejects an empty selection, non-document rows, Portal rows, rows of another filing, already-carried rows, and an already-Filed next period.
CloneCloneServerAction (Clone)Create a copy of this record
FileToGSTNFile To GSTNServerAction (FileToGSTN)File GSTR1
GetGSTR1Get from GSTR1ServerAction (GetGSTR1)Read-only: builds the GSTN-style consolidated summary for one filing - one block per return table with document counts, invoice value and the IGST/CGST/SGST-UTGST/cess totals, plus a drill-down target per row and grand totals - in a single response. Optional source argument selects the Books side (default) or the Portal side; reconciliation decisions are applied, so ignored and carried-forward documents are held out of the figures and reported as separate decision counts.
GetGSTR1ReconciliationGet GSTR1 ReconciliationServerAction (GetGSTR1Reconciliation)Get GSTR1 Reconciliation
IgnoreIgnoreServerAction (Ignore)Row-level reconciliation decision on selected document rows of this filing: drop them from the filing outright - unlike CarryForward, no later filing picks them up. The filing's summary figures exclude ignored rows and report them in a separate decision count.
NewNewNewNew
ProcessGSTR1DataProcess GSTR1ServerAction (ProcessGSTR1Data)Materializes the Books side of the filing from the period's output TaxTransaction rows for the filer GSTIN. Incremental: an unchanged period skips outright via the header watermark, and a changed one merges by originating document - rows update in place keeping their ids and reconciliation decisions, new documents append, vanished ones soft-remove. Refused on a Filed return (corrections go through an amendment). An optional rebuild argument forces the legacy wipe-and-rebuild repair path, which discards the reconciliation decisions. Portal rows are never touched.
PullFromGSTINPull from GSTINServerAction (PullFromGSTIN)Push to GSTIN
TestTestEdittest