Related articles

DevelopersAPI guides

Generate a program earnings report

The program earnings report is the primary method for extracting transacted value, units, earnings, and effective rates for your programs. The report preview will show totals for each of the columns from the full data set (even if the preview doesn’t include all rows). These totals are not available in the download. This article will cover:

For an over view please see the below video.

What data does the program earnings report provide?

In addition to transaction totals, earnings, and effective rates, the program earnings report provides the following default columns:

  • Trading partner: this will be changed to your systems-specific label, for example, Supplier, Customer, etc. The label change is consistent within the download and preview of the report.
  • Trading partner reference: this will be changed to your systems-specific label, for example, Supplier reference, Customer reference, etc. Each row will have the reference of the trading partner the data is reconciled to.
  • Trading program ID: this will be the system-generated ID available on the settings page of the program denoted by an S.
  • Interim trading program?: provides a yes or no identifier to highlight which program lines are part of an interim program.
  • Program line reference: this is the user-set reference on the program line.
  • Program line ID: the system-generated ID for the specific program line denoted by a D.
  • Program line start date: set on the program line; this is the beginning of when the program line will begin earning.
  • Program line end date: set on the program line; this is when the program line will stop earning.
  • Program line type: shows which program line type has been assigned to the program line.
  • Mechanism: the name of the mechanism has been assigned to the program line.
  • (Optional) Dimension data: depending on the view by filter setting, you can increase granularity to levels comparable to your transaction granularity. For each selection made, a corresponding column will be added to the report. You can learn more about the view by filter here.
  • Total transacted value: the unaltered total transaction value that qualifies for earnings. This column is included due to the default transactions filter; adjustments to the filter will add or remove total transaction columns; learn more here.
  • Total transacted units: the total transaction units that qualify for earnings. This column is included due to the default transactions filter; adjustments to the filter will add or remove total transaction columns; learn more here.
  • Earnings: the current earnings are based on the mechanism chosen.
  • Effective rate: the earnings divided by the total effective total transacted value.
  • Currency: the currency of the program line.
  • Status: the calculation status of the program line, green, shows no pending calculations. You can hover your cursor over the icon to see the status text.

How to filter the program earnings report

  • Trading partner: this will be labeled as your trading partner designation (i.e., supplier or customer, etc.). You can individually select one or multiple trading partners. If you have trading partner attribute data, then you can also select groups of trading partners.
  • Trading program type version: select one or multiple trading program types; setting this filter as none will include all trading program types.
  • Trading program: filter to specific trading programs; clicking on the filter will allow you to search a list of trading programs on description, reference, or trading program ID.  The program list shown will respect the selections made in the trading partner filter.
  • Trading program status: filter to view trading programs with the active, proposal, interim or archived status or a combination of these options.
  • Program line: used to filter specific program lines, you can search the list of program lines by description, reference, or ID.
  • Program line type: choose from a list of your program line types; leave this as none to select them all.
  • Program line start date: this filter provides two optional date fields. Filling in the first field sets a from date; the report will only include program lines that start after this date set (this is inclusive). The second field sets a date which defines a cut-off point; only program lines beginning before this date will be included. If you have many agreements with staggered starts, you can filter to those that start in a certain window of time. The first and second filter fields can be used independently.
  • Program line end date: this filter provides two optional date fields. Filling in the first field sets a from date; the report will only include program lines that end after this date set (this is inclusive). The second field sets a date that defines a cut-off point; only program lines ending before this date will be included. If you have many agreements with staggered starts, you can filter to those that start in a certain window of time. The first and second filter fields can be used independently.
  • Program line results type: Choose to filter either Actual, Forecast, or advised program line result types; this will include the relevant transaction totals, earnings, and effective rate columns. If both actual and forecast are selected, appropriate columns will have the result type in brackets after the standard column name in both the preview and download. Each result type is explained in more detail here:
  • The actual option will be set as default and will show earnings based on the current effective transactions and attainment level (for tiered program lines).
  • The forecast option will show earnings based on the forecasted transactions for tiered agreements; this will calculate the future tier and apply that to the forecasted effective transactions.
  • The advised earnings will display the advised earnings for the program line; this is uploaded on the original transaction and is not calculated within Enable. If your channel is not using advised earnings, this field will be empty.
  • Dimension filters: filter by selecting dimension items or attributes of the report data from the transaction and earnings columns. Learn how to use the dimension filter here.
  • View by: adjust the granularity of the report based on dimension. You can split the earnings reported by ay any granularity across any of your dimensions or included trading partners. You will get additional rows for each portion of data and columns showing how transactions and earnings apply to that row. Learn more about using the view by filter here.
  • Hide results with no transactions: This is only viewable when at least one view by is set and will exclude all rows with no transactions associated with them.
  • Trading partner on transactions: this will use your label for your trading partner (i.e., supplier or customer, etc.). Selecting this will only show earnings, where the trading partners selected are the owners of the transactions. For example, if on your program line, the qualifying transactions include other trading partners, this filter allows you to filter to a specific trading partner's contribution.
  • Transaction date: Filling in the first field sets a from date; the report will only include transactions that occurred after this date set (this is inclusive). The second field sets a date that defines a cut-off point; only transactions ending before this date will be included. This allows you to see transactions (and earnings) based on any period of time. The first and second filter fields can be used independently to only allow transactions before or after a specific date.
  • Transactions: Selecting options in the transactions filter will add columns to the report for each transaction type that has been selected. Learn more about the transactions filter here.

How to extract insights from the transactions filter

The total transactions for a given program line can be affected by discounts, deductions, separate target & earnings and mechanism choices. The transaction filter allows you to specify precisely which transactions you want to report; below, the options from the transaction filter are shown. Each of the selections will report the total value or units corresponding to the reported earnings.

Basic transaction totals

  • Total transacted value: the total value of the qualifying transactions prior to any deductions or discounts.
  • Total transacted units: the total units on the qualifying transactions.
  • Effective transacted value: the total value of the qualifying transactions after deductions and discounts. This is used to calculate the effective rate. This field is not available when you apply a view by.

How to report separate target and earnings transacted totals

When using the separate target and earnings functionality with targeted (tiered) mechanisms, Enable allows you to report the transaction totals contributing to both the target dimension item selection and the earnings dimension item selection.

  • Target transacted value: the transaction total for the target selection. If a ratio target is being used with separate target and earnings, this will be based on the target transacted value; see reporting ratio target totals here for the subset totals.
  • Target transacted units: the unit total for the target selection. If a ratio target is being used with separate target and earnings, this will be based on the target transacted units; see reporting ratio target totals here for the subset totals.
  • Earnings transacted value: without separate target and earnings, this will be the same as the total transacted value field. When using separate targets and earnings, this is the total transacted value of the qualifying earnings transactions.
  • Earnings transacted units: without separate target and earnings, this will be the same as the basic total transacted units. When using separate targets and earnings, this is the total transacted units of the qualifying earnings transactions.

Reporting ratio target transaction totals

  • Subset transacted value: this will only be set if a ratio mechanism is used on the program lines and represents the total transacted value of the transactions corresponding to the subset selection of dimension items.
  • Subset transacted units: this will only be set if a ratio mechanism is used on the program lines and represents the total transacted units of the transactions corresponding to the subset selection of dimension items.

How to use the dimension filter

The precise format of the dimension filter is influenced by your organization's instance (channel) within Enable. Once a dimension filter is set, only data matching that filter will be included in the report preview or download.

The steps below outline the process of setting the dimension item filter. To simplify the explanation, this example is for a customer with only two dimensions, products, and branches, each with only a single collection.

  1. Click on the filter button.
  2. Click on add.
  3. Select a dimension in the drop-down. For the example above, we can select branches.
  4. (Optional) Select item to add individual items (branches) to include in the report. After making selections click Done.
  5. (Optional) Select attribute you can then select attributes (i.e., groupings) to include multiple items. After making selections click Done. This can be done in addition to step 4.
  6. Click on add to create a new dimension filter.
  7. Repeat steps 2-6 for each dimension you wish to filter on. The report will only include data that meet the conditions defined by each filter.

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.