Royalties in CoreBridge are used to calculate and track royalty-related revenue across one or more Locations. Royalty settings are managed through Royalty Groups, which define how royalties are calculated, including the calculation basis, reporting period, applicable Locations, and plans.
Note: Royalty calculations are processed nightly. Changes to royalty settings will be reflected after the next scheduled processing cycle.
Table of Contents
- Understanding Royalty Groups
- Creating a Royalty Group
- Setting Up Plans
- Previewing a Calculation
- Assigning Income Accounts
- Adding a New Leg
- Setting a Company Royalty Override
- Viewing Group History
- Working with Multiple Groups
- Cloning a Group
- Marking a Group Complete
Understanding Royalty Groups
Royalty Groups maintain a complete history of rule changes over time by using effective start and end dates, helping preserve the accuracy of historical records. Multiple Royalty Groups can be active simultaneously to support different royalty programs, such as franchise royalties and advertising funds. Royalty calculations are processed automatically each night.
To access Royalty Groups, navigate to Settings / Royalties.
Creating a Royalty Group
To create a new Royalty Group, navigate to Settings / Royalties.
1. Click Create New Group.
Note: Royalty Groups are not included by default and must be created before royalties can be calculated. The Royalty Groups page will remain empty until the first group is added. After creating an initial group, you can clone it to quickly create additional Royalty Groups with similar settings.
2. Enter a Group Name.
3. Choose the Royalty Period for example, Monthly, Quarterly, or Annually.
4. Select what the Royalty is Based On. Examples include Placed, Built, or Invoiced Orders.
5. Set a Start Date, if desired.
Note: You can set the start date in the past and Royalty will apply retroactively.
6. Click Next.
7. Enable Minimums and Maximums, if desired. Fill in the appropriate amounts, if applicable.
8. Click Next.
9. Optionally, select one or more Locations the group applies to.
Note: If no Locations are selected, the group applies to all Locations.
10. Click Save.
11. Add your Royalty Plans (see Setting Up Plans below).
12. Assign Income Accounts to plans (see Assigning Income Accounts below).
13. Click Save to keep your changes.
Note: This will save the group as a Draft. A group saved as a draft will not become active until you publish it, even if the start date has passed.
14. Click Publish to activate the group.
Note: After publishing, only group name, plan names, and sort order can be edited.
Note: Publishing is a two step process. Click Yes, Publish to proceed.
Setting Up Plans
Each Royalty Group contains one or more plans. All revenue within the group runs through one plan at a time. Common configurations include a standard plan and an exempt plan.
Note: Some systems may benefit from having a reduced plan as well.
1. Select the Royalty Plans tab.
2. Enter a Plan Name.
3. Select a Plan Type.
Note: A short description of how that plan calculates royalties appears below the selection.
4. Enter the revenue range and rate for each Tier, if applicable.
Note: Tiers are available on all Plan Types except Exempt, Fixed Rate, and Fixed Amount.
a. Split an existing tier, click the Split icon. You can override the auto-generated split point as needed.
b. Delete any unnecessary Tiers using the Delete icon.
5. Click Add Tier to add a tier at the end of the list.
You can add multiple plans to a group. One plan must be set as the default. You can also mark individual plans as exempt to exclude specific revenue from royalty calculations.
Note: All revenue within a group runs through exactly one plan at a time.
Previewing a Calculation
The Preview Calculation feature lets you test how a plan will calculate royalties before it goes live. It does not affect any actual royalty data.
1. Select the Royalty Plans tab.
2. On the plan, click the Preview Calculation icon.
3. Enter a total sales amount for the period.
4. Review the breakdown to confirm the calculation behaves as expected.
Assigning Income Accounts
The Income Accounts tab controls which plan each income account is assigned to. By default, all income accounts are assigned to the default plan.
1. Open the Income Accounts tab on the Royalty Group.
2. To reassign an account, select it and choose the appropriate plan (for example, Standard, Reduced, or Exempt).
Note: Accounts overridden from the default will appear blue.
Note: If you change the default plan later, all accounts set to Default will automatically follow the new default. Accounts hard-coded to a specific plan will remain on that plan regardless.
Adding a New Leg
When your royalty rules change, you can add a new leg to an existing group instead of creating a new group from scratch. This preserves your historical data while applying updated rules going forward.
1. Open the Royalty Group you want to update.
2. Click Create Leg.
3. Set the Start Date for the new leg.
4. Configure the Royalty Plans.
Note: For more information, please see Setting Up Plans above.
5. Set Income Account assignments for the new leg.
Note: For more information, please see Assigning Income Account above.
6. Click Save.
7. Click Publish when ready. The original leg will automatically receive an end date the day before the new leg begins.
Note: A new leg saved as a draft will not take effect until you publish it, even if the start date has passed. You can set up legs in advance and publish them once all changes have been approved.
Setting a Company Royalty Override
You can override the royalty plan for a specific Customer. This is useful when a customer qualifies for a different royalty rate than the default - for example, exempt or reduced.
Navigate to Sales / Companies and open the Company record.
1. Click More Actions menu.
2. Select Royalties.
3. Choose the override plan for this Company.
Note: Income accounts that have been explicitly assigned to a specific plan will continue to use that assignment. The Company override applies to accounts set to Default.
Viewing Group History
Each Royalty Group keeps a full audit trail of every change made to it. To view the history, open the group and select the History tab.
Working with Multiple Groups
You can have more than one active Royalty Group at a time. All revenue runs through each active group independently, so you can track different royalty types - such as a franchisor royalty and an advertising fund - as separate groups with their own plans and rates.
Cloning a Group
You can clone any Royalty Group - including completed groups - to use its settings as a starting point for a new group.
1. Select the Group you would like to Clone.
2. Click the More Actions.
3. Select Clone.
4. Update the necessary information.
5. Click Save to keep your changes.
Note: This will save the group as a Draft. A group saved as a draft will not become active until you publish it, even if the start date has passed.
6. Click Publish to activate the group.
Note: After publishing, only group name, plan names, and sort order can be edited.
Marking a Group Complete
When a Royalty Group is no longer needed, you can close it out by marking it Complete.
Note: Completed groups cannot be edited. Clone a completed group to reuse its settings in a new group.
1. Select the appropriate Group.
2. Click Complete.
Note: Currently, this is a one-step process and will immediately move this group to Completed.