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

Scheme Ledger — entity reference

The applied-scheme record: one row per document line that has a scheme applied, mirrored from the line state by the scheme engine on every save (rows for lines that no longer carry a scheme are deleted). Links the scheme/slab/benefit to the exact document line across Orders, Invoices, Credit Notes, Purchase Orders, Bills and Service Orders. This ledger is the source of record for enforcement: validCount apply-count limits and scheme/partner budget utilization are computed from it live, and inserting/updating rows triggers the account-budget utilization upsert. Not user-maintained - it is derived from transactions, and data sync deliberately protects it from being imported.

Fields

FieldLabelTypeRequiredWhat it does
AccountIdAccountLookup → Account
BillIdBillLookup → Bill
BillLineIdBill LineLookup → BillLine
BranchIdBranchLookup → Branch
CreatedByIdCreated ByLookup → UserAccountYes
CreatedDateTimeCreated DateDateAndTimeYes
DescriptionDescriptionText
DiscountDiscountPercentThe discount fraction copied from the document line's SchemeDiscount at sync time; the companion DiscountAmount carries the absolute amount and LineAmount the line's base amount.
DiscountAmountDiscount AmountCurrency
IdIdGuidYes
InvoiceIdInvoiceLookup
InvoiceId (dup-d8cd9ff0)InvoiceLookup → Invoice
InvoiceLineIdInvoice LineLookup → InvoiceLine
InvoiceLineId (dup-39357cb8)Invoice LineLookup
IsClaimedClaimedBooleanYesProcessed flag for the claim generation engine (same idiom as CreditNoteLine.IsClaimed): set once a claim has consumed this ledger row so it is not claimed twice.
LineAmountLine AmountCurrency
ModifiedByIdModified ByLookup → UserAccountYes
NameDocument NumberTextYes
NetSchemeDiscount2Net Scheme DiscountCurrencyThe normalized currency value of the applied benefit for this line: the discount amount when one is set, otherwise line amount times discount percent. This is the figure budget utilization and the denormalized budget displays consume.
OpportunityIdOpportunityLookup → Opportunity
OrderIdOrderLookup
OrderId (dup-30229b9d)OrderLookup → Order
OrderLineIdOrder LineLookup
OrderLineId (dup-ff82e134)Order LineLookup → OrderLine
OwnerIdOwnerLookup → UserAccountYes
PartnerAccountIdPartner AccountLookup → AccountPartner dimension stamped at sync time; partner-scoped SchemeAccountBudget rows aggregate ledger consumption through this key.
PurchaseOrderIdPurchase OrderLookup → PurchaseOrder
PurchaseOrderLineIdPurchase Order LineLookup → PurchaseOrderLine
QuoteIdQuoteLookup → Quote
RecordTypeIdRecord TypeGuid, hidden
ReturnIdSale ReturnLookup → Return
ReturnId (dup-175a25aa)ReturnLookup
ReturnLineIdReturn LineLookup
ReturnLineId (dup-43e8eca0)Sale Return LineLookup → ReturnLine
RewardPointsReward PointsNumberReward points the applied benefit granted on this line, copied from the line's SchemeRewardPoints.
SchemeBenefitIdScheme BenefitLookup → SchemeBenefit
SchemeIdSchemeLookup → Scheme
SchemeLineIdScheme SlabLookup → SchemeLine
ServiceOrderIdService OrderLookup → ServiceOrder
ServiceOrderId (dup-3b855515)Service OrderLookup
ServiceOrderLineIdService Order LineLookup
ServiceOrderLineId (dup-88cc914f)Service Order LineLookup → ServiceOrderLine
UIPropsUI PropsText
UpdatedDateTimeModified DateDateAndTimeYes

Actions

ActionLabelTypeWhat it does
BulkDeleteDeleteDeleteDelete
CloneCloneServerAction (Clone)Create a copy of this record
DeleteDeleteDeleteDelete
DeleteInListDeleteDeleteDelete
EditEditEditEdit
EditInLineEditEditInlineEdit
EditListHeaderEditEditInlineEditListHeader
EditListRowEditEditEditListRow
NewNewNewNew

Lookup filters

FilterLookup fieldNotes
Branch For Partner AccountBranchId