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

Incentive Period — entity reference

One time slice of an incentive plan in the Rewards app, such as a month of a monthly plan. Periods are generated once, when the plan is first saved, from its Period Start Date, Period End Date and Period Type, and each gets a name, Date From, Date To and Status Draft. Members' quotas, accrued performance, KPI data and compensation are all kept per period. Process Compensation on a period creates or refreshes its Compensation record and one Compensation Line per member, scores them and sets the period's Status to Calculated. A period with Status Approved or Posted counts as closed: Process Compensation refuses it, quota generation leaves it alone and KPI configuration accrual skips it, but neither value is in the seeded Status picklist. Incentive periods are in no app menu; open them from the Compensations tab of the plan's record page. The seeded period page has no header buttons, and the seeded create form has no Name, Date From or Date To, so hand-made periods need a data import or an adjusted layout.

Fields

FieldLabelTypeRequiredWhat it does
CreatedByIdCreated ByLookup → UserAccountYes
CreatedDateTimeCreated DateDateAndTimeYes
DateFromDate FromDateFirst day of the period, inclusive. Set by the generator. Performance and KPI data are placed in a period by comparing the document date with Date From and Date To. Not on the seeded create form.
DateToDate ToDateLast day of the period, inclusive. Set by the generator. Not on the seeded create form. A period without both dates gets no KPI configuration accruals, while performance KPI accrual treats a missing date as open-ended.
IdIdGuidYes
IncentivePlanIdIncentive PlanLookup → IncentivePlanThe incentive plan the period belongs to. Set by the generator. Process Compensation refuses a period with no plan, and only periods of Approved plans accrue performance.
ModifiedByIdModified ByLookup → UserAccountYes
NameNameTextYesThe period's name, set by the generator: the month and year for monthly periods (for example May - 2026), the first and last months for yearly and quarterly ones, the first and last dates for weekly ones and the day for daily ones. The Incentive Period document name setting is inactive, so a period created by hand or imported must be given a name, or the save fails with Name is required. A compensation record created by Process Compensation takes this name.
OwnerIdOwnerLookup → UserAccountYes
PeriodNamePeriod NameTextNot stored. The field is on the seeded create form and the Details tab, but anything typed into it is dropped on save. Use Name instead.
ProcessLogProcess LogTextSummary written by Process Compensation: when it ran, members scored, lines created and recalculated, lines skipped because compensation was already received, lines of members no longer on the plan, the total and as many per-member results as fit in 255 characters. Overwritten on each run. Not on any seeded layout.
RecordTypeIdRecord TypeGuid, hidden
SimulationNameSimulation NameTextDescriptive name for a what-if copy of a period. No xMatix feature creates or reads simulation copies.
SimulationSourcePeriodIdIncentive PeriodLookup → IncentivePeriodOn a what-if copy, the real period it was copied from. Shown as Incentive Period in the record header. No xMatix feature creates such copies.
SimulationTypeSimulation TypePickListMarks a period as a what-if copy. Any value excludes the period from quota generation and from the period count that Value Across Periods divides by, so never set it on a real period. Performance KPI accrual, KPI configuration accrual and Process Compensation do not check it. Values: Previous Period, Same Period Last Year, Imported KPI Data. No xMatix feature acts on the chosen value. Values: Previous Period, Same Period Last Year, Imported KPI Data.
StatusStatusPickListWhere the period is in its cycle. Generated periods start as Draft, and Process Compensation sets Calculated. Approved and Posted are treated as closed (Process Compensation refuses the period, quotas and KPI configuration accruals stop changing), but they are not in the seeded picklist, so an administrator adds them to close periods. An empty status counts as open. Performance KPI accrual ignores the status. Values: Calculated, Draft.
UIPropsUI PropsText
UpdatedDateTimeModified DateDateAndTimeYes

Actions

ActionLabelTypeWhat it does
BulkDeleteDeleteDeleteDelete
CloneCloneServerAction (Clone)Create a copy of this record
DeleteDeleteDeleteDelete
DeleteInListDeleteDeleteDelete
EditEditEditEdit
EditInLineEditEditEdit
NewNewNewNew