Related articles

DevelopersAPI guides

‘Externally calculated — apportioned’ mechanism

Definition

A sum is apportioned to the qualifying transactions for the program line allowing more accurate granular reporting. The value is calculated outside of Enable and therefore can be updated at any point.

The value is based on external factors that do relate to the dimensions in Enable. Therefore, when you run the rebate earnings report for such dimensions, you will see the program earnings within the report.

Screenshot_2021-03-17_at_10.28.46.png

Example

A program line for which the earnings of £20,000 have been calculated outside of Enable and can be updated at any point. This amount then is apportioned between all the branches in the West Midlands.

Configuration approach

Within Enable, you will be required to enter a monetary amount for the program line and select at least one dimension item for each of your dimensions.

Enable will select matching transaction lines for the program line, based on:

  • The trading partner to which the program line belongs.
  • Your dimension item selections.
  • The start and end date of the program line.
  • The currency of the parent trading program.

Enable will assign your earnings value as the earnings for the program line.

To calculate an earnings result for a matching transaction line, Enable will apportion the earnings entered for the program line based upon the transaction value that applies to the transaction line relative to the total transaction value of all included transaction lines.

When a client member dimension has been configured, you will be required to upload member earnings for the selected client member dimension instead of entering a single monetary amount for the program line.

Enable will then assign the sum of the uploaded client member earning values as the earnings for the program line.

To calculate an earnings result for a matching transaction line, Enable will apportion the earnings entered for the associated client member based upon the transaction value that applies to the transaction line relative to the total transaction value of all included transaction lines associated to the client member.

Additional information

When the Finance App is enabled, you will be able to modify the payment line level earnings for a program line that uses the Externally calculated (apportioned) plugin. Modifying the payment line level earnings will update the total program line earnings entered.

You will not be able to modify the payment line level earnings when the Finance App has been configured to use accrual earnings.

You will always be able to edit the earnings entered for a program line that uses the Externally calculated (apportioned) plugin, even if the program line is locked, provided that payment line level earnings have not been modified in the Finance App.

Program line earnings associated with a program line that uses the Externally calculated (apportioned) plugin will not been shown in the program PDF.

Optional settings

The Externally calculated (apportioned) plugin has the following optional settings which can be configured for you in Enable:

  • Enable additional conditions.
  • Basis for scaled accrual earnings.

Additional conditions

Additional conditions can, optionally, be enabled for all mechanisms. When enabled, you will have the option to apply additional conditions to a program line. Currently, the only type of additional condition available is manual conditions which, when selected, allow you to select whether manual conditions have been met or not.

When manual conditions have been met, the program line will be calculated as normal. If manual conditions have not been met, the program line and transaction line level earnings will be set to 0.

Basis for scaled accrual earnings

Apportion program line total is the default for this setting.

When the selection of this setting is configured as Apportion scaled total and the Finance App is enabled:

  • The Enable earnings for program lines using this mechanism will be calculated using a scaled factor which is derived by comparing the current date and time with the program line's start and end date.
  • If the Finance App is configured to use accrual, the payment line level earnings will be calculated using a scaled factor which is derived by comparing the latest transaction date with the payment line's start and end date.
Not useful
1
2
3
4
5
Very useful
Thank you! Your submission has been received!
Oops! Something went wrong while submitting the form.

Still have questions?
Raise a ticket or contact our support team.

By using this website, you agree to the storing of cookies on your device to enhance site navigation, analyze site usage, and assist in our marketing efforts. View our Privacy Policy for more information.
Accept