Manage crediting rules

New
  • Published on Jun 20, 2025
  • 1 minute(s) read
  • CC
  • a
 Prev Next

From the Crediting Rules screen, you can view the status of crediting rules, edit crediting rule details, manually run crediting rules, and update their status.

Crediting rules status

There are three statuses available for crediting rules:

  • Active: Crediting engine pulls data from external sources against the criteria configured in the crediting rule.

  • Inactive: Crediting rule is not ready to be run and is paused.

  • Archived: Crediting rule is no longer in use and will not be activated at any point, but may have commissions calculated against it which requires historical data to be maintained.

Manage crediting rules

  1. On the Crediting Rules screen, locate the crediting rule you want to update.

  2. Click the menu â‹® and select an option to make changes to the crediting rule, as needed:

  1. Select the available option:

    • Activate to activate a crediting rule that has been deactivated.

    • Deactivate to deactivate a crediting rule that is active.

  1. Select the available option:

    • Archive to archive a crediting rule.

    • Unarchive to unarchive a crediting rule that was archived.

    Note

    When you unarchive a crediting rule, it will retain the status it had prior to when it was archived. For example, if a crediting rule was active and then archived, if you unarchive that crediting rule it will be active.

  1. Click Rule Details.

  2. On the Edit Crediting Rule Details window, update the Name, Categories, or Description, as needed. Refer to Create a crediting rule for information on the available fields.

  3. Click Save Changes when finished.

  1. Click Rule Configuration.

    The crediting rule menu and Rule Configuration option highlighted.

  2. On the crediting rule configuration page, make changes to Commission Events and Credit & Payees sections, or view Transactions, as needed.

  3. Click Save & Exit when finished.

  1. Click Delete.

  2. In the confirmation window, type DELETE.

  3. Click Confirm.

    Warning

    Deleting a crediting rule cannot be undone. Crediting plans that have commissions calculated against them cannot be deleted. If you wish to retain the crediting rule, but do not want it available to run, select Deactivate or Archive.

Crediting rules are processed in batches at a set time. This option manually triggers the crediting rule to run if you need a crediting rule to run outside of the automated run cycle.

  1. Click Run rule.

  2. To view updates to the crediting rule transactions, click Rule Configuration > Transactions.