Compensation Plan (CO)

Since version 9.0

Fields

uniqueName

ID of the plan, generated by the system. The prefix of the uniqueName can be modified via Advanced Configuration Option.

label

Name of the Compensation Plan entered by the user.

customerGroup

(CustomerGroup) Selection of customers (usually based on the customer hierarchy) for whom the plan is. This value is selected in the input field of the Compensation Plan header, and during Save copied to this field, so the value is available also in the list of Compensation Plans.

sellerGroup

Selection of sellers (usually based on the seller hierarchy) for whom the plan is.

productGroup

(ProductGroup) Selection of products (usually based on the product hierarchy) for which the plan is. This value is selected in the input field of the Compensation Plan header, and during Save copied to this field, so the value is available also in the list of Compensation Plans. (Available since version 10.0.)

startDate

First day of validity of the conditions negotiated on the compensation plan header and lines.

endDate

Last date of validity.

payoutDate

Date on which the seller expects to receive the compensation money. If there are more payouts periods during the contract duration, such dates will be specified via custom input fields.

targetDate

Stands for a "calculation date" – a date which will be used to distinguish which data are used for calculation. Its value is used automatically by the system when retrieving proper versions of Company Parameters. You can also use it the logic to select correct data which change in time.

inputs

Custom header input fields, created by the compensation header logic. It is used by the user to enter values/conditions needed to calculate the results.

outputs

Header results calculated for the Compensation Plan by the compensation header logic. Usually a summary / overall results for the whole agreement.

attributeExtension___<fieldName>

Arbitrary number of customizable attributeExtension fields which can be used to store any information you need. The fields with the String type do not have a limited size.

compensationStatus

Status of the compensation plan. All valid values are listed in the Compensation Status article.

creationWorkflowStatus

See CreationWorkflowStatus.

creationWorkflowCurrentStep

Order of the current active creation step (integer). The first step has number 0.

creationWorkflowStepCount

Total number of all creation steps (integer).

creationWorkflowStepLabel

Label of the current creation workflow step (String).

workflowStatus

See WorkflowStatus.

viewState

Contains some (limited) information about the state of the front-end application. See View State.