Overview
The Residuals Details Tab provides granular, merchant-level transaction and calculation breakdowns within monthly processor residual reports. Because this tab contains sensitive revenue, fee, and split data, controlling who can view and export this information is critical for maintaining confidentiality across your organization.
IRIS CRM uses a two-tier access model to manage Details tab visibility:
- User Class Permission (Global Gate): Sets whether an entire user class (e.g., Sales Rep, Sales Manager, Support) is permitted to access the Details tab.
- Per-User Toggle (Granular Override): Allows administrators and managers to enable or disable access for specific individuals within an authorized user class.
This hierarchy prevents unauthorized users—such as newly provisioned sales agents—from seeing sensitive merchant calculations by default, eliminating the need to manually toggle off access one person at a time when creating new accounts.
Key Rule: The User Class permission acts as a master gate. If a user class has Residuals Details unchecked, no user within that class can access or export Details data, regardless of their individual toggle setting.
How the Details Tab Works
When navigating to Residuals → Residuals Reports and opening a processor batch, data is organized into tabs based on user entitlements:
| Tab Name | Content & Purpose | Access Requirements |
|---|---|---|
| Summary | High-level summary of merchant account counts, total volume, gross income, processor expenses, and net residuals. | Requires base Residuals access. |
| Details | Itemized merchant-by-merchant line items, processor columns, fee breakdowns, and export options. | Requires Residuals Details enabled on the User Class AND individual user toggle enabled. |
| Profitability | Detailed merchant margin and processor profitability metrics. | Governed separately by the Residuals Profitability permission. |
What Happens When Details Tab Access Is Disabled?
When a user does not have permission to view the Details tab:
- Tab Visibility: The Details tab is completely hidden from the Residuals report view; only the Summary tab (and Profitability, if assigned) will appear.
- Export Restriction: Options to download or export merchant-level detail spreadsheets are removed.
- Direct URL and API Protection: Direct report URLs and backend API/export endpoints reject unauthorized requests, preventing data exposure.
- Summary Tab Retained: Sales reps can still review their overall volume, account counts, and net commission payout on the Summary tab without seeing itemized calculations.
Managing Permissions
Controlling Details tab visibility is handled in two stages: at the User Class level and at the Individual User level.
Step 1: Configure User Class Permissions (Class Gate)
Administrators define whether a User Class has access to the Details tab:
- Navigate to Administration → Users & Roles → User Classes.
- Locate the User Class you wish to update and click Edit.
- Scroll to the Residuals permission group.
- Find the Residuals Details checkbox:
- Checked (Enabled): Users assigned to this class are eligible to access the Details tab (subject to individual user toggles).
- Unchecked (Disabled): Users assigned to this class are blocked from the Details tab across all reports.
- Click Save.
Default Class Behavior
When a new user class is added, the following default settings apply:
- Administrator: Enabled (Checked) by default on new classes.
- Basic & Advanced: Disabled (Unchecked) by default on new classes.
Step 2: Manage Individual User Access (Per-User Toggle)
When a User Class has Residuals Details enabled, administrators (and managers for their direct reports) can adjust access per individual:
- In the main navigation bar, go to Residuals → Residuals Management.
- Select the Users tab.
- Locate the user in the list and inspect the Details disabled and Export details columns:
- If the User Class has permission enabled: The columns display an active Enable / Disable toggle. Clicking the switches updates the user's access immediately.
- If the User Class has permission disabled: The switch is replaced with a static Disabled (user class) badge. The toggle cannot be enabled individually while the class gate is off.
Permission Precedence Matrix
Use this matrix to understand how the User Class permission and per-user settings interact:
| User Class Permission | Per-User Switch in Residuals Management | Details Tab Visible? | Details Export Available? |
|---|---|---|---|
| Enabled (Checked) | Enabled (On) | Yes | Yes |
| Enabled (Checked) | Disabled (Off) | No (Hidden) | No (Restricted) |
| Disabled (Unchecked) | Disabled (user class) | No (Hidden) | No (Restricted) |
Frequently Asked Questions
- Can an administrator override a disabled User Class setting for a single user? No. The User Class permission serves as a strict master gate. If the User Class is unchecked, the per-user toggle cannot be enabled. To grant access to that user, either enable the Residuals Details permission on their current User Class or move them to a class that has it enabled.
- Residuals Details permission is a new feature. Will it affect existing User Classes once deployed? Existing User Classes that already have the base Residuals permission will automatically have the new Residuals Details permission enabled during migration. This ensures that active users retain access to their existing reports without interruption.
- Can managers still manage the toggle for their team members? Yes. Managers who have access to Residuals Management → Users can continue to toggle the Details tab switch for their direct reports, provided the subordinate's User Class has the class-level permission enabled.