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/GSTR 3B — entity reference
REFERENCE · Last reviewed

GSTR 3B — entity reference

Header of a GSTR-3B self-assessed monthly summary return for one GSTIN and one return period (the period is the linked GSTFiscalPeriod, not a raw string). Draft headers are auto-provisioned per active GSTRegistration by the scheduled GST-return provisioning job; the ComputeGSTR3B action (also run nightly by the scheduled GSTR-3B process job) then derives the box figures from three layers: outward supplies (box 3.1) from the filed GSTR-1, input tax credit (boxes 4A/4D) from the fetched GSTR-2B, and reverse-charge liability plus blocked ITC (3.1(d), 4B(1)) from the TaxTransaction ledger, with the Rule-37 180-day unpaid-bill tracker feeding 4B(2)/4D(1). The derived box rows are stored in internal child tables that are not exposed as metadata entities - read them through the GetGSTR3B action, which returns the consolidated table-wise summary. Creating or editing a header validates the GSTIN format (15 characters).

Fields

FieldLabelTypeRequiredWhat it does
AckNumberAck NumberText
ComputedAtComputed AtDateAndTime
CreatedByIdCreated ByLookup → UserAccountYes
CreatedDateTimeCreated DateDateAndTimeYes
FiledOnFiled OnDateAndTime
GspReferenceIdGSP Reference IdText
GSTINGSTINText
GSTMonthIdGST MonthLookup → GSTMonth_c
GstnPayloadGSTN PayloadLongMultiLineText
GstnResponseGSTN ResponseLongMultiLineText
IdIdGuidYes
IsFiledIs FiledBoolean
IsNilReturnIs Nil ReturnBoolean
LabelLabelText
ModifiedByIdModified ByLookup → UserAccountYes
NameNameTextYes
OwnerIdOwnerLookup → UserAccountYes
ProcessedInvoiceValueProcessed Invoice ValueDecimalTotal invoice value processed into this return by the compute, stamped for reference alongside ComputedAt; not a statutory box figure.
RecordTypeIdRecord TypeGuid, hidden
ReturnPeriodIdReturn PeriodLookup → GSTFiscalPeriod
StatusStatusPickListFiling lifecycle stored as text: Draft, Computed, Saved, Submitted, Filed. Filed is a one-way frozen state - it blocks recompute and is what the GSTR-9 annual rollup selects on. Values: Draft, Pushed to GSTN, GST Payment Made, Filed.
SubscriptionKeySubscription KeyGuid, hiddenYes
UpdatedDateTimeModified DateDateAndTimeYes

Actions

ActionLabelTypeWhat it does
CloneCloneServerAction (Clone)Create a copy of this record
ComputeGSTR3BProcess GSTR3BServerAction (ComputeGSTR3B)Recomputes this GSTR-3B in one transaction: syncs the Rule-37 180-day tracker from bills, rebuilds the derived box rows (3.1 outward from the filed GSTR-1, 4A ITC from the fetched GSTR-2B, 3.1(d) reverse charge and 4B(1) blocked ITC from the TaxTransaction ledger, 4B(2)/4D(1) from the tracker, 4D(2) disclosure from the 2B ITC summary) and advances Status to Computed. Idempotent: only auto-filled rows are replaced; rows a user entered by hand are left untouched, and boxes the compute cannot derive (3.1.1, 4A(2), Rule 42/43 reversals, table 6.1 payments) are never cleared. Refused on a Filed return. The same compute runs on the scheduled GSTR-3B process job.
EditEditEditEdit
EditInLineEdit InLineEditInlineEdit InLine
EditInListEditEditInlineedit
FileToGSTNFile To GSTNServerAction (FileToGSTN)File to GSTIN
GetGSTR3BGetGSTR3BServerAction (GetGSTR3B)Read-only: returns the consolidated table-wise GSTR-3B summary for this header (the box rows 3.1/3.1.1/4A/4B/4D with their tax heads). This is the way to read the computed figures, because the derived box rows live in internal tables that are not exposed as metadata entities.
MakeChallanMake ChallanServerActionGST payment challans are not generated by the platform; do not confuse this with the implemented TDS deposit-challan pipeline on TdsChallan.
NewNewNewNew
PullFromGSTINPull From GSTINServerAction (Pull From GSTIN)GSTR-3B figures are not pulled from GSTN; they are computed locally by ComputeGSTR3B from the filed GSTR-1, the GSTR-2B and the tax ledger.