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

Performance KPI — entity reference

A flat performance fact row - the accumulator table that the Scheme and Incentive engines read to know what a partner, account or resource has actually done. Each row carries dimensional keys (accountId, partnerAccountId, supplierAccountId, branchId, resourceId, itemId, sKUId, plus schemeId/schemePeriodId for scheme-period accruals and incentivePlanId/incentivePeriodId/incentiveTargetId for incentive tracking) and a wide palette of per-document-type counters and totals: numberOfInvoices/Orders/Quotes/Bills/Leads/Opportunities/RepairOrders/ServiceRequests/PurchaseOrders and matching totalSaleInvoiceAmount/totalSaleOrderAmount/totalQuoteAmount/totalBillAmount/totalPurchaseOrderAmount/totalRepairOrderAmount quantity-and-amount pairs, plus generic totalAmount/totalQuantity and targetValue. Rows are posted by document services as business documents progress (for example OpportunityService posts one row per opportunity KPI recalculation with numberOfOpportunities=1 and the opportunity total). postingType separates consumer streams: the same event is posted once as SCHEME and once as INCENTIVE. SchemeEngine reads the SCHEME-side rows as its per-period summary, matching on schemeId/schemePeriodId and widening account scope to the account's parent, children and siblings; IncentiveEngine loads rows by incentivePlanId+incentivePeriodId to evaluate targets, including a Custom KPI target type that reads any named PerformanceKPI property by reflection. The Rewards reports (actuals vs targets by period, plan or account) are all built on this table.

Fields

FieldLabelTypeRequiredWhat it does
AccountIdAccountLookup → Account
BranchIdBranchLookup → Branch
CreatedByIdCreated ByLookup → UserAccountYes
CreatedDateTimeCreated DateDateAndTimeYes
IdIdGuidYes
IncentivePeriodIdIncentive PeriodLookup → IncentivePeriod
IncentivePlanIdIncentive PlanLookup → IncentivePlan
IncentiveTargetIdIncentive TargetLookup → IncentiveTarget
ItemIdItemLookup → Item
ModifiedByIdModified ByLookup → UserAccountYes
NameKPI NameTextYes
NumberOfBillsNumber Of BillsNumber
NumberOfInvoicesNumber Of InvoicesNumber
NumberOfLeadsNumber Of LeadsNumber
NumberOfOpportunitiesNumber Of OpportunitiesNumber
NumberOfOrdersNumber Of OrdersNumber
NumberOfPurchaseOrdersNumber Of Purchase OrdersNumber
NumberOfQuotesNumber Of QuotesNumber
NumberOfRepairOrdersNumber Of Repair OrdersNumber
NumberOfServiceRequestsNumber Of Service RequestsNumber
OwnerIdOwnerLookup → UserAccountYes
PartnerAccountIdPartner AccountLookup → Account
PostingTypePosting TypePickListDiscriminates which consumer stream the fact row belongs to: the posting services write the same business event twice, once with SCHEME (read by the scheme engine's period summary) and once with INCENTIVE (read by the incentive engine). Filter on it to avoid double counting when totalling rows. Values: KPI, Scheme Ledger.
RecordTypeIdRecord TypeGuid, hidden
ResourceIdResourceLookup → Resource
SchemeIdSchemeLookup → Scheme
SchemePeriodIdScheme PeriodLookup → SchemePeriodTies a scheme-side accrual row to a specific SchemePeriod. The scheme engine matches a document's date to the scheme's period windows and only counts rows whose SchemePeriodId falls in the matching window (rows without a period are counted for schemes that define no matching periods).
SKUIdSKULookup → SKU
SupplierAccountIdSupplier AccountLookup → Account
TargetValueTarget ValueCalculatedThe target figure the accumulated actuals are measured against for this slice; the Rewards reports pair it with TotalAmount to show actual versus target per incentive period.
TotalAmountTotal AmountCurrency
TotalBillAmountTotal Bill AmountCurrency
TotalBillQuantityTotal Bill QuantityNumber
TotalPurchaseOrderAmountTotal Purchase Order AmountCurrency
TotalPurchaseOrderQuantityTotal Purchase Order QuantityNumber
TotalQuantityTotal QuantityNumber
TotalQuoteAmountTotal Quote AmountCurrency
TotalQuoteQuantityTotal Quote QuantityNumber
TotalRepairOrderAmountTotal Repair Order AmountCurrency
TotalRepairOrderQuantityTotal Repair Order QuantityNumber
TotalSaleInvoiceAmountTotal Sale Invoice AmountCurrency
TotalSaleInvoiceQuantityTotal Sale Invoice QuantityNumber
TotalSaleOrderAmountTotal Sale Order AmountCurrency
TotalSaleOrderQuantityTotal Sale Order QuantityNumber
TotalServiceRequestAmountTotal Service Request AmountCurrency
TotalServiceRequestQuantityTotal Service Request QuantityNumber
TotalTaxAmountTotal Tax AmountCurrency
UIPropsUI PropsText
UpdatedDateTimeModified DateDateAndTimeYes

Actions

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