System Objects Attributes (Sales Compensation)

1 Sellers
2 Compensation Plan
3 Compensation Type
4 Compensation Record
5 Compensation Accrual Record
6 Condition Type

Sellers

Label	Attribute	Description

Label	Attribute	Description
Seller ID	`sellerId`	Used to identify the sellers. These fields are most often used in the code.
Seller Name	`name`
Reports To	`reportsTo`	Used in dashboards to identify a manager of a given seller. If empty, the person is the manager.
First Name	`attribute1`	Used in dashboards and selection options for more user friendly identification of sellers.
Surname	`attribute2`
Pricefx User Account ID	`attribute3`	Used in dashboards to map a seller to a currently logged in user to restrict the visible content.
Termination Date	`attribute5`	Defines the termination date of the seller. This affects (re)generation of records related to the seller.

Compensation Plan

Label	Attribute	Description

Label	Attribute	Description
Name	`uniqueName`
Name without revision	`rootUniqueName`
Label	`label`
Workflow Status	`workflowStatus`
Workflow Submitter	`submittedByName`
Customer(s)	`customerGroup`
Seller Name	`sellerName`	Propagated from Header Input, defines the seller assigned to the agreement
Status	`compensationPlanStatus`
Compensation Type	`compensationHeaderType`	Defines the type of the agreement. Used for filtering out non-SC related agreements, for example in dashboards.
Payout Currency	`attributeExtension___currency`

Compensation Type

Label	Attribute	Description

Label	Attribute	Description
Name	`uniqueName`
Header Logic	`headerFormulaName`	Defines the logic used for all header inputs and output handling.
Compensation Plan Workflow	`workflowFormulaName`	Defines the logics used for workflow handling on the agreement and record level.
Compensation Record Workflow	`scRecordWorkflowFormulaName`
Filtering logic	`scTypeFilterFormulaName`	Defines the logics used for filtering available line items to be selected in agreements.

Compensation Record

Label	Attribute	Description

Label	Attribute	Description
ID	`uniqueName`
Set	`compensationRecordSetLabel`
Source ID	`sourceld`
Source ID without revision	`sourceldNoRev`
Rank	`rank`
Status	`status`
Compensation Plan Status	`compensation Status`	Taken from Plan (or Line Item) inputs or properties.
Name	`name`
Label	`label`
Condition Type	`compensationConditionType`	Defines what type of compensation has been selected.
Customer/Customer grouping		Taken from Plan (or Line Item) inputs or properties.
Product/Product grouping		Taken from Plan (or Line Item) inputs or properties.
Compensation Type	`compensationHeaderType`	Taken from Plan (or Line Item) inputs or properties.
Seller Name	`sellerName`	Taken from Plan (or Line Item) inputs or properties.
Current Baseline Value	`attribute1`	Typically represents revenue, gross margin or volume in some cases. It depends on the relevant Condition Type.
Compensation Payment	`attribute2`	Calculation result
Pay To ID	`attribute3`	Calculation result
Current Baseline Quantity	`attribute4`	Calculation result
Current Baseline Value (Source Currency)	`attribute5`	Typically represents revenue, gross margin or volume in some cases. It depends on the relevant Condition Type.
Compensation Payment (Source Currency)	`attribute6`
Previous Baseline Value (Source Currency)	`attribute7`	This number represents a value from one period ago. It typically represents volume, revenue, or margin depending on the relevant Condition Type.
Forecasted Baseline Value	`attribute8`	Typically represents forecasted revenue, gross margin or volume in some cases. It depends on the relevant Condition Type.
Compensation Forecast	`attribute9`	Calculation result
True-up	`attribute10`	Calculation result
Forecast Method	`attribute11`	Calculation result
Sales Goal Increase %	`attribute12`	Calculation result
Previous Compensation (Source Currency)	`attribute13`
Forecasted Quantity	`attribute14`	Calculation result
General Filter	`attribute15`
Payout Currency	`attribute16`	Calculation result
Period Name	`attribute17`	Calculation result
Previous Baseline Value	`attribute18`	Calculation result
Previous Compensation	`attribute19`	Calculation result
Source Currency	`attribute20`
Current Period Adjustment IDs	`attribute21`	Calculation result
Previous Period Adjustment IDs	`attribute22`
Forecasted Baseline Value (Source Currency)	`attribute23`	Typically represents forecasted revenue, gross margin or volume in some cases. It depends on the relevant Condition Type.
Compensation Forecast (Source Currency)	`attribute24`	Calculation result
True-up (Source Currency)	`attribute25`	Calculation result
Holdback	`attribute26`
Holdback (Source Currency)	`attribute27`
Current Compensation	`attribute28`
Current Compensation (Source Currency)	`attribute29`

Compensation Accrual Record

Label	Attribute	Description

Label	Attribute	Description
Seller ID	`attribute1`
`Current Period Pricing Month`	`attribute2`
`Current Period Pricing Quarter`	`attribute3`
`Current Period Pricing Semi Year`	`attribute4`
`Current Period Pricing Year`	`attribute5`
`Current Period Pricing Baseline`	`attribute6`
`Prior Period Pricing Month`	`attribute7`
`Prior Period Pricing Quarter`	`attribute8`
`Prior Period Pricing Semi Year`	`attribute9`
`Prior Period Pricing Year`	`attribute10`
`Prior Period Pricing Baseline`	`attribute11`	This number represents a value from one period ago. It typically represents volume, revenue, or margin depending on the relevant Condition Type.
`Penultimate Period Pricing Month`	`attribute12`
`Penultimate Period Pricing Quarter`	`attribute13`
`Penultimate Period Pricing Semi Year`	`attribute14`
`Penultimate Period Pricing Year`	`attribute15`
`Penultimate Period Pricing Baseline`	`attribute16`	This number represents a value from two periods ago. It typically represents volume, revenue, or margin depending on the relevant Condition Type.
Product ID	`attribute17`
Customer ID	`attribute18`
Record Period	`attribute19`
`Agreement Source ID`	`attribute20`
`Adjustment Invoice Price`	`attribute21`
`Adjustment Quantity`	`attribute22`
`Adjustment Margin`	`attribute23`
`Current Period Pricing Baseline (Source Currency)`	`attribute24`	Typically represents revenue, gross margin or volume in some cases. It depends on the relevant Condition Type.
`Prior Period Pricing Baseline (Source Currency)`	`attribute25`	This number represents a value from one period ago. It typically represents volume, revenue, or margin depending on the relevant Condition Type.
`Penultimate Period Pricing Baseline (Source Currency)`	`attribute26`	This number represents a value from two periods ago. It typically represents volume, revenue, or margin depending on the relevant Condition Type.
Source Currency	`attribute27`
Payout Currency	`attribute28`
Pricing Date	`attribute29`

Condition Type

Condition Type attributes are needed for the Sales Compensation logic to calculate the compensation value and Compensation Records.

Label	Attribute	Description

Label	Attribute	Description
Pricing logic	`formulaName`	Sets a logic to run. The value should be "Compensation Logic".
Customer Selection Level	`attribute1`
Customer Filter Logic	`attribute2`
Payment Period	`attribute3`	Defines the payment period for a Condition Type. If users do not set a value for this attribute, there is the "Payment Period" input in the Compensation Agreement with the same values. Possible values: "Monthly", "Quarterly", "Semi-Annually", "Annually" The default value can be set in Advanced Configuration Options. If needed, the value can be overridden here.
Condition Type Name	`attribute4`	Sets a Condition Type template for the current Condition Type. The value is set to "Condition Type Name" in Company Parameters.
Payout Days	`attribute5`	Enter the number of days after the end date of the payment period when the user wants the payout. The default value can be set in Advanced Configuration Options. If needed, the value can be overidden here.
Compensation Source Name	`attribute6`
Compensation Base Field Value	`attribute7`
Compensation Base Field Date	`attribute8`
Quota For	`attribute9`	Defines the target input for a period or for the whole plan duration. Possible values: "Payment Period", "Plan Duration" The default value can be set in Advanced Configuration Options. If needed, the value can be overridden here.
Source Type	`attribute10`	Possible values: "DataMart", "DataSource"
Deposit Scheme	`attribute11`	Defines the calculation type for a compensation value. If Quota For = "Payment Period", users do not need to set a value for this attribute. Possible values: "Cumulative", "Non-Cumulative" The default value can be set in Advanced Configuration Options. If needed, the value can be overridden here.
Compensation Base Field Customer ID	`attribute12`
Compensation Base Filed Product ID	`attribute13`
Compensation Base Field Quantity	`attribute14`
Product Filter Logic	`attribute15`
Compensation Base Field Invoice Price	`attribute16`
Compensation Base Field Margin	`attribute17`
Compensation Base Field Seller ID	`attribute18`
Is Compensation Cap Applied	`attribute19`	Enabled by default. Possible values: "Yes", "No"