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

Scheme Benefit — entity reference

One reward under a trade scheme slab. Reward Type decides what it gives: a percentage or an amount off the document's open lines (every line not already carrying a slab and not scheme-generated, not only the lines that qualified), free or discounted units of one item or of an item group, or reward points on the document lines. The scheme engine finds a benefit through its Scheme Slab only, in Sequence Number order, and the slab's Reward Applicability decides which of the slab's benefits are applied. Discounted Item benefits first discount or split matching existing lines and add a new scheme-generated line for the remaining quantity only when Discount Percent is 100; Discounted Item Group benefits add lines only through Apply Scheme. Benefits are numbered from the SBN series.

Fields

FieldLabelTypeRequiredWhat it does
ApplyDiscountOnMRPApply Discount On MRPBooleanYesStored but not used by the scheme engine. Not on the shipped forms.
ConversionRatioConversion RatioNumberThe conversion ratio of the UOM unit, copied from the item when the quantity is derived. Not used by the scheme engine.
ConversionRatio1Conversion Ratio 1NumberThe conversion ratio of the UOM 1 unit, copied from the item when the quantity is derived. Not used by the scheme engine.
CreatedByIdCreated ByLookup → UserAccountYes
CreatedDateTimeCreated DateDateAndTimeYes
DiscountAmountDiscount AmountNumberAmount off. For Line Level Discount Amount it is multiplied by the repeat count and split across the open lines by base amount (or by quantity when Reward Multiplier is Quantity), rounded so the shares add up. On item benefits it takes priority over Discount Percent when above 0.
DiscountedItemGroupIdDiscounted Item GroupLookup → ItemGroupThe item group whose items a Discounted Item Group benefit discounts. Automatic application only discounts group lines already on the document; new group lines are added only through Apply Scheme, for the items the user picks.
DiscountedItemIdDiscounted ItemLookup → ItemThe item given free or at a discount by a Discounted Item benefit. Matching existing lines are discounted first; a new line for this item is added for the remaining quantity only at Discount Percent 100. Make it a different item from the qualifying item, otherwise the ordered line is split into paid and free units.
DiscountedItemLotTypeIdDiscounted Item Lot TypeLookup → ItemLotTypeOnly lines of this lot type are rewarded, and new free lines get this lot type.
DiscountedItemQuantityDiscounted Item QuantityNumberUnits rewarded per grant; 0 counts as 1. Multiplied by the qualification count with Repeat Reward, or by the achievement ratio with Repeat Rewards In Ratio. Also limits how many units of existing lines are discounted: a larger line is split. Can be derived from UOM and UOM Quantity on the record page.
DiscountedItemRankingDiscounted Item RankingPickListOrder in which matching existing lines receive the reward: High To Low starts with the most expensive line, Low To High or blank with the cheapest. Unit price is compared on sales and service documents, unit cost on purchase orders and bills. Not on the shipped forms. Values: High To Low, Low To High.
DiscountedItemSKUIdDiscounted SKULookup → SKUOnly lines of this SKU are rewarded, and new free lines get this SKU. For a Discounted Item Group benefit every added line gets this one SKU.
DiscountedSKUIdDiscounted SKULookup → SKU, hidden, inactiveInactive legacy field with no stored value. Use Discounted SKU (DiscountedItemSKUId).
DiscountPercentDiscount PercentPercentPercentage off, entered 0 to 100. For line-level benefits it applies once to every open line, whatever the qualification count. For Discounted Item benefits a new free line is added only when this is 100; a lower value only discounts matching lines already on the document.
ExcludeDiscountedItemGroupIdExclude Discounted Item GroupLookup → ItemGroupLines of items in this group are never chosen to receive the reward, and its items are never added as free lines. Not on the shipped forms.
ExcludeQualifyingItemsExclude Qualifying ItemsBooleanYesWhen on, lines of items named in the slab's conditions are not rewarded, and matching lines are always split rather than discounted whole.
IdIdGuidYes
LimitExpiryDaysLimit Expiry DaysNumberCopied onto the lines that receive the reward and cleared by Reset Scheme. On invoices with free-item stock checking on, it steers which lot is reserved for a free line. Not on the shipped forms.
ModifiedByIdModified ByLookup → UserAccountYes
NameNameTextYesThe benefit's reference, numbered automatically from the SBN series. Not shown on the shipped forms.
OwnerIdOwnerLookup → UserAccountYes
RecommendationTextRecommendation TextLongMultiLineTextThe wording shown for this benefit on scheme recommendation cards in the catalogue and the item panel, ahead of Title. No effect on qualification or application. Not on the shipped forms.
RecordTypeIdRecord TypeGuid, hidden
RepeatRewardRepeat RewardBooleanYesWhen on, the benefit is granted once per qualification count, the whole number of times the condition threshold was reached. Applies to Discount Amount and free-item quantities, not to Discount Percent or Reward Points. Editable on the record page only. Off by default.
RepeatRewardForEveryQualificationRepeat Reward For Every QualificationBooleanA switch on the benefit forms that the scheme engine does not read. Use Repeat Reward instead.
RepeatRewardsInRatioRepeat Rewards In RatioBooleanYesWhen on, the benefit is scaled by the achievement-to-target ratio, which can be fractional, and takes precedence over Repeat Reward. Free quantities are not rounded. Not on the shipped forms.
RewardMultiplierReward MultiplierPickListHow a Discount Amount is split across lines: Quantity splits by line quantity; Amount or blank splits by line base amount. The shipped picklist offers Amount only. Values: Amount.
RewardPointsReward PointsNumberPoints for a Reward Points benefit, written onto every line of the document that is not scheme-generated (also replacing the slab link of lines another benefit discounted) and onto each line's Scheme Ledger row. Not multiplied by repeats and not counted against budgets.
RewardTypeReward TypePickListYesWhat the benefit gives: Line Level Discount Percentage, Line Level Discount Amount, Discounted Item, Discounted Item Group or Reward Points. Line-level types apply to every open line of the document, not only the lines that met the conditions. An empty or unknown value gives nothing. Values: Line Level Discount Percentage, Line Level Discount Amount, Discounted Item, Discounted Item Group, Reward Points.
SchemeIdSchemeLookup → SchemeThe scheme the benefit belongs to, filled in by the slab card. The scheme engine does not read it: the scheme is taken from the benefit's slab.
SchemeLineIdScheme SlabLookup → SchemeLineThe slab that grants this benefit. The only link the scheme engine uses, so a benefit with no slab never applies. The list offers only slabs of the chosen Scheme.
SequenceNumberSequence NumberNumberYesOrder of the benefit within its slab. The slab card numbers rewards 1, 2, 3 in the order they are added; these are the numbers Reward Custom Logic refers to, and the order breaks ties for Any One With Lowest or Highest Value.
TitleTitleTextA short label for the reward. Shown on scheme recommendation cards when the benefit has no Recommendation Text. Not used to apply the benefit.
UIPropsUI PropsText
UOMUOMPickListUnit of measure for entering the free quantity on the record page. Must be a unit defined on the Discounted Item; with UOM Quantity it sets Discounted Item Quantity through the item's conversion ratio. Values: Pack, Each.
UOM1UOM 1PickListSecond unit of measure for the free quantity, added to the first. Must be a unit defined on the Discounted Item. Values: Pack, Each.
UOMQuantityUOM QuantityNumberFree quantity in the UOM unit. Multiplied by that unit's conversion ratio to set Discounted Item Quantity.
UOMQuantity1UOM Quantity 1NumberFree quantity in the UOM 1 unit, added to the first unit's quantity.
UpdatedDateTimeModified DateDateAndTimeYes
ValidFromVal FromDateFirst document date on which the benefit can apply, inclusive. Empty means no lower limit beyond the scheme's own validity.
ValidToVal ToDateLast document date on which the benefit can apply, inclusive. Empty means no upper limit beyond the scheme's own validity.

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