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

Incentive Plan — entity reference

The header of a sales-incentive programme in the Rewards app: who takes part (Member Type), over which window (Period Start Date, Period End Date and Period Type) and, through its child incentive lines, targets and compensation slabs, what is measured and paid. Saving a new plan generates its incentive periods once and, for Resource, Partner and Branch plans, queues a background job that enrols the matching active resources, partner accounts or branches as members; Customer members are added by hand. Members' per-period quotas are generated from a target's Value when its Target Value Type is Fixed Value, Value Across Periods or Value Across Resources. Only plans with Status Approved accrue performance and are scored by the incentive engine. Member Type, Member Resource Type, Period Type, Branch and the partner account and account group lock once the plan has members or targets. The seeded record page has no header actions, so the plan header cannot be edited after saving unless an administrator adds an Edit action to the layout.

Fields

FieldLabelTypeRequiredWhat it does
AccountGroupIdAccount GroupLookup → AccountGroupOptional customer account group. When set, only documents whose customer is in this group accrue performance against the plan. Not on the seeded forms.
AccountIdAccountLookup → AccountOptional customer account. When set, only documents for this customer accrue performance against the plan. Not on the seeded forms.
BranchIdBranchLookup → BranchOptional. When set, only documents of this branch accrue performance against the plan. Cannot be combined with a partner account group, and locked once the plan has members or targets. Not on the seeded forms.
BusinessHoursIdBusiness HoursLookup → BusinessHoursIntended to skip non-working days in Daily periods; Daily plans currently get a period for every calendar day. Not on the seeded forms.
CompensationEligibilityCompensation EligibilityPickListHow the amounts of several qualifying incentive lines combine into one member's incentive: Any One Max pays the largest line amount, Any One Min the smallest, and empty or Formulae add them together. Values: Any One Max, Any One Min, Formulae.
CompensationEligibilityFormulaCompensation Eligibility FormulaTextText kept with the Formulae option. Not evaluated: Formulae adds the line amounts together.
CopySourceTargetsCopy Source TargetsBooleanYesCopies nothing. Saving the plan with this box ticked only clears it again. Not on the seeded forms.
CreatedByIdCreated ByLookup → UserAccountYes
CreatedDateTimeCreated DateDateAndTimeYes
ExternalIdExternalTextA reference to the same plan in another system, for imports and integrations.
IdIdGuidYes
MemberResourceGroupIdResource GroupLookup → ResourceGroupLimits automatic enrolment of a Resource plan to the members of this resource group. Not on the seeded forms. Changing it re-runs enrolment, which only adds members.
MemberResourceTypeMember Resource TypePickListEnrols only resources whose Type or Resource Type equals this value. Allowed only when Member Type is Resource; saving fails otherwise. Locked once the plan has members or targets. Values: Service Advisor.
MemberTypeMember TypePickListWhat kind of member the plan rewards. The engine and the automatic enrolment recognise Resource, Partner and Branch; Customer plans, whose members are contacts added by hand, score only targets linked to a KPI configuration (matched on the contact's account), and Customer is not in the seeded picklist. The seeded values Dealer and Role are not recognised: such a plan enrols no one and its members never accrue achievement. Locked once the plan has members or targets. Values: Partner, Dealer, Branch, Resource, Role.
ModifiedByIdModified ByLookup → UserAccountYes
NameNameTextYesThe plan number, generated on save from the Incentive Plan document name setting (series INP). Read-only.
OwnerIdOwnerLookup → UserAccountYesThe user who owns the plan.
PartnerAccountGroupIdAccount GroupLookup → AccountGroupOptional partner account group. Limits accrual to documents of partners in the group, and enrolment to those partners (or their branches). Cannot be combined with a partner account or a branch, and locked once the plan has members or targets. Not on the seeded forms.
PartnerAccountIdAccountLookup → AccountOptional partner account. Limits accrual to that partner's documents, limits enrolment of a Partner plan to this partner and of a Branch plan to its branches, and is copied onto compensation records the plan creates. Locked once the plan has members or targets. Not on the seeded forms.
PeriodEndDatePeriod End DateDateYesLast day of the plan's window, inclusive. Required. Not checked against the start date: an earlier end date generates no periods, or one inverted period for a Yearly plan.
PeriodStartDatePeriod Start DateDateYesFirst day of the plan's window. Required. The first generated period starts here (aligned to the first of the month for Monthly and Quarterly plans and to Monday for Weekly and Bi Weekly plans).
PeriodTypePeriod TypePickListYesHow the window is cut into incentive periods when the plan is first saved: Yearly (one period), Quarterly (three-month blocks), Monthly, Weekly, Bi Weekly or Daily. The seeded picklist has Weekly, Monthly and Yearly only. Weekly, Bi Weekly and Daily plans may span at most one year. Periods are never regenerated, and the field locks once the plan has members or targets. Values: Weekly, Monthly, Yearly.
RecordTypeIdRecord TypeGuid, hiddenHidden system field for record types. Not used by incentive plans.
SourceIncentivePlanIdIncentive PlanLookup → IncentivePlanAn optional link to another plan this one was derived from. Stored for reference only; nothing copies from or reads the source plan. Not on the seeded forms.
StatusStatusPickListDraft, Pending Approval or Approved, moved with the status bar on the record page one stage forward at a time. Only Approved plans accrue performance, are scored and feed partner portal targets. No approval process is seeded, so anyone who can edit the plan can approve it. Values: Draft, Pending Approval, Approved.
SupplierAccountIdAccountLookup → AccountOptional supplier account. When set, only documents for this supplier accrue performance against the plan. Not on the seeded forms.
UIPropsUI PropsTextSystem field that stores display settings for the record. Not shown on the form.
UpdatedDateTimeModified DateDateAndTimeYes

Actions

ActionLabelTypeWhat it does
CloneCloneServerAction (Clone)Create a copy of this record
CreateCompensationSlabCreate Compensation SlabServerAction (CreateCompensationSlab)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 CompensationSlab rows directly through the data API instead). Only a tenant automation script bound to this action name would give it behavior.
CreateIncentiveLineCreate Incentive LineServerAction (CreateIncentiveLine)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 IncentiveLine rows directly through the data API instead). Only a tenant automation script bound to this action name would give it behavior.
CreateIncentiveTargetCreate Incentive TargetServerAction (CreateIncentiveTarget)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 IncentiveTarget rows directly through the data API instead). Only a tenant automation script bound to this action name would give it behavior.
NewNewNewNew
← Incentive Period Incentive Resource →