Scheme — entity reference

A promotional or trade scheme - the header record that makes discounts, free goods and reward points apply automatically to transactional documents. Only schemes with Status Approved are evaluated; the scheme engine runs on Orders, Invoices, Credit Notes, Purchase Orders, Bills and Service Orders, picking schemes whose schemeType matches the document, whose validFrom/validTo covers the document date and whose account/partner/account-group scoping matches. The actual qualification rules live on child SchemeLine rows (labelled Scheme Slabs), each pairing SchemeCondition rows (what must be bought) with SchemeBenefit rows (what is granted). On insert, SchemePeriod rows are generated from periodType. Every application is mirrored into SchemeLedger rows, which are the source of record for validCount limits and budget enforcement; SchemeAccountBudget rows cap spend globally and per partner.

Fields

Field	Label	Type	Required	What it does
`AccountGroupId`	Account Group	Lookup → AccountGroup
`AccountId`	Account	Lookup → Account
`ApplicableTransactionType`	Applicable Transaction Type	PickList		When set, the document's transaction type must equal this value or the scheme is skipped; empty means any transaction type.
`Application`	Application	PickList		How the scheme is triggered: Auto Apply schemes run automatically inside the document save; Apply On Selection schemes only surface in recommendation and qualification lists and take effect when a user explicitly applies them (the ApplyScheme server action on the document). Values: Auto Apply, Apply On Selection.
`BranchId`	Branch	Lookup → Branch
`BusinessHoursId`	Business Hour	Lookup → BusinessHours
`ClaimablePercentage`	Claimable Percentage	Percent
`ClaimGenerationFrequency`	Claim Generation Frequency	PickList		Values: Daily, Weekly, Monthly.
`CreatedById`	Created By	Lookup → UserAccount	Yes
`CreatedDateTime`	Created Date	DateAndTime	Yes
`Id`	Id	Guid	Yes
`IgnoreBudget`	Ignore Budget	Boolean	Yes	Skips all budget gating for this scheme: it applies on both Sale Order and Sale Invoice regardless of budget configuration or remaining budget. Without it, a scheme lacking both a global and a partner-scoped SchemeAccountBudget is suppressed on the Sale Invoice.
`IncludeChildAccountTransactions`	Include Child Account Transactions	Boolean	Yes	For Per Period schemes: also count PerformanceKPI accrual rows of the document account's child accounts toward the period totals, not just the account itself.
`IncludeRelatedAccountTransactions`	Include Related Account Transactions	Boolean	Yes	For Per Period schemes: also count PerformanceKPI accrual rows of sibling accounts under the same parent account toward the period totals.
`IsClaimable`	Is Claimable	Boolean	Yes
`ModifiedById`	Modified By	Lookup → UserAccount	Yes
`MultipleFulfilmentTreatment`	Multiple Fulfilment Treatment	PickList		What happens when several slabs of this scheme qualify on the same document: Apply All Fulfilled applies every qualifying slab, Apply First Fulfilled keeps only the first qualifying slab in sequence, Apply Last Fulfilled keeps only the last. Values: Apply All Fulfilled, Apply First Fulfilled, Apply Last Fulfilled.
`Name`	Scheme Name	Text	Yes
`OriginalSchemeId`	Original Scheme	Text
`OwnerId`	Owner	Lookup → UserAccount	Yes
`PartnerAccountGroupId`	Partner Account Group	Lookup → AccountGroup
`PartnerAccountId`	Partner Account	Lookup → Account
`PerformCloneScheme`	Perform Clone Scheme	Boolean	Yes
`PeriodEndDate`	Period End Date	Date
`PeriodStartDate`	Period Start Date	Date
`PeriodType`	Period Type	PickList	Yes	Granularity of the SchemePeriod rows generated on insert: Yearly (one period spanning validFrom-validTo), Quarterly, Monthly, Weekly, Bi-Weekly or Daily. Missing validFrom/validTo default to today plus a year (yearly/quarterly/monthly) or a month (weekly/daily). Periods are the accrual buckets for Per Period scheme types. Values: Validity Period, Per Order.
`RecordTypeId`	Record Type	Guid, hidden
`ReferenceSchemeId`	Reference Scheme	Lookup → Scheme
`RoundOffType`	Round Off Type	PickList		Ceil or Floor rounding the engine applies to computed scheme values (for example derived free-item quantities); empty means no rounding. Values: Floor, Ceil.
`SchemeBudget`	Scheme Budget	Decimal		Legacy header-level global budget; a value greater than zero counts as the scheme having a global budget. The live model expresses the scheme-wide budget as a partner-less SchemeAccountBudget row instead, and this header field is normally empty on migrated data.
`SchemeCode`	Scheme Code	Text
`SchemeQuota`	Scheme Quota	Percent
`SchemeType`	Scheme Type	PickList	Yes	Which document the scheme evaluates against: Per Sale Order, Per Sale Invoice, Per Sale Order And Invoice, Per Purchase Order, Per Bill, Per Purchase Order And Bill, Per Repair Order, Per Repair Order And Invoice - each qualifying on the single document - or the Per Period variants (Per Period Sale Order/Sale Invoice/Purchase Order/Bill/Repair Order), which qualify on totals accumulated in PerformanceKPI rows across the matching SchemePeriod. Values: Per Sale Order, Per Sale Invoice, Per Sale Order And Invoice, Per Purchase Order, Per Bill, Per Purchase Order And Bill, Per Repair Order, Per Repair Order And Invoice, Per Period Sale Order, Per Period Sale Invoice, Per Period Purchase Order, Per Period Bill, Per Period Repair Order, Sales Order Per Period.
`SequenceNumber`	Sequence Number	Number		Order in which schemes are loaded and evaluated by the engine; lower numbers are considered first.
`Status`	Status	PickList		Values: Draft, Pending Approval, Approved, Deactivated.
`SupplierAccountId`	Supplier Account	Lookup → Account
`UIProps`	UI Props	Text
`UpdatedDateTime`	Modified Date	DateAndTime	Yes
`UtilizedAmount`	Utilized Amount	Decimal		Denormalized consumption figure refreshed from live SchemeLedger rows (sum of netSchemeDiscount2) so admins can watch the budget deplete. Display-oriented: budget enforcement compares against the larger of this stored value and the live ledger sum, so a stale figure cannot wrongly admit a scheme.
`ValidCount`	Val Count	Number		Cap on how many distinct documents per customer account the scheme may apply to. Enforced live against SchemeLedger: the engine counts distinct applied documents of the current type for the account (excluding the document being saved) and stops applying once the count reaches this value. Zero or empty means unlimited.
`ValidFrom`	Val From	Date
`ValidTo`	Val To	Date

Actions

Action	Label	Type	What it does
`Clone`	Clone	ServerAction (`Clone`)	Create a copy of this record
`CreateSchemeBenefit`	Create Scheme Benefit	ServerAction (`CreateSchemeBenefit`)	Seeded as a server action but no server handler implements it - executing it performs no server work; the rewards designer creates SchemeBenefit rows directly through the data API.
`CreateSchemeCondition`	Create Scheme Condition	ServerAction (`CreateSchemeCondition`)	Seeded as a server action but no server handler implements it - executing it performs no server work; the rewards designer creates SchemeCondition rows directly through the data API.
`CreateSchemeSlab`	Create Scheme Slabs	ServerAction (`CreateSchemeSlab`)	Seeded as a server action but no server handler implements it - executing it saves the record and performs no other work (the rewards designer creates SchemeLine slab rows directly through the data API instead).
`Delete`	Delete	Delete	Delete In View Page
`DeleteEntityDetail`	Delete	Delete	DeleteEntityDetail
`DeleteInLine`	Delete	Delete	DeleteInLine
`Edit`	Edit	Edit	Edit in View Pages
`EditInLine`	Edit	EditInline	Edit
`EditInList`	Edit	Edit	Edit
`EditListHeader`	Edit	EditInline	EditListHeader
`Import`	Import	UIAction	Import
`New`	New	New	New
`Save`	Save	ServerAction	A plain record save; no server action handler adds behavior beyond persisting the scheme (period generation runs on insert via the lifecycle handler regardless of which save path is used).
`SubmitforApproval`	Submit for Approval	ServerAction	No server handler implements this action, so it performs no approval workflow - it is a plain save. A scheme becomes live by setting Status to Approved (only Approved schemes are evaluated by the engine).

Validations

Validation	Applies to	Error message	Notes
Valid To Rule	`ValidTo`, Error	Valid to should be greater than the valid from	Ensures Valid To date is not earlier than Valid From date

Lookup filters

Filter	Lookup field	Notes
Branch For Partner Account	`BranchId`

UserAccount — looks up via CreatedById
UserAccount — looks up via OwnerId
Scheme — looks up via ReferenceSchemeId
BusinessHours — looks up via BusinessHoursId
Account — looks up via AccountId
UserAccount — looks up via ModifiedById
AccountGroup — looks up via AccountGroupId
AccountGroup — looks up via PartnerAccountGroupId
Account — looks up via PartnerAccountId
Account — looks up via SupplierAccountId
Branch — looks up via BranchId
SchemeConsumption — referenced by via SchemeId
Scheme — referenced by via ReferenceSchemeId
SchemeAccountBudget — referenced by via SchemeId
SchemeLine — referenced by via SchemeId
SchemePeriod — referenced by via SchemeId
SchemeAccountBudgetUtilization — referenced by via SchemeId
PerformanceKPI — referenced by via SchemeId
SchemeBenefit — referenced by via SchemeId
Claim — referenced by via SchemeId
CompensationSlab — referenced by via SchemeId
SchemeCondition — referenced by via SchemeId
CompensationLine — referenced by via SchemeId

Scheme — entity reference

Fields

Actions

Validations

Lookup filters

Related entities

Related topics