Related articles

DevelopersAPI guides

Generate a creditors report

The creditors report allows you to browse and filter a list of trading programs in order to provide a summary of the due and overdue rebate, grouped into aged time periods per customer and per trading program.

This functionality can be accessed by clicking on Finance at the top of your page and then on Creditors report from the drop-down menu.

On this page, a list will display a live view of any due or overdue rebate, where the age for each payment line is based on:

  • The end date of the payment line;
  • The rebate payment terms of the trading program;
  • The creditor balance of the payment line;
  • The report start date selected in the search criteria;
  • The current date.

In the panel on the right-hand side of the page, you will be able to filter the search results using the following criteria:

  • Customer · Choose one, or more, customers from the ‘My customers’ list (including customers for which you are the lead cash collector) or ‘All customers’ list (including all customers for which you have read access);
  • Trading program types · Choose from a list of configured trading program types;
  • Trading program start date, ‘From’ and ‘To’ · Enter a ‘From’ date to filter by trading program start date. Enter a ‘To’ date to filter by trading program end date;
  • Account contact · Choose the account contact for that customer;
  • Aged periods · Choose aged periods from a list;
  • Report start date · Enter a date to prevent any payment lines with an end date before the report start date from contributing any value towards the creditor record for a customer. Defaults to the first day of the current year;
  • Only show customers with unallocated remittances · A drop-down Yes / No selection to restrict search results to customers which have unallocated remittances. ‘No’ is the default.

When you have finished making your selection, click the Search button in the bottom right-hand corner of the panel.


Once a search has been completed, the the creditors report will be displayed, providing full visibility of any overdue rebate.

Please note — Your search criteria will be persisted for the duration of your session. Click the Reset button to clear the criteria.

The creditors report initially shows you a table of trading programs and their aged rebate payment with the ability to drill down to view the aged rebate by program line or payment line, while filtering by the aged period.

This ability to drill down to payment line level allows you to look up a specific payment frequency period for a program line and see how overdue the payment for that rebate is.

You will now have the option to either click on the Download button, which will generate a csv file of the on-screen search results, or select one of the trading program rows in the listing, which will display the program lines associated to the selected trading program (see screenshot below as an example).


When viewing the program lines for a trading program, you will have the following options:

  • Click the View trading program button, which navigates you to the selected trading program edit / view page.
  • Click the View trading program notes button, which will allow you to view the trading program notes for the selected trading program, or create trading program notes if you have edit access to the trading program.
  • Click on a program line in the listing, which will display the payment lines associated to the selected program line (as shown below).

Aged periods

The different aged periods are explained below:

  • Not yet due - Payment lines that have not ended;
  • <0 days - Payment lines were the end date has passed but due date has not yet been reached;
  • 0-30 days - Payment lines that are between 0 and 30 days due;
  • 31-60 days - Payment lines that are between 31 and 60 days due;
  • 61-90 days - Payment lines are between 61 and 90 days due;
  • 91+ days - Payment lines are more than 91 days due.

The total total column is the sum of all the above age categories.

Total due column is dependent on the configuration of the instance. It is either the sum of
<0 days
0-30 days
31-60 days
61-90 days
91+ days,

OR the sum of

0-30 days
31-60 days
61-90 days
91+ days.

Not useful
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.