Performance KPI — entity reference

A running total of what one party sold or bought in one incentive period or trade-scheme period. Records are written only by the Perform KPI Calculation action on a document (out of the box on Order and Invoice; Purchase Order, Bill, Service Order and Opportunity are supported once an administrator adds the action), never by saving. One run writes INCENTIVE records for each target of each Approved incentive plan whose period, validity and filters match the document, and SCHEME records for each Approved Per Period scheme of the matching type. Each kind has a header record (no item) with document counts and totals, plus one record per matching item for targets or schemes limited to items. A record is identified by posting type, account, partner account, supplier account, branch, resource, scheme and scheme period or plan, period and target, and item; later documents with the same keys add to it. Each document is counted once (its KPI Calculated field is set), and nothing reverses a cancelled or changed document. Incentive targets without a KPI configuration are scored by summing the member's matching records for the plan and period; Per Period schemes read the SCHEME records. Performance KPI is in no app; the Rewards reports New KPIs Report, New KPIs with Incentive Target Report and KPIs with Incentive Plan Report list it.

Fields

Field	Label	Type	Required	What it does
`AccountId`	Account	Lookup → Account		The customer on the source document. Empty for purchase orders and bills. Customer-type plan members never match it, because the member stores a contact.
`BranchId`	Branch	Lookup → Branch		The source document's branch. Branch-type incentive plans match their members on this field.
`CreatedById`	Created By	Lookup → UserAccount	Yes
`CreatedDateTime`	Created Date	DateAndTime	Yes
`Id`	Id	Guid	Yes
`IncentivePeriodId`	Incentive Period	Lookup → IncentivePeriod		The incentive period whose Date From and Date To contain the document date. The period's status is not checked.
`IncentivePlanId`	Incentive Plan	Lookup → IncentivePlan		The Approved incentive plan an INCENTIVE record counts towards. Empty on scheme records.
`IncentiveTargetId`	Incentive Target	Lookup → IncentiveTarget		The incentive target the record counts towards. Only targets whose type the document can move, and whose account and account-group filters match, get records.
`ItemId`	Item	Lookup → Item		The item an item record counts. Empty on header records. Item records are written only for targets or schemes limited to an item or item group, and targets with an item filter read only these records.
`ModifiedById`	Modified By	Lookup → UserAccount	Yes
`Name`	KPI Name	Text	Yes	A number from the Performance KPI numbering series (PKPI), stamped when the record is created.
`NumberOfBills`	Number Of Bills	Number		Bills counted, once the action has been added to bills.
`NumberOfInvoices`	Number Of Invoices	Number		Invoices counted on the header record, one per invoice.
`NumberOfLeads`	Number Of Leads	Number		Never written by the calculation. Available for imported records.
`NumberOfOpportunities`	Number Of Opportunities	Number		Opportunities counted, once the action has been added to opportunities.
`NumberOfOrders`	Number Of Orders	Number		Sale orders counted on the header record, one per order.
`NumberOfPurchaseOrders`	Number Of Purchase Orders	Number		Purchase orders counted, once the action has been added to purchase orders.
`NumberOfQuotes`	Number Of Quotes	Number		Never written by the calculation. Available for imported records.
`NumberOfRepairOrders`	Number Of Repair Orders	Number		Service orders counted, once the action has been added to service orders.
`NumberOfServiceRequests`	Number Of Service Requests	Number		Opportunities counted, once the action has been added to opportunities. Goes up together with Number Of Opportunities.
`OwnerId`	Owner	Lookup → UserAccount	Yes
`PartnerAccountId`	Partner Account	Lookup → Account		The source document's partner account. Partner-type incentive plans match their members on this field.
`PostingType`	Posting Type	PickList		Which engine reads the record. The calculation writes INCENTIVE for incentive-target records and SCHEME for Per Period scheme records. The seeded picklist values KPI and Scheme Ledger are never written by the system. Add up records only within one posting type. Values: KPI, Scheme Ledger.
`RecordTypeId`	Record Type	Guid, hidden
`ResourceId`	Resource	Lookup → Resource		The rep on the source document: the order's Executive, or the invoice's Executive (falling back to Executive Resource). Resource-type incentive plans match their members on this field.
`SchemeId`	Scheme	Lookup → Scheme		The Approved Per Period scheme a SCHEME record counts towards. Empty on incentive records.
`SchemePeriodId`	Scheme Period	Lookup → SchemePeriod		Ties a scheme record to the scheme period whose dates contain the document date. Empty when the scheme has no periods. A document dated outside every period of a scheme that has periods is not recorded for it.
`SKUId`	SKU	Lookup → SKU		Never set by the calculation. Available for imported records.
`SupplierAccountId`	Supplier Account	Lookup → Account		The source document's supplier account. Used by scheme filters and scheme evaluation.
`TargetValue`	Target Value	Calculated		The rep's quota for this period and target, copied from the member quotas when a document for a Resource member is calculated. Replaced, not added, on each document, so a changed quota reaches the record only with the next calculated document.
`TotalAmount`	Total Amount	Currency		Amount without tax. Header record: the document's line total (parts plus labour for service orders). Item record: the line amount.
`TotalBillAmount`	Total Bill Amount	Currency		Bill amount without tax. No built-in target type scores it.
`TotalBillQuantity`	Total Bill Quantity	Number		Bill quantity. No built-in target type scores it.
`TotalPurchaseOrderAmount`	Total Purchase Order Amount	Currency		Purchase order amount without tax. Read by Purchase Order Amount targets.
`TotalPurchaseOrderQuantity`	Total Purchase Order Quantity	Number		Purchase order quantity. Read by Purchase Order Quantity targets.
`TotalQuantity`	Total Quantity	Number		Header record: the sum of the document's positive line quantities. Item record: the line quantity.
`TotalQuoteAmount`	Total Quote Amount	Currency		Never written by the calculation. Available for imported records.
`TotalQuoteQuantity`	Total Quote Quantity	Number		Never written by the calculation. Available for imported records.
`TotalRepairOrderAmount`	Total Repair Order Amount	Currency		Service order parts plus labour; the header record includes tax. No built-in target type scores it.
`TotalRepairOrderQuantity`	Total Repair Order Quantity	Number		Service order quantity. No built-in target type scores it.
`TotalSaleInvoiceAmount`	Total Sale Invoice Amount	Currency		Invoice amount. On the header record it includes tax; on an item record it is the line amount. Read by Sale Amount targets.
`TotalSaleInvoiceQuantity`	Total Sale Invoice Quantity	Number		Invoice quantity. Read by Invoice Quantity targets.
`TotalSaleOrderAmount`	Total Sale Order Amount	Currency		Sale order amount. On the header record it includes tax; on an item record it is the line amount. Read by Sale Order Amount targets.
`TotalSaleOrderQuantity`	Total Sale Order Quantity	Number		Sale order quantity. Read by Sale Order Quantity targets.
`TotalServiceRequestAmount`	Total Service Request Amount	Currency		Opportunity amount; the header record includes tax. No built-in target type scores it.
`TotalServiceRequestQuantity`	Total Service Request Quantity	Number		Opportunity quantity. No built-in target type scores it.
`TotalTaxAmount`	Total Tax Amount	Currency		The document's tax, on header records only. Zero for purchase orders and bills.
`UIProps`	UI Props	Text
`UpdatedDateTime`	Modified Date	DateAndTime	Yes

Actions

Action	Label	Type	What it does
`BulkDelete`	Delete	Delete	Delete
`Clone`	Clone	ServerAction (`Clone`)	Create a copy of this record
`Delete`	Delete	Delete	Delete
`DeleteInList`	Delete	Delete	Delete
`Edit`	Edit	Edit	Edit
`EditInLine`	Edit	Edit	Edit
`New`	New	New	New

Account — looks up via SupplierAccountId
IncentivePeriod — looks up via IncentivePeriodId
UserAccount — looks up via CreatedById
SKU — looks up via SKUId
Item — looks up via ItemId
UserAccount — looks up via ModifiedById
IncentivePlan — looks up via IncentivePlanId
Resource — looks up via ResourceId
Scheme — looks up via SchemeId
UserAccount — looks up via OwnerId
Account — looks up via AccountId
Account — looks up via PartnerAccountId
Branch — looks up via BranchId
SchemePeriod — looks up via SchemePeriodId
IncentiveTarget — looks up via IncentiveTargetId

Performance KPI — entity reference

Fields

Actions

Related entities

Related topics