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/GL Period Balance — entity reference
REFERENCE · Last reviewed

GL Period Balance — entity reference

A rebuildable aggregate of posted journal lines per GL account, fiscal period and dimension tuple — a cache, never the source of truth. Rows are maintained inside the posting unit of work as journals post and reverse, and can be re-derived wholesale from the ledger by the rebuild action on the fiscal period; a verification pass re-aggregates the ledger and reports any drift. To change a balance you post a journal; to repair one you rebuild.

Fields

FieldLabelTypeRequiredWhat it does
BranchIdBranchLookup → BranchPart of the composite key the balance row is bucketed by, copied from the posted line after its own branch defaulting has run. A blank branch is a distinct bucket, not a wildcard.
BusinessUnitIdBusiness UnitLookup → BusinessUnitPart of the composite key, taken from the posted line's resolved business unit. Segment reporting reads these buckets, which is why the line-level resolution order deliberately prefers the branch's unit over the GL account's default.
ClosingBalanceClosing BalanceCurrencyComputed as opening plus period debits minus period credits and rounded to two decimals, so it is signed debit-positive and credit-negative. Because the opening value is never carried forward, in practice this equals the period's net movement rather than a cumulative account balance.
CreatedByIdCreated ByLookup → UserAccountYes
CreatedDateTimeCreated OnDateAndTimeYes
FiscalPeriodIdFiscal PeriodLookup → FiscalPeriod
GLAccountIdGL AccountLookup → GLAccount
GSTRegistrationIdGST RegistrationLookup → GSTRegistrationPart of the composite key, carried from the posted line where it is normally derived from the branch. Two registrations on the same account and period therefore hold separate balance rows.
IdIdGuidYes
ModifiedByIdModified ByLookup → UserAccountYes
NameGL Account NameText, uniqueYes
OpeningBalanceOpening BalanceCurrencyA stored field that neither posting nor the rebuild ever populates: new rows are created with zero and rebuild leaves existing values untouched. Do not read it as a carried-forward prior-period balance — an opening position should be derived from the ledger or taken from the account-ledger and statement actions, which compute their own opening figures.
OwnerIdOwnerLookup → UserAccountYes
PartnerAccountIdPartner AccountLookup → AccountStamped from the owning company on the journal header when the row is first created. It is NOT part of the key the posting engine matches rows on — that key is account, period, branch, business unit, registration and the reporting subtype — so this value reflects whichever journal happened to open the row and should not be relied on to scope balances by company; scope through the GL account's company instead.
PeriodCreditPeriod CreditCurrencyThe running sum of credit amounts for the same account and dimension tuple within the period. The verification pass re-aggregates the posted ledger and reports any row whose stored debit or credit total differs from the recomputed one.
PeriodDebitPeriod DebitCurrencyThe running sum of debit amounts posted to this account and dimension tuple within the fiscal period, incremented as each journal posts and rewritten wholesale by a rebuild. Reversal journals add to this figure on the opposite side rather than subtracting from it, so gross totals stay visible.
RecordTypeIdRecord TypeGuid, hidden
UIPropsUI PropsText
UpdatedDateTimeUpdated OnDateAndTimeYes

Actions

ActionLabelTypeWhat it does
BulkDeleteDeleteDeleteDelete the selected records.
CloneCloneServerAction (Clone)Create a copy of this record
DeleteDeleteDeleteAlways fails. Removing a derived balance row does not remove the underlying ledger movement, so the platform refuses it outright; the rebuild-ledger-balances action on the fiscal period is the supported way to bring rows back in line with the posted ledger.
DeleteInListDeleteDeleteDelete in a list page
EditEditEditAlways fails. Correct a balance by posting or reversing a journal, or resync the whole period with the rebuild-ledger-balances action on the fiscal period.
EditListRowEditEditEditListRow
NewNewNewAlways fails. These rows are a derived projection of the posted ledger and the platform rejects any create through the data API — the only legitimate writers are journal posting and the rebuild service. To bring a balance into existence, post a journal that touches the account and period.