Related articles

DevelopersAPI guides

‘Targeted amount with monetary targets’ mechanism

Description

A mechanism where the earnings are a fixed amount, but the size of this amount depends on the level of transactions achieved.

Screenshot_2020-12-18_at_16.45.11.png

Example

A program line for which the earnings are £10,000 if transactions is less than £500,000, £20,000 if transactions is greater than or equal to £500,000 but less than £750,000, or £30,000 if transactions is greater than or equal to £750,000.

Configuration approach

You will be required to:

  • Configure one or more target bands, with a transactions target and an earnings amount for each (where each transactions target and each earnings amount is a monetary amount, in the currency of the parent trading program), as illustrated below for a GBP trading program:

Transactions Target (GBP)

Earnings (GBP)

1,000,000

10,000

1,500,000

20,000

2,000,000

30,000
  • Select one or more items for each dimension that has been configured for you as included items for the program line.

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.

To calculate an earnings result for the program line as a whole, Enable will compare the total for transactions value across the matching transaction lines with the transactions targets that have been configured for the program line to determine which target band, and therefore which earnings amount, applies.

To calculate an earnings result for each matching transaction line, Enable will use the entries for transactions value from the matching transaction lines to apportion the program line level result for earnings and derive an earnings result for each of the matching transaction lines.

Optional settings

You will be able (but not required) to use the ‘Mechanism details’ area of the program line configuration page to:

  • Enter a value in the Discount % box.
  • Select one or more program lines as deduction program lines.

Discount %

For a program line that uses the Targeted amount with monetary transactions plug-in, the discount percentage is set to null by default to indicate that there is no (i.e. zero%) discount percentage.

You will have the option of taking no action to accept the default null value for Discount % or typing a numeric value (to a maximum of 3 decimal places) to specify a discount percentage.

Please note — you should enter the percentage value, e.g. 2.5 as opposed to 0.025 for a 2.5% discount.

The expected scenario is one where a user enters a positive percentage (e.g. 2.5) to reduce the qualifying transactions, although the user may enter a negative percentage to inflate the relevant transactions. You will not be allowed to enter a percentage that is greater than 100% or less than -100%.

When a non-zero value is entered into the Discount % box a Discount deducted from setting will become visible (see ‘Deductions’ section below for further information).

For a program line that uses the Targeted amount with monetary transactions plug-in:

  • The Discount deducted from entry will be set to (and fixed as) Target transactions.
  • Trading Programs will use transactions that is net of the discount percentage to determine which target band applies.

Deductions

When using the Targeted amount with monetary transactions plug-in, no program lines will be selected for the Deductions setting by default.

You will have the option of taking no action to accept this default selection or selecting from a list of the program lines that have been configured for the parent trading program.

If you accept the default option, Enable will calculate both transactions and earnings for the ‘deduct from’ program line in the normal way, without referring to the earnings from any other program lines.

To calculate the earnings for a program line that uses the Targeted amount with monetary transactions plug-in where one or more program lines have been selected for the Deductions setting, Trading Programs will:

  • Sum the total program line earnings across the selected deduction program lines to derive a grand total for deducted earnings.
  • Calculate the total for transactions value across the included transaction lines for the ‘deduct from’ program line and subtracts the grand total for deducted earnings from this total to derive an adjusted transactions total for the program line.
  • Compare the adjusted total for transactions value with the transactions targets that have been configured for the program line to determine which target band, and therefore which earnings amount, applies to the ‘deduct from’ program line.
  • Use the entries for transactions value from the included transaction lines for the ‘deduct from’ program line to apportion the program line level result for earnings and derive an earnings result for each of these transaction lines.

Please note — for a program line where one or more program lines have been selected for the Deductions setting and a non-zero discount percentage has been entered, the discount percentage is applied first. That is, the relevant percentage discounts are applied before the earnings from the deductions program line(s) are subtracted.

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