xMatix
Sign in Request demo
xMatix
PRODUCTS
SalesField Sales & SFACRMRewardsClaimsInventoryProcurementWarehouse 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
Auto DMSConsumer Goods DMSSales Force Automation (SFA) 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

One GSTR-1 outward-supplies return for one of your GSTINs and one monthly GST fiscal period. GST return provisioning creates one per active registration (other than an Input Service Distributor) per month, as Draft. Each return holds two sides in the same tables (B2B, B2C Large, B2C Small, exports, credit/debit notes, nil-rated/exempt, HSN summary). The books side is built by Process GSTR1, or the Process GSTR-1 data scheduled job, from the output tax lines of posted sales invoices, credit notes and debit notes whose document date falls in the month. The portal side is fetched from GSTN by Pull from GSTIN through the GSP integration. The Reconciliations tab pairs the two sides as Matched (every amount within one rupee), Mismatch, Missing in Books or Missing in GSTN, and records decisions on differences: Carry Forward, Ignore, Books Correction, Portal Correction and Add In Books. Save to GSTN sends the books side to GSTN; File To GSTN records a filing made on the portal. Once Status is Filed the return is frozen and corrections go through an amendment. Documents issued (Table 13) is not built by xMatix. See the GSTR-1 guide in the Tax Center documentation for the full procedure.

Fields

FieldLabelTypeRequiredWhat it does
CreatedByIdCreated ByLookup → UserAccountYes
CreatedDateTimeCreated OnDateAndTimeYes
FilingDateFiling DateDateWhen the filing was recorded. File To GSTN sets it to the moment the action runs; a filing through xMatix fills it when GSTN accepts the filing.
GSTFiscalPeriodIdGST Fiscal PeriodLookup → GSTFiscalPeriodThe monthly GST fiscal period the return covers. Its month and year decide which documents are included, by document date. Process GSTR1 and the GSTN actions refuse a return without it.
GSTINGSTINTextYour own 15-character GSTIN, the supplier on the documents. A malformed value is refused on save. Decides which output tax lines Process GSTR1 reads and which GST Registration session the GSTN actions use; processing and filing are refused without it.
IdIdGuidYes
IsFiledIs FiledBooleanWhether the filing has been recorded. Set together with Status Filed by File To GSTN, or automatically when a filing through xMatix is accepted by GSTN. Switching it on by hand does not freeze the return; the freeze follows Status.
LabelLabelTextDisplay name of the return, set by provisioning as GSTR-1 followed by the period, for example GSTR-1 Aug 2026.
LastProcessedSourceCountSource Rows ProcessedNumber, hiddenHidden. Number of tax lines counted by the last Process GSTR1 run, adjusted for ignored and carried documents; a different count on the next run forces reprocessing.
LastProcessedUtcLast ProcessedDateAndTimeChange time of the newest tax line taken in by the last Process GSTR1 run. Together with the hidden source-row count it lets an unchanged period be skipped.
ModifiedByIdModified ByLookup → UserAccountYes
NameNameTextYesReference of the return. Provisioned returns are named after the GSTIN and period, for example GSTR1-27ABCDE1234F1Z5-082026; returns created with New are numbered by the GSTR 1 Name Setting (series GSTR1).
OwnerIdOwnerLookup → UserAccountYes
ProcessedInvoiceValueProcessed Invoice ValueDecimalTotal value (taxable value plus tax) of the B2B, B2C and export invoices on the books side, written by Process GSTR1 and shown on the GST console GSTR-1 card. Credit and debit notes are not included. A roll-up, not an input.
RecordTypeIdRecord TypeGuid
StatusStatusPickListWhere the return stands. xMatix sets only Draft (when it creates the return) and Filed (when the filing is recorded); the other values are never set by the system. Filed freezes the return: processing, saving and filing are refused and the header buttons are hidden. Do not change it by hand. Values: Draft, Processed, Submitted, Filed, Error.
UIPropsUI PropsText
UpdatedDateTimeModified OnDateAndTimeYes

Actions

ActionLabelTypeWhat it does
CarryForwardCarry ForwardServerAction (CarryForward)Shown on the Missing in GSTN tab. Stops reporting the selected documents in this return and adds a copy of each to the next month's return straight away, creating that return and its GST period if they do not exist yet. Works on a Filed return. Refused when the next month's return is already Filed, for aggregated rows, for portal rows and for documents already carried. Cannot be undone from the screen.
CloneCloneServerAction (Clone)Create a copy of this record
FileToGSTNFile To GSTNServerAction (FileToGSTN)File To GSTN. Records a filing made on the GST portal: after the GSTN authentication panel confirms a live session, sets Is Filed, Status Filed and Filing Date. Sends nothing to GSTN and stores no acknowledgement number. Refused on a return already Filed or with no valid GSTIN.
GetGSTR1Get from GSTR1ServerAction (GetGSTR1)Returns the table-by-table summary shown on the Overview tab: document count, taxable value and the four tax heads per table, with a Total row that leaves out the HSN summary and documents issued. Ignored and carried-forward documents are left out and counted separately; buyer GSTINs that are not valid at GSTN are listed as warnings. Books side by default. Read-only.
GetGSTR1ReconciliationGet GSTR1 ReconciliationServerAction (GetGSTR1Reconciliation)Returns the document-by-document comparison of the books and portal sides shown on the Reconciliations tab, with a Matched, Mismatch, Missing in Books or Missing in GSTN status per document, or the decision recorded on it. Amounts within one rupee count as matching. Read-only.
IgnoreIgnoreServerAction (Ignore)Shown on the Missing in Books and Missing in GSTN tabs. Drops the selected documents from this return; no later return picks them up. Only rows from your own books can be ignored, so it is refused on a Missing in Books row. Cannot be undone from the screen.
NewNewNewNew
ProcessGSTR1DataProcess GSTR1ServerAction (ProcessGSTR1Data)Process GSTR1. Builds the books side from the period's output tax lines for the return's GSTIN. Incremental: skips when nothing changed, otherwise updates changed documents in place (keeping their decisions), adds new ones and removes vanished ones. Never touches the portal side. Refused on a Filed return and without a GSTIN or GST fiscal period.
PullFromGSTINPull from GSTINServerAction (PullFromGSTIN)Pull from GSTIN. Opens the GSTN authentication panel; once the GSTIN has a live session, Proceed asks GSTN for the return through the GSP integration. Running the action again after the reply arrives imports it, replacing the portal rows of each section returned (B2B, B2CL, B2CS, CDNR, CDNUR, EXP, HSN summary, nil-rated). Never touches the books side.
TestTestEdittest