| Info |
|---|
Since version 9.0 |
Compensation Records are created for each line of a Compensation Plan.
Compensation Records are used for:
Regular re-calculation of the compensation status during the year.
Approval of the compensation value.
Export of the approved payout money to the ERP system.
Allocation of the compensation to the archived Sales Transactions.
Reasons for separate Compensation Record entity:
When the business user prepares the Compensation Plan, the plan is in a draft state, so it is editable and it is possible to recalculate it. Once you approve the Compensation Plan, it will become read-only/fixed, and you cannot recalculate it anymore.
But the Compensation Plan is valid for a long period of time (usually a year) and the business needs to recalculate the accruals and estimated compensation size again and again during the whole agreement validity.
In addition, if you have more payout periods needed during the validity, it could be handy to calculate and approve the compensation money separately for those periods (e.g. semi-annually, quarterly, monthly).
When the logic calculates the Compensation line items, it also creates its Compensation Records which will be used later for storage of results of the repetitive recalculations of the accruals and compensation estimations.
The Compensation Records are recalculated:
Manually by the business user, on the Compensation Record detail screen.
By a specialized scheduled job, configured in Sales Compensations › Calculations.
The list of Compensation Records is located in Sales Compensations › Compensation Records.
| Info |
|---|
Notice the special filter Set: Default on that page. It causes that you see only Compensation Records from this particular Set. You cannot display Compensation Records belonging to different Sets at the same time because they can have different settings of the "attribute" columns (name, label, data type). |
The Compensation Records table provides a view of the status and compensation accruals across all customer compensation agreements. There is also integration status history available via an inline Compensation Record button. Admin user can also manually adjust/override Compensation Records or generate them for corrections.
Life Cycle
Creation – Compensation Records are created by the line item logic, i.e. when the compensation logic calculates the results for the line items.
Most of the Compensation Record’s fields are the same as for a line item, and their values are copied automatically from the line item at the time of the Compensation Record creation.
Calculation – Compensation Record results (usually compensation amount estimations and others) are calculated by a "compensation record" logic and stored in the Compensation Record’s attributes.
Approval – The approval of Compensation Record is usually used to approve the amount of compensation money calculated, to make sure it can be paid to the seller.
Export – Once the compensation amount is approved, then it is exported to an external system to be paid to the seller.
Explanations
Think about the Compensation Record as a storage for your calculation needs, so you can either have only one Compensation Record for the line item or many more.
Often we use several Compensation Records to make separate calculations for smaller time periods, e.g. when the line item validity is a year, and it should be paid quarterly, then it could be handy to create four Compensation Records, each calculating compensation for one quarter.
It does not have to be just a time period, maybe you will need to split the calculation across different dimensions, e.g. smaller groups of products, certain countries, etc.
You can also split Compensation Records into more "sets".
One set of Compensation Records to calculate the "accruals";
and another set of Compensation records for "payouts" (this payout is meant as a business term). For this purpose, you can assign each Compensation Record into a different "Set".
Fields
compensationRecordSetId
ID of the CompensationRecordSet into which this Compensation Record belongs. By default it belongs to "Default" CompensationRecordSet, but you can change it when you create the Compensation Record. That can be useful if you create different kinds of Compensation Records which will be used to calculate different results at different times.
customerGroup
–
productGroup
–
seller
–
inputs
Inputs specific to the Compensation Record. When users review the individual Compensation Record, they might need to enter certain values/setting specific for that particular values. The compensation logic (for Compensation Record) can specify those input fields.
agreementInputs
Input fields copied automatically from the line item. As the Compensation Record basically calculates the same values which were calculated during the preparation of the agreement on the line item, the Compensation Record needs access to the values entered by the user on the line item.
startDate
First date of validity of this record.
endDate
Last date of the validity of this record.
payoutDate
Date when the money should be paid.
calculationBase
Filter for Datamart used for the Compensation Allocation process and also to display associated Transactions on the Compensation Record detail screen. Accruals and Compensation estimations are typically based on data from Datamart. To specify which Transactions should get a portion of the calculated Compensation money amount, you need to specify the CalculationBase filter. The Datamart name is specified later, during configuration of the Allocation Process.
compensationConditionType
Compensation Condition type associated with this Compensation Record. It is the same as the one used for the line item.
status
Status of the Compensation Record. All valid values are listed in the Compensation Record Status article.
approvalState
State of approval workflow. For a list of states see Approval State.
compensationStatus
The status of the Compensation Plan that the Compensation Record was created from. When a plan revision is created, the 'Compensation Status' field on the Compensation Records for that agreement (not the status of the agreement) is set to either superseded or invalidated. All valid values are listed in the Compensation Status article.
attribute1..100
Keeps the compensation calculation results – any values needed for the business.
locked
Indicates whether a Compensation Record is locked for editing because it is part of a calculation. Administrator can manually unlock selected Compensation Records on the list page. (Available since version 13.0)