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

Scheme Consumption — entity reference

A summary table for trade scheme consumption by account, partner, branch, item or item group. Nothing in xMatix writes it: the scheme engine records consumption only in the Scheme Ledger, and budgets, Val Count limits and the Utilized Amount figure are all read from the ledger. The entity has no menu entry in any app, and sync profiles refuse to include it in either direction. The standard Scheme Consumption dashboard and the Scheme Utilisation analytics dataset are built from this table, so they stay empty unless rows are added to it some other way. Rows entered by hand change no scheme behaviour.

Fields

FieldLabelTypeRequiredWhat it does
AccountIdAccountLookup → AccountThe customer account the consumption is summarised for. On the create form only. Read by the Scheme Consumption analytics model as its account dimension, and never by the scheme engine.
BranchIdBranchLookup → BranchThe branch the consumption is summarised for. On the create form only. The analytics model joins on it for its branch dimension.
ConsumedAmountConsumed AmountCurrencyAmount consumed, defaulting to 0. Entered by hand, because no process calculates it. The analytics datasets sum it. Budget headroom is not affected by it.
ConsumedQuantityConsumed QuantityNumberQuantity consumed, defaulting to 0. Entered by hand, because no process calculates it. The analytics datasets sum it.
CreatedByIdCreated ByLookup → UserAccountYes
CreatedDateTimeCreated DateDateAndTimeYes
IdIdGuidYes
ItemGroupIdItem GroupLookup → ItemGroupThe item group the consumption is summarised for.
ItemIdItemLookup → ItemThe item the consumption is summarised for. The analytics model joins on it for its item dimension.
ModifiedByIdModified ByLookup → UserAccountYes
NameNameTextYesRecord number. When a row is saved, it is generated from the SCN document name series.
OwnerIdOwnerLookup → UserAccountYes
PartnerAccountIdPartner AccountLookup → AccountThe partner (distributor or dealer) account the consumption is summarised for. On the create form only. Not read by the scheme engine; partner budgets count Scheme Ledger rows instead.
RecordTypeIdRecord TypeGuid, hidden
SchemeNameScheme NameTextShown on the create form, but not stored: a value typed here is discarded on save. A consumption record therefore cannot be tied to a scheme.
UIPropsUI PropsText
UpdatedDateTimeModified DateDateAndTimeYes

Actions

ActionLabelTypeWhat it does
CloneCloneServerAction (Clone)Create a copy of this record
DeleteDeleteDeleteDelete
DeleteListHeaderDeleteDeleteDeleteListHeader
DeleteListRowDeleteDeleteDeleteListRow
EditEditEditEdit
EditInLineEditEditInlineEditInLine
EditListHeaderEditEditInlineEditListHeader
EditListRowEditEditEditListRow
NewNewNewNew