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/Interest Run — entity reference
REFERENCE · Last reviewed

Interest Run — entity reference

One overdue-interest accrual batch. As at its As Of Date, Compute Interest finds every overdue open item in scope, picks the governing interest policy and stages one draft interest charge per chargeable item; Post Interest turns the draft charges into ledger entries (a customer debit note for receivables, a journal plus open item for payables). Runs are created by hand in Finance Setup under Overdue Interest, or automatically by the scheduled job Accrue interest on overdue payments. Accrual windows are contiguous per open item across runs, so the total charged does not depend on how often runs are made.

Fields

FieldLabelTypeRequiredWhat it does
AsOfDateAs Of DateDateAccrual cut-off: interest is charged up to and including this date, an item is overdue only if its due date (or document date when it has none) is before it, and posted charges are dated on it. Defaults to today (UTC) when left empty.
BranchIdBranchLookup → BranchOptional scope: only open items on this branch are evaluated. Empty means every branch.
BusinessUnitIdBusiness UnitLookup → BusinessUnitOptional scope: only open items on this business unit are evaluated. Empty means every business unit.
ChargeCountCharge CountNumberHow many interest charges the last compute created.
ComputedOnComputed OnDateAndTimeWhen Compute Interest last ran on this run (UTC). Set by the system.
CreatedByIdCreated ByLookup → UserAccountYes
CreatedDateTimeCreated DateDateAndTimeYes
DirectionDirectionPickListReceivable (interest on overdue customer items, the default) or Payable (interest on overdue supplier items). Only policies for the same direction, or with no direction, are considered. Values: Receivable, Payable.
IdIdGuid, hiddenYes
IsPreviewIs PreviewBooleanTurn on for a rehearsal run. A preview can be computed and read but never posted, and its charges do not use up the accrual window, so a later real run still charges the same days. Cancel the preview before computing a real run with the same As Of Date, because a live preview charge and a real charge cannot both end on the same day for one item.
ItemsEvaluatedItems EvaluatedNumberHow many overdue open items the last compute looked at, charged or skipped.
LabelLabelTextDescriptive title. Left empty, it is filled on save as 'Interest run' followed by the as-of date and the direction.
MessageMessageLongMultiLineTextPlain-language outcome of the last compute, post or cancel: items evaluated, charges computed, skips by reason, and on posting how many charges posted, the total, and the error for each charge that failed.
ModifiedByIdModified ByLookup → UserAccountYes
NameNameTextYesYour name for the run; required. Runs created by the scheduled job are named automatically from the kind (POST or PREVIEW), direction, as-of date and scope, which is also how the job recognises a run it has already made.
OwnerIdOwnerLookup → UserAccountYes
PartnerAccountIdCompanyLookup → AccountOptional scope: only open items of this company are evaluated, and only policies for this company or for all companies are considered. Empty means every company.
PartyAccountIdPartyLookup → AccountOptional scope: only this customer's (or supplier's) open items are evaluated. Empty means every party.
PostedOnPosted OnDateAndTimeWhen Post Interest last ran on this run (UTC), including a post that left some charges failed. Set by the system.
RecordTypeIdRecord TypeGuid, hidden
StatusStatusPickListRead-only lifecycle set by the actions: Draft when created, Computed after Compute Interest (and after a post in which some charges failed), Posted after a post in which every draft charge posted, Cancelled after Cancel Run. Posted and Cancelled runs cannot be recomputed. Values: Draft, Computed, Posted, Cancelled.
SubscriptionKeySubscription KeyGuid, hiddenYes
TotalChargeAmountTotal Charge AmountCurrencyInterest plus tax of the charges created by the last compute; the amount posting will raise if every charge posts.
TotalInterestAmountTotal Interest AmountCurrencySum of the interest (before tax) of the charges created by the last compute.
TotalPrincipalAmountTotal Principal AmountCurrencySum of the principal of the charges created by the last compute.
TotalTaxAmountTotal Tax AmountCurrencySum of the GST on interest of the charges created by the last compute; empty or zero when no policy in scope applies GST.
UpdatedDateTimeModified DateDateAndTimeYes

Actions

ActionLabelTypeWhat it does
CancelInterestRunCancel RunServerAction (CancelInterestRun)Abandons the run. Its draft charges become Cancelled, which releases their accrual windows so a later run can re-charge those days.
ComputeInterestRunCompute InterestServerAction (ComputeInterestRun)Recomputes this run's interest charges for every overdue open item in scope. Existing draft charges are rebuilt; posted charges are left alone.
DeleteDeleteDeleteDelete Interest Run
EditEditEditEdit Interest Run
EditInLineEditEditInlineEdit Interest Run
NewNewNewNew Interest Run
PostInterestRunPost InterestServerAction (PostInterestRun)Posts the run's draft charges to the ledger: one balanced journal per charge plus a collectible open item.