Driver Settlement Additions & Deductions Guide

Modified on Fri, 13 Feb at 3:29 PM

Cash vs Percentage Rules & Accounting Profiles

This guide explains how additions and deductions are applied to driver settlements based on:

  • Deduction type (Cash vs Percentage)

  • Accounting profile

  • Driver configuration


Important Terminology

Throughout this article, the term “deductions” is used for simplicity and consistency.

However, the logic described applies to both deductions and additions.

What This Means

  • Any rule that applies to a deduction also applies to an addition

  • The system behaviour (percentage vs cash, accounting profile matching, reference profile logic) is identical for both

  • The only difference is financial direction:


Type
Effect on Settlement
Deduction
Decreases the settlement total
Addition
Increases the settlement total


All configuration rules, matching logic, grouping behaviour, and calculation formulas apply equally to both.


1. Overview

The system determines which deductions apply to a settlement based on:

  • The deduction type (Cash vs Percentage)

  • Whether the driver has a Cash Settlement Company configured

  • The accounting profile of the settlement


Key Principle

  • Percentage deductions are applied to all settlements

  • Cash deductions are applied only to settlements whose accounting profile matches a specific reference profile


The reference profile depends on the driver configuration:


Driver ConfigurationReference Profile for Cash Deductions
No Cash Settlement CompanyDefault company’s accounting profile
Cash Settlement Company configuredCash Settlement Company’s accounting profile
Cash Settlement Company = Default profileSame as no Cash Settlement Company

2. Deduction Types

2.1 Types and Application Scope

TypeDescriptionApplication Scope
PercentageCalculated as a percentage of the order's subtotalApplied to all settlements
CashFixed monetary amountApplied only to settlements matching the reference profile

2.2 Override Mechanism (overrideGlobalSettings)

The overrideGlobalSettings flag on driver-level deductions allows the deduction type to be overridden.

ScenarioBehavior
Cash → PercentageTreated as a percentage and applied to all settlements
Percentage → CashTreated as cash and applied only to reference profile settlements

3. Settlement Grouping Rules

3.1 How Orders Are Grouped into Settlements

ConditionResult
Accounts with the same accounting profileOrders are grouped into the same settlement
Accounts with different accounting profilesOrders placed in separate settlements
Company with no accounting profile (null)Orders placed in their own isolated settlement

3.2 Deduction Application by Accounting Profile

Settlement Accounting ProfileCash DeductionsPercentage Deductions
Matches reference profile✅ Applied✅ Applied
Different profile❌ Excluded✅ Applied
No profile (null)❌ Excluded✅ Applied

4. Scenario A: No Cash Settlement Company Configured

When a driver does not have a Cash Settlement Company configured:

  • Cash deductions apply to settlements whose accounting profile matches the default company profile

Behavior Summary

Settlement ProfilePercentage DeductionsCash Deductions
Default company profile✅ All applied✅ All applied
Different profile✅ All applied❌ Excluded
No profile (null)✅ All applied❌ Excluded

5. Scenario B: Cash Settlement Company Configured

When a driver has a Cash Settlement Company configured:

  • Cash deductions apply only to settlements matching the Cash Settlement Company’s accounting profile

Behavior Summary

Settlement ProfilePercentage DeductionsCash Deductions
Default company profile✅ All applied❌ Excluded
Cash Settlement Company profile✅ All applied✅ All applied
No profile (null)✅ All applied❌ Excluded

? Key Difference from Scenario A

  • Scenario A: Cash deductions apply to default company settlements

  • Scenario B: Cash deductions apply to Cash Settlement Company settlements


6. Scenario C: Cash Settlement Company with Same Profile as Default

If the Cash Settlement Company has the same accounting profile as the default company:

  • The behaviour is identical to Scenario A.

Why?

Since both companies share the same accounting profile:

  • The reference profile is the same

  • Cash deductions apply to the same settlements

  • No behavioural change occurs

Implication Summary

ScenarioReference ProfileCash Deductions Applied To
A: No Cash Settlement CompanyDefault profileDefault profile settlements
B: Cash Settlement Company (different)Cash Settlement Co. profileCash Settlement Co. settlements
C: Cash Settlement Company (same)Same as defaultDefault profile settlements

Conclusion: Setting a Cash Settlement Company with the same profile as the default company is a no-op for deduction purposes.


7. Calculation Formulas

7.1 Percentage Deductions

Deduction Value = Orders Subtotal × Percentage Rate

7.2 Cash Deductions

Deduction Value = Fixed Amount

(No calculation required.)


7.3 Settlement Total

Total = Orders Subtotal + Sum(Applicable Percentage Deductions) + Sum(Applicable Cash Deductions)

Where applicable, cash deductions depend on:

  • No Cash Settlement Company → Accounting profile must match the default company profile

  • Cash Settlement Company configured → Accounting profile must match Cash Settlement Company profile


8. Visual Summary

8.1 Scenario A – No Cash Settlement Company

Settlement A (Default Profile) % Deductions: ✅ $ Deductions: ✅ Settlement B (Different Profile) % Deductions: ✅ $ Deductions: ❌ Settlement C (No Profile) % Deductions: ✅ $ Deductions: ❌

8.2 Scenario B – Cash Settlement Company Configured

Settlement A (Default Profile) % Deductions: ✅ $ Deductions: ❌ Settlement B (Cash Settlement Profile) % Deductions: ✅ $ Deductions: ✅ Settlement C (No Profile) % Deductions: ✅ $ Deductions: ❌

9. Decision Flow Summary

  1. Is the deduction type a percentage?

    • ✅ Yes → Apply to all settlements

    • ❌ No → Continue

  2. Is the deduction type Cash?

    • Determine reference profile:

      • If Cash Settlement Company exists → Use its accounting profile

      • Otherwise → Use default company profile

  3. Does the settlement accounting profile match the reference profile?

    • ✅ Yes → Apply deduction

    • ❌ No → Exclude deduction


10. API Endpoints

EndpointDescription
GET /api/v1/settlements/{settlementNumber}Get settlement details, including deductions
GET /api/v1/drivers/deductions/{driverId}Get the driver’s configured deductions

Final Summary

  • Percentage deductions are always global.

  • Cash deductions are profile-restricted.

  • The reference profile depends on whether a Cash Settlement Company is configured.

  • Matching accounting profiles determines eligibility.

  • Identical profiles between default and cash settlement companies result in no behavioural change.

Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select at least one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article