Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Life Cycle

  1. Creation – Rebate Records are created by the line item logic, i.e. when the logic calculates the results for the line items.

    • Most of the Rebate 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 RR creation.

  2. Calculation – Rebate Record results (usually rebate amount estimations and others) are calculated by a Rebate Record logic and stored in the Rebate Record’s attributes.

  3. Approval – The approval of Rebate Record is usually used to approve the amount of rebate money calculated, to make sure it can be paid to the customer.

  4. Export – Once the rebate amount is approved, it is exported to an external system to be paid to the customer.

relation 1 n.drawio
  • Think about the Rebate Record as a storage for your calculation needs, so you can either have only one RR for the line item or many more.

  • Often you use several RRs to make separate calculations for shorter 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 Rebate Records, each calculating rebate for one quarter.

    • It does not have to be just 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 RRs into more "sets".

    • One set of Rebate Records to calculate the "accruals";

    • and another set of Rebate Records for "payouts" (this payout is meant as a business term). For this purpose, you can assign each RR into a different "set".

Fields

rebateRecordSet – Name of the RebateRecordSet into which this RR belongs. By default, it belongs to "Default" RebateRecordSet, but you can change it when you create the RR. That can be useful if you create different "kinds" of RRs which will be used to calculate different results at different times.
calculationBase – Filter for Datamart used for the Rebate Allocation process and also to display associated transactions on the RR detail screen. Accruals and rebate estimations are typically based on data from Datamart. To specify which transactions should get a portion of the calculated rebate money amount, you need to specify the CalculationBase filter. The Datamart name is specified later, during configuration of the Allocation Process.
inputs – Inputs specific to the RR. When the user reviews the individual RR, they might need to enter certain values/setting specific for that particular values. The rebate logic (for RR) can specify those input fields.
agreementInputs – Input fields copied automatically from the line item. As the RR basically calculates the same values which were calculated during the preparation of the agreement on the line item, the RR needs access to the values entered by the user on the line item.
rebateType – Rebate type associated with this RR, it is the same as the one used for the line item.
status
Status
Rebate Record Status. Represents the current lifecycle status of the Rebate Record.
All valid values are listed in the rebate record status article.
agreementStatus
The status of the Rebate Agreement that the Rebate Record was created from. When an agreement revision is created, the 'Agreement Status' field on the Rebate Records for that agreement (not the status of the agreement) is set to either superseded or invalidated. All valid values are listed in the Rebate Agreement status article.