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 Benefit — entity reference
REFERENCE · Last reviewed

Scheme Benefit — entity reference

One grant under a Scheme Slab (schemeLineId): rewardType selects the mechanics - Line Level Discount Percentage, Line Level Discount Amount, Discounted Item (a free or discounted item line for discountedItemId), Discounted Item Group (pick from discountedItemGroupId) or Reward Points. Free-item benefits either discount matching existing lines or insert new document lines flagged IsSchemeGenerated. When a slab has several benefits, the slab's rewardApplicability decides whether all apply, only the lowest- or highest-value one, or a custom-logic group. The engine copies limitExpiryDays onto the benefiting document lines.

Fields

FieldLabelTypeRequiredWhat it does
ApplyDiscountOnMRPApply Discount On MRPBooleanYes
ConversionRatioConversion RatioNumber
ConversionRatio1Conversion Ratio 1Number
CreatedByIdCreated ByLookup → UserAccountYes
CreatedDateTimeCreated DateDateAndTimeYes
DiscountAmountDiscount AmountNumber
DiscountedItemGroupIdDiscounted Item GroupLookup → ItemGroup
DiscountedItemIdDiscounted ItemLookup → Item
DiscountedItemLotTypeIdDiscounted Item Lot TypeLookup → ItemLotType
DiscountedItemQuantityDiscounted Item QuantityNumberHow many units of the discounted/free item one qualification grants; multiplied by the qualification count when RepeatReward or RepeatRewardsInRatio is on.
DiscountedItemRankingDiscounted Item RankingPickListWhen several document lines are candidates for the discount, pick them ordered High To Low or Low To High by line value. Values: High To Low, Low To High.
DiscountedItemSKUIdDiscounted SKULookup → SKU
DiscountedSKUIdDiscounted SKULookup → SKU, hidden, inactive
DiscountPercentDiscount PercentPercent
ExcludeDiscountedItemGroupIdExclude Discounted Item GroupLookup → ItemGroupLines whose item belongs to this group are never chosen as the discounted line, even if they match the discounted item/group.
ExcludeQualifyingItemsExclude Qualifying ItemsBooleanYesWhen choosing which document lines receive the discounted-item benefit, skip the lines that themselves qualified the condition - the reward must land on other lines.
IdIdGuidYes
LimitExpiryDaysLimit Expiry DaysNumberCopied by the engine onto the document lines that receive this benefit (their LimitExpiryDays field); carries a validity horizon for the granted benefit.
ModifiedByIdModified ByLookup → UserAccountYes
NameNameTextYes
OwnerIdOwnerLookup → UserAccountYes
RecommendationTextRecommendation TextLongMultiLineTextMarketing-style text shown with the scheme recommendation in the UI (product catalogue and recommendation widget); no effect on qualification or application.
RecordTypeIdRecord TypeGuid, hidden
RepeatRewardRepeat RewardBooleanYesGrant the benefit once per qualification count (floor of reached over threshold) instead of once per document. See also RepeatRewardsInRatio, which scales by the achievement ratio instead.
RepeatRewardForEveryQualificationRepeat Reward For Every QualificationBoolean
RepeatRewardsInRatioRepeat Rewards In RatioBooleanYesScale the reward by the target-to-achievement ratio rather than the whole-number qualification count - takes precedence over RepeatReward when both are set.
RewardMultiplierReward MultiplierPickListFor repeatable rewards, whether the multiplier is derived from Amount or from Quantity of the qualifying lines. Values: Amount.
RewardPointsReward PointsNumberPoints granted when RewardType is Reward Points: stamped onto the document's non-generated lines as SchemeRewardPoints and mirrored into SchemeLedger.rewardPoints.
RewardTypeReward TypePickListYesMechanics of the grant: Line Level Discount Percentage (DiscountPercent off qualifying lines), Line Level Discount Amount (DiscountAmount), Discounted Item (free or discounted line for DiscountedItemId), Discounted Item Group (candidates from DiscountedItemGroupId), or Reward Points (stamps RewardPoints onto document lines and the SchemeLedger). Values: Line Level Discount Percentage, Line Level Discount Amount, Discounted Item, Discounted Item Group, Reward Points.
SchemeIdSchemeLookup → Scheme
SchemeLineIdScheme SlabLookup → SchemeLine
SequenceNumberSequence NumberNumberYes
TitleTitleText
UIPropsUI PropsText
UOMUOMPickListValues: Pack, Each.
UOM1UOM 1PickListValues: Pack, Each.
UOMQuantityUOM QuantityNumber
UOMQuantity1UOM Quantity 1Number
UpdatedDateTimeModified DateDateAndTimeYes
ValidFromVal FromDate
ValidToVal ToDate

Actions

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

Lookup filters

FilterLookup fieldNotes
Scheme for Scheme SlabSchemeLineId