Related articles

DevelopersAPI guides

Generate a daily earnings report

Generating a daily earnings report allows earnings results for a specific trading partner to be extracted from Trading Programs for a specified period of time.

When clicking on Reports at the top of the page and then on Daily earnings in the drop-down menu, you will be taken to a page that allows you to extract actual earnings results from Trading Programs that relate to trading activity over a specified time period, including the transactions that has generated those earnings.

You will be required to select a single trading partner and then (optionally) filter by any of the following:

  • Trading partner  · Select either a single or multiple trading partners and collections.
  • Transaction date, ‘From’ and ‘To’ · Enter a ‘From’ and ‘To’ date to filter by transaction date.
  • Type · Choose from a list of configured program line types.
  • Currency · A pre-configured option of one or more currencies which can be selected from a drop-down menu.
  • By program line · A tick box which when selected filters daily earnings per program line.
  • Frequency · Select the frequency by which to present earnings i.e. daily, weekly, monthly etc.
  • Program line · Enter an existing program line ID number, description or reference (shown below)
  • Dimension filters · Choose to filter by selecting dimension items or attributes.
  • View by · Select one or more dimension collection attribute labels to filter by.
  • You may also view by Trading Partner and each Trading Partner attribute if indirect rebates are configured for your channel
  • Program line results type · Choose to filter either ‘Actual’, ‘Accrual‘, or ‘Actual Forecast’ program line result types. ‘Actual’ will be set as default. This list is multi-select so you can compare the different types of earnings.
  • Include interim trading programs · A tick box selection to include interim trading programs in the report. Unselected as default.

Hide dimension items with no transaction · When unchecked, dimension items that are included in the program line with no transactions will be shown in the report results, allowing users to see which dimension items are inactive in their trading program.

Screenshot_2021-09-07_at_13.13.34.png
Screenshot_2021-09-07_at_13.14.56.png

The results of your report are then filtered down to the results that match all of your filters. Trading Programs will, however, prevent a report from being run if your criteria does not satisfy the requirement that the ‘View by’ selections must be across a maximum of 3 dimensions.

By clicking on the Preview button at the bottom of your page, you will be taken to a new page displaying the first 40 results of your report in a table.

Screenshot_2021-09-07_at_13.13.23.png

As you can see from the preview above, all the relevant information about your program line will be pulled through. The earnings will be broken down into columns depending on the program line results types chosen in the filters of the criteria page. You can also see there are two transacted values columns: Total transacted value and Effective transacted value. The difference being that total transacted value is the value of the transactions for this program line once deductions and discounts have taken place.

You will then have the option to revise your filters and re-generate the results by clicking on the Change criteria button, refresh the preview to re-generate the results by clicking on the button or download the full set of results by clicking on the Download button, as seen in the screenshot below.

Reports with a large amount of dimension items to be included will now be scheduled to run overnight.

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