DriveFlow SuperAdmin Guide¶
Documentation version 1.0 - last updated 2026-11-18
Applies to: SuperAdmin (platform administrator). Last reviewed: 2026-11-18.
This is the complete manual for the person who administers the DriveFlow platform. It describes what the system actually does today, including what is missing. The same content is available as separate pages in the folder 15-superadmin-guide.
Table of contents¶
Contents
- The SuperAdmin role
- Signing in and the PLATFORM menu
- Schools (companies)
- Subscriptions
- Plans, add-ons and SMS bundles
- Users
- Roles and permissions
- Sales Management: overview
- Salespeople
- Customer referrals
- Commissions
- Gateway fee settings
- Monthly commission reports
- Commission payments
- Platform settings, jobs and development tools
- Reports available to the SuperAdmin
- What is not built
- Quick reference: messages
1. The SuperAdmin role¶
The SuperAdmin is the platform administrator: someone at the company that runs DriveFlow, not at a driving school.
| School user | SuperAdmin | |
|---|---|---|
| Belongs to a school | Yes, one | No. The account has no company and no branch. |
| Sees students, lessons, invoices | Their own school's | None |
| Permission checks on the server | By role | Always pass |
| Subscription limits | Apply | Do not apply |
| Menu | The school menu | One section: PLATFORM |
Two things to keep in mind
- Passing every permission check does not give access to school data. School data is filtered by the signed-in user's school, and the SuperAdmin has none.
- There is no "sign in as a school". The SuperAdmin cannot impersonate a user.
Where the account comes from¶
The first SuperAdmin account is created by DriveFlow when the platform is installed. How it is set up is covered in the internal technical documentation; contact DriveFlow support if you need it.
Important
- Change the SuperAdmin password immediately after the first sign-in, under Settings > Security > Change Password.
- A second SuperAdmin cannot be added through the application. The Create User dialog always creates a user inside a school, and the SuperAdmin role cannot be chosen. It must be done in the database.
2. Signing in and the PLATFORM menu¶
The SuperAdmin signs in on the normal sign-in page and lands on Users. The header reads DriveFlow Platform (all schools).
| Menu item | Page | Address | Purpose |
|---|---|---|---|
| Users | Users & Access | /settings/users |
See every user of every school |
| Roles | Roles & Permissions | /settings/roles |
Change built-in roles; see all custom roles |
| Subscriptions | Subscription | /settings/subscription |
Manage any school's subscription by hand |
| Sales Management > Dashboard | Sales Dashboard | /sales |
Referral and commission figures |
| Sales Management > Salespeople | Salespeople | /sales/salespeople |
Referral partners and their codes |
| Sales Management > Customer Referrals | Customer Referrals | /sales/referrals |
Schools each salesperson brought in |
| Sales Management > Sales Commissions | Sales Commissions | /sales/commissions |
Approve commissions, record refunds |
| Sales Management > Gateway Fee Settings | Gateway Fee Settings | /sales/gateway-fees |
Gateway fee rates |
| Sales Management > Monthly Reports | Monthly Reports | /sales/reports |
Monthly commission report and exports |
| Sales Management > Commission Payments | Commission Payments | /sales/payments |
Record payouts |
| My Profile | - | /profile |
The SuperAdmin's own details |
Screenshot to be added
Screen: SuperAdmin home. Should show: the PLATFORM menu with Sales Management expanded, and the header "DriveFlow Platform (all schools)".
The Settings page (/settings) is not in the menu but opens by address. For a SuperAdmin it shows four cards: Users & Access, Roles, Security and Subscription.
What only the SuperAdmin can do¶
| Function | Enforced by |
|---|---|
| Everything in Sales Management | The SuperAdmin role, checked on the server |
| Manage any school's subscription, manual payments, add-ons, SMS credits and referral code | The SuperAdmin role, checked on the server |
| Change the permissions of the built-in roles | The role service |
| Create a role shared by every school | The role service |
| See users, roles and instructor sign-in links of all schools | The server returns all schools for a SuperAdmin |
| Add default scheduling settings to branches that lack them (no screen; see the internal technical documentation) | The SuperAdmin role |
3. Schools (companies)¶
In the code a driving school is a "company" or "organisation".
There is no school administration screen
No list to browse, and no way to edit, deactivate or delete a school.
How a school is created¶
Schools register themselves on the public registration form. DriveFlow creates the company, its first user with the Owner role, and a 14-day Free Trial subscription. A notice goes to the platform's alert address, which is set in the server configuration. No approval is needed. The trial length (14 days) is fixed in the code. The country is chosen at registration and cannot be changed.
Registration is refused when the email address is already used by a user ("An account with this email address already exists.") or a school ("An organisation with this email address already exists.").
Finding a school¶
| Way | How |
|---|---|
| Subscriptions page | Type the name or email address in the School box. Each entry shows name, email and subscription status. Choosing one shows School name, Current plan, Subscription status, Billing period, Start date and End date. |
| Users page | Search for the school's name. The Company column is searched. |
| Customer Referrals | Lists referred schools with plan and status |
What can be done for a school¶
| Task | Where |
|---|---|
| Put it on a plan or change its plan after an EFT | Subscriptions |
| Give access now, record payment later | Subscriptions, payment status Pending |
| Activate, extend or switch off an add-on; add an SMS bundle | Subscriptions > Add-ons |
| Apply a salesperson code before its first payment | Subscriptions > Salesperson code |
| See its users, and unlinked instructor accounts | Users; Instructor sign-in check |
| See its custom roles; delete one with no users | Roles |
| Record a refund (referred schools) | Sales Commissions > Refunded |
Stopping a school's access¶
There is no "deactivate" or "end subscription" button. A school loses access when its period ends without renewal.
Workaround
To end access earlier, the only tool is to activate a new short period on the Subscriptions page whose end date is the day access should stop. The end must be in the future ("That start date and duration end in the past."). This is a workaround. Access cannot be cut on the same day without a change in the database.
4. Subscriptions¶
Menu: Subscriptions. The page is headed Subscription, "Activate or upgrade a school's DriveFlow subscription."
The page has four parts: Manage School Subscription (the School box), School Details (with Payments pending), Upgrade Subscription and Add-ons.
Screenshot to be added
Screen: Subscriptions page. Should show: a school chosen, showing School Details, Upgrade Subscription and Add-ons.
4.1 Activating or upgrading a plan¶
- Open Subscriptions and choose the school.
- If a salesperson referred the school and it has never paid, type the code in the Salesperson code row and click Apply.
- Fill in the Upgrade Subscription table.
- Check the blue summary line.
- Click Activate Subscription, then Activate in the confirmation.
| Setting | Required | Rules |
|---|---|---|
| Subscription plan | Yes | Any active plan. Starts on Professional. |
| Billing period | Yes | Annual (default) or Monthly |
| Start date | Yes | Starts as today |
| Duration | Yes | 1 to 60 months. Annual in multiples of 12. Starts at 12. |
| Agreed amount | Only for Enterprise Custom | 0 to 10 000 000. Empty means the list price. It is the total for the whole period. |
| Salesperson code | No | Only before the school's first payment |
| Payment status | Yes | Paid (default) or Pending |
| Payment reference | When Paid | Never used before on any subscription payment. When Pending and empty, one is generated (MANUAL-...). |
Amount: the agreed amount if entered; otherwise annual price x years (or monthly price x 12 x years when the plan has no annual price), or monthly price x months.
What happens:
| Record | Result |
|---|---|
| Subscription | The school's current subscription is changed in place. Status Active, new plan and dates, cancellation cleared, auto-renew off. |
| Payment | A payment with gateway Manual, in ZAR, Successful or Pending |
| Invoice | When Paid: a paid invoice numbered DF-{year}-000001 onwards, emailed to the school |
| Commission | When Paid, for a referred school inside its commission period |
| Access | Refreshed at once |
Activating replaces the current period
It does not add to it. To extend a paid-up school, set the start date to its current end date.
Example: Kagiso Driving Academy pays R 9 990 by EFT for a year of Professional. Choose the school, Professional, Annual, start today, duration 12, payment status Paid, reference "EFT 18Nov Kagiso". Activate. The school is on Professional for a year and receives its invoice by email.
4.2 Pending payments and "Mark as paid"¶
Choose Pending to give access before the money arrives. No invoice is created and no commission is earned yet. The payment is listed under Payments pending.
When the money arrives:
- Open Subscriptions and choose the school.
- Under Payments pending click Mark as paid.
- Confirm with Mark as paid.
The payment becomes Successful, the invoice is created and emailed, any setup fee in it counts as paid, and a referred school's commission is created with today as its payment date.
Warning
A pending payment cannot be cancelled or edited, and nothing reminds the school.
4.3 Add-ons¶
"On a paid plan an add-on's feature only works while the add-on is active. The plan must include the feature first."
Status texts: "Active until {date}", "Cancelled, ends {date}", "Not active", "Not in plan" (the button is disabled), and for SMS "{N} credits left" or "No credits".
To activate or extend a monthly add-on
- Click Activate or Extend on its row.
- Set Start date (when extending it starts at the paid-up date), Duration (1 to 60 months), Setup fee (ticked when not yet paid), Payment status and Payment reference.
- For Leads and WhatsApp, tick Together to activate both at 30% off everything.
- Click Activate Add-on or Extend Add-on and confirm.
The school gets the add-on until the end date at once, Paid or Pending. The end date replaces the current paid-up date.
To deactivate a monthly add-on: click Deactivate and confirm. It stops immediately. "Nothing is refunded or invoiced."
To add an SMS bundle:
- Click Add bundle on the SMS row.
- Choose the bundle.
- Set the setup fee, payment status and reference.
- Click Add Bundle and confirm.
The credits are added at once, Paid or Pending.
4.4 Not automatic¶
Warning
No renewal of manually activated subscriptions, no reminders for pending payments, no pro-rata credit, no refunds.
5. Plans, add-ons and SMS bundles¶
Plans, features, add-ons and bundles cannot be edited in the application
They are seed data in the source code, applied by database migrations. Changing a price or limit needs a developer and a new deployment. The SuperAdmin's own tools are the Agreed amount and the setup fee tick box on the Subscriptions page.
Plans¶
Prices in rand, VAT included.
| Code | Name | Monthly | Annual | Students | Instructors | Vehicles | Branches |
|---|---|---|---|---|---|---|---|
| FREE | Free Trial (14 days) | 0 | - | 10 | 2 | 2 | 1 |
| START | Starter | 499 | 4 990 | 100 | 5 | 5 | 1 |
| PRO | Professional | 999 | 9 990 | 1 000 | 25 | 15 | 5 |
| ENT | Enterprise | 2 499 | 24 990 | Unlimited | Unlimited | 30 | Unlimited |
| ENTPLUS | Enterprise Plus | 3 999 | 39 990 | Unlimited | Unlimited | 70 | Unlimited |
| ENTCUSTOM | Enterprise Custom | By quote, from R5 000 a month | By quote | Unlimited | Unlimited | Unlimited | Unlimited |
| Feature | Free Trial | Starter | Professional | Enterprise plans |
|---|---|---|---|---|
| Bookings, Calendar, Payments, Reports, Email | Yes | Yes | Yes | Yes |
| Quotes, Student portal | Yes | - | Yes | Yes |
| Leads, Online booking | Yes | - | With add-on | With add-on |
| - | - | With add-on | With add-on | |
| SMS | - | - | With bundles | With bundles |
| Mobile app | - | - | Yes | Yes |
| Fleet Management, Instructor earnings | Yes | - | - | Yes |
| API, White label, Accounting | - | - | - | Listed; nothing in the application checks them |
Enterprise Custom cannot be bought online. It is activated on the Subscriptions page with an agreed amount.
Add-ons¶
| Add-on | Setup fee | Price |
|---|---|---|
| Leads | R 1 499 | R 1 499 per month |
| R 1 499 | R 1 499 per month | |
| Online Booking | None | R 499 per month |
| SMS | R 299 | Bundles: 100 SMS R 55, 300 SMS R 150, 500 SMS R 225 |
- Add-ons are paid month by month, with no automatic renewal. When the paid-up date passes, the add-on switches off and the data is kept.
- Leads and WhatsApp: while a school has one active, the other's monthly price is 30% lower. Bought together in one payment, both months and any setup fees are 30% lower.
- One SMS credit per message part (160 characters, or 153 per part for longer messages). Credits do not expire.
VAT on DriveFlow's invoices¶
Controlled by BillingIssuer:VatRegistered in the server configuration (off by default; rate 15%). When on, new subscription invoices show the VAT included and are titled "Tax Invoice". Issued invoices are not changed.
6. Users¶
Menu: Users. The page is headed Users & Access.
The SuperAdmin sees every account of every school, with an extra Company column. An account without a school shows "Platform (no company)". Search covers name, email, branch and company. Filters: role and status.
Creating, editing, disabling, enabling and deleting users does not work for the SuperAdmin
The buttons are shown because the SuperAdmin holds every permission, but the server refuses each of these actions for an account with no school, and the page shows a general error such as "Unable to create user." Changes to a school's users must be made by that school.
Instructor sign-in check¶
Users > Instructor sign-in check. A read-only list of instructor accounts across all schools, with a School column, and whether each is linked to its instructor profile: Linked, Links on next sign-in, No instructor profile with this email, or Several profiles share this email. An unlinked instructor sees no lessons. The school fixes it by giving the instructor profile the same email address as the sign-in account.
7. Roles and permissions¶
Menu: Roles. The page is headed Roles & Permissions.
| Kind | Roles | Who can change permissions | Deletable |
|---|---|---|---|
| Locked | SuperAdmin, Owner, Student | Nobody | No |
| Built-in | Administrator, Manager, Instructor, Receptionist, Finance, Viewer | SuperAdmin only | No |
| Shared, created by the SuperAdmin | Any name | SuperAdmin only | Yes, when unused |
| Custom, created by a school | Any name | That school, and the SuperAdmin | Yes, when unused |
The SuperAdmin sees all of them. A custom role's card carries its school's name.
Changing a built-in role¶
- Open Roles.
- On the role's card choose Manage Permissions from the three-dot menu.
- Tick or untick permissions. Use the per-category box or Select all permissions.
- Click Save Changes.
Consequences
- The change applies to every school.
- Every user holding the role, in every school, is signed out and signs in again with the new permissions.
- The change survives restarts. Start-up only gives defaults to roles and permissions that are new.
- At least one permission must stay ticked ("Select at least one permission.").
Creating a shared role¶
- Roles > Create Role.
- Enter a Role Name.
- Tick permissions.
- Click Create Role.
The role has no school: every school sees it read-only and can assign it. The name must not be one of the nine built-in names and must not be used by any role of any school ("A role with this name already exists.").
Deleting a role¶
Three-dot menu > Delete.
Warning
There is no confirmation.
Refused when users hold it ("This role is assigned to users and cannot be deleted.") or when it is built-in ("Built-in roles cannot be deleted.").
8. Sales Management: overview¶
Sales Management tracks referral partners, the schools they brought in, the commission earned on those schools' subscription payments, and payouts. Only the SuperAdmin role can open it. Anyone else sees "You don't have access to this page / Sales Management is for DriveFlow administrators only."
Register a salesperson -> referral code, e.g. DF-THILY-001
|
A school enters the code before its first payment
|
First payment received -> referral locked, terms fixed, period starts
|
Each plan or add-on-month payment in the period -> commission (Pending)
|
Approve (Sales Commissions) -> Approved
|
Pay at the bank, then record (Commission Payments) -> Paid
Rules everywhere: amounts are shown as R 1,234.56; dates as dd MMM yyyy; money is counted by the day the school's payment was received; days and months are in UTC; a commission's figures are a snapshot and are never recalculated.
| Total | Meaning |
|---|---|
| Generated | Not Reversed, clawbacks left out |
| Paid | Settled by a payout (a settled clawback counts negative) |
| Outstanding | Pending or Approved (an unsettled clawback counts negative) |
The Sales Dashboard¶
Set From and To and click Apply. The default is the last 12 months. The range may cover at most 36 months.
| Card | Counts |
|---|---|
| Registered Salespeople, Active Salespeople | All salespeople; those with status Active. Not limited to the range. |
| Referred Driving Schools | Codes applied in the range |
| Active Referred Customers | Of those, schools whose subscription is Active (trials not counted) |
| Revenue from Referrals, Gateway Fees, Commissions Generated | Generated commissions with a payment date in the range |
| Commissions Paid, Outstanding Commissions | By the school's payment date, not the payout date |
Charts: Referred customers per month, Subscription revenue from referrals, Commissions generated per month, Commissions paid versus outstanding. Below them, Top-performing salespeople (top five by commission).
9. Salespeople¶
Menu: Sales Management > Salespeople.
Note
A salesperson is a record, not a user. They cannot sign in.
Registering a salesperson¶
- Click Add Salesperson.
- Fill in the fields. On leaving Full name, a referral code is suggested.
- Click Save.
| Field | Required | Limits |
|---|---|---|
| Full name | Yes | 150 characters |
| Company (optional) | No | 200 |
| Yes | 256, must contain @ |
|
| Phone | No | 30 |
| Referral code | No (generated when empty) | 3 to 40 letters, numbers and dashes; starts with a letter or number; stored in upper case |
| Status | Yes | Active (default), Inactive, Suspended |
| Commission | Yes | 0 to 100%. Default 20. |
| Commission period | Yes | 1 to 12 months. Default 12. |
| Bank, Account holder, Account number, Branch code | No | 100, 150, 30, 20 |
- Suggested code:
DF-NAME-001, where NAME is the first word of the name (letters and digits, at most 10, upper case;REFif none) and the number is one more than the count of all salespeople ever created. - Uniqueness: a code is never reused, even after deletion, and is compared without regard to case ("The referral code 'X' is already used by another salesperson.").
- Bank details: the account number is stored encrypted and shown only on the detail page and in the edit dialog. If the encryption key is lost it shows as
-and must be entered again.
Editing and statuses¶
Important
A new percentage or period applies only to schools that have not paid yet. Schools that already pay keep their terms.
| Status | New schools can use the code | Existing referrals keep earning |
|---|---|---|
| Active | Yes | Yes |
| Inactive | No | Yes |
| Suspended | No | Yes |
Inactive and Suspended behave the same. Change the status from the three-dot menu (Activate, Deactivate, Suspend) and confirm.
The detail page¶
Click a row. Cards: Referred Customers, Active Customers, Cancelled Customers, Expired Agreements, Commission Generated, Commission Paid, Outstanding. Panels: Personal information, Commission configuration, Bank details. Table Referred customers, one row per school with its agreed terms, expiry and agreement state.
Note
A salesperson cannot be deleted.
10. Customer referrals¶
Menu: Sales Management > Customer Referrals (read-only).
| Rule | Detail |
|---|---|
| Optional | A school may subscribe without a code |
| One salesperson per school | Enforced by the database |
| Only before the first payment | A code can be applied, changed or removed only while the school has never paid for a plan or a monthly add-on. An SMS bundle or a pending payment does not count. A refunded payment does. |
| Locked afterwards | Not even the SuperAdmin can change it |
| Active salespeople only | Otherwise "The salesperson code is invalid or inactive." |
| No self-referral | Refused when the salesperson's email equals the school's email, or the email of the school user applying it |
Applying a code
- The school: Settings > Subscription, upgrade dialog, field Salesperson / Referral Code, Apply (needs Subscription.Manage).
- The SuperAdmin: Subscriptions > choose the school > Salesperson code > Apply.
A typed but unapplied code is applied automatically when the payment is started or the subscription activated. A refused code stops the action.
At the first payment the referral locks; the salesperson's percentage and period at that moment become the agreed terms; the commission period starts and its expiry is the start plus the agreed months.
Agreement values: Awaiting first payment, Earning, Expired.
The list shows Driving School, Salesperson (with code), Subscription Plan (with status), First Payment, Commission (for example 20% · 12 months), Commission Expiry, Agreement and Total Commission. Click a row to see the school's agreement and every payment that earned commission.
11. Commissions¶
Menu: Sales Management > Sales Commissions.
When a commission is created¶
Automatically, when a paid invoice is raised for a referred school's payment: on gateway confirmation, on a manual activation with status Paid, or on Mark as paid. One commission per payment, however often the gateway confirms it. It starts as Pending.
| Payment | Earns commission |
|---|---|
| A plan | Yes |
| A month of a monthly add-on | Yes |
| An add-on setup fee | No. Only the month in the same payment counts. |
| An SMS bundle | No |
| A manual EFT recorded by the SuperAdmin | Yes, with no gateway fee |
| A failed, cancelled or pending payment | No |
| A payment on or after the commission expiry | No |
The formula¶
Eligible amount = commissionable part of the payment, without VAT
Gateway fee = the fee the gateway reported (Actual)
or: charged amount x fee % / 100 + fixed fee (Estimated)
or: 0 for a manual payment
Net eligible revenue = eligible amount - gateway fee
Commission = net eligible revenue x agreed commission % / 100
Every figure is rounded to cents, half cents away from zero. The fee can never exceed the payment. The actual fee, when reported, is used on its own.
| Payment | Fee 3% | Net | Commission 20% | DriveFlow keeps |
|---|---|---|---|---|
| R 499.00 | R 14.97 | R 484.03 | R 96.81 | R 387.22 |
| R 999.00 | R 29.97 | R 969.03 | R 193.81 | R 775.22 |
| R 2,499.00 | R 74.97 | R 2,424.03 | R 484.81 | R 1,939.22 |
More examples:
- Actual fee R 17.21 on R 499.00: net R 481.79, commission R 96.36.
- No fee reported, rate 5% + R 2.00, payment R 1,000.00: fee R 52.00, net R 948.00, commission R 189.60.
- Manual EFT of R 500.00 at 20%: commission R 100.00.
- VAT registered, R 1,150.00 paid including VAT, rate 3%: eligible R 1,000.00, fee on the full R 1,150.00 = R 34.50, net R 965.50, commission R 193.10.
- Leads month R 1,499.00 with setup fee R 1,499.00, gateway kept R 89.94: eligible R 1,499.00, half the fee R 44.97, net R 1,454.03, commission R 290.81.
The commission period¶
Starts at the school's first commission-earning payment and lasts the agreed months (1 to 12). A payment earns commission from the start up to, but not including, the expiry moment. A school paying annually with a 12-month period normally earns commission on its first annual payment only.
Statuses¶
| Status | Meaning |
|---|---|
| Pending | Waiting for approval |
| Approved | Waiting to be paid |
| Paid | Settled by a payout |
| Reversed | The school's payment was refunded or charged back |
Warning
No status can be undone.
Approving¶
Click Approve on a row, or Approve pending on this page (N) to approve all Pending rows on the page shown.
Note
Only the current page is approved.
The list filters: search, salesperson, status, and Paid from / Paid to, which filter by the date of the school's payment.
Refunds and clawbacks¶
After refunding a school outside DriveFlow, or after a chargeback:
- Find the commission and click Refunded.
- Enter the Reason (required).
- Click Mark as refunded.
The commission becomes Reversed, and the school's payment and invoice are marked Refunded. If the commission was already paid out, a clawback line is added: the same amount, negative, status Approved. It is deducted in the next payout.
Warning
The school's subscription is not changed. A refund is always for the whole payment.
12. Gateway fee settings¶
Menu: Sales Management > Gateway Fee Settings.
A rate is used only to estimate the fee when the gateway reports none. A new installation has one rate: PayFast 3.00%, R 0.00 fixed, ZAR, from 1 January 2026, open-ended.
| Field | Rules |
|---|---|
| Payment gateway | PayFast, Paystack, Flutterwave or Stripe |
| Currency | Three letters |
| Fee percentage | 0 to 100 |
| Fixed fee per transaction | 0 or more |
| Effective from | Required |
| Effective to (optional) | Not before the start |
| Active | Off: the rate is ignored |
Status chips: In use, Upcoming, Ended, Inactive.
To change a rate, add a new one
Add it for the same gateway and currency from the date it changes and leave the end date empty. The earlier open-ended rate is ended automatically the day before. Two active rates for the same gateway and currency may not overlap: "{Gateway} already has an active {currency} rate from {date} ... End that rate first, or choose dates that don't overlap it."
History is never recalculated
Existing commissions keep the fee they were calculated with. Rates cannot be deleted.
13. Monthly commission reports¶
Menu: Sales Management > Monthly Reports.
A commission belongs to the month, in UTC, in which the school's payment was received.
Filters: Month, Year (current and five before), Salesperson, Payment gateway, Subscription plan (including "Add-on"), Commission status. Click Generate report after changing a filter.
Summary cards: Subscription Revenue, Gateway Fees, Net Eligible Revenue, Commission Generated, Commission Paid, Outstanding Commission, Salespeople, Referred Customers.
Earnings per salesperson: Salesperson, Referral Code, Customers, Revenue, Commission, Paid, Outstanding.
Commission transactions: Salesperson, Referral Code, Driving School, Plan, Gateway, Payment Date, Amount, Fee %, Gateway Fee (Actual or Estimated), Net Revenue, Commission %, Commission, Status.
Exports: Export to Excel, Export to PDF, Print (opens the PDF). The file is titled "Sales commission report {Month Year}" and contains the transaction rows. The export uses the filters as they are on screen at the moment of clicking, so generate first. There is no CSV export button.
14. Commission payments¶
Menu: Sales Management > Commission Payments. "DriveFlow never moves money itself."
- Approve the commissions.
- Pay the salesperson at your bank.
- Under Record a payment choose the Salesperson. Only those with something outstanding are offered.
- All approved commissions are ticked. Untick any you are not paying.
- Check Total payout.
- Enter the Payment reference (required, at most 100 characters), the Payment date (today or earlier), and optionally Commission period and Notes.
- Click Record payment, then Yes, I paid it.
The commissions become Paid and the payout appears under Payment history.
Warning
"This cannot be undone here."
Protection against paying twice:
| Protection | Detail |
|---|---|
| Once per commission | Only Approved, unsettled commissions can be selected. If one was paid meanwhile, the whole payout is cancelled. |
| Once per bank payment | A reference can be used once per salesperson |
| Own commissions only | A payout cannot include another salesperson's commissions |
| More than zero | "The selection adds up to nothing to pay. Select enough commissions to cover the clawbacks." |
Clawbacks
Clawbacks appear as negative lines and are ticked by default. Leave them ticked: the total is then what you actually pay. A clawback alone cannot be recorded.
Example: a paid commission of R 96.81 is reversed. The next commission is R 193.81. The next payout, with both lines ticked, is R 97.00.
Warning
A payout cannot be edited or deleted. There is no remittance document. Use the monthly report export as a statement.
15. Platform settings, jobs and development tools¶
What the SuperAdmin can set in the application¶
Built-in role permissions, shared roles, gateway fee rates, salespeople's terms, each school's subscription, and the SuperAdmin's own password. Nothing else.
Server configuration (restart needed, no screen)¶
Platform-wide settings live in the server configuration: the database, sign-in sessions (a normal session lasts 480 minutes, "remember me" 30 days), the platform email server used for platform email and for schools without their own, where platform alerts go and the web app address used in email links, the business shown on DriveFlow's invoices and its VAT registration and rate, DriveFlow's own PayFast account, the platform's SMS, WhatsApp and Meta app accounts, and push notifications. Changing them needs a restart and there is no screen for them.
The details, including where secret values are kept, are covered in the internal technical documentation. A summary of every setting, including the server configuration, is in the settings reference.
Background jobs¶
| Job | Schedule |
|---|---|
| lesson-reminders, driving-test-reminders, meta-lead-requeue | Every 15 minutes |
| subscription-expiry | Hourly |
| document-expiry-reminders | Daily 07:00 |
| invoice-reminders | Daily 08:00 |
| report-generation | Daily 23:00 |
Schedules are fixed in the code. Monitoring the background jobs is covered in the internal technical documentation.
Development tools¶
Development and test-data tools exist for developers only and are not available in production. This is covered in the internal technical documentation.
Audit logging¶
Warning
There is none. There is no audit table or page. The permission AuditLogs.View exists and unlocks nothing.
What is kept: the creator and last modifier of each record with dates (not shown on any page, latest change only), the approval, payment and reversal dates and the reversal reason of a commission, and entries in the server log.
16. Reports available to the SuperAdmin¶
| Report | Where |
|---|---|
| Sales Dashboard | Sales Management > Dashboard |
| Monthly commission report, with Excel and PDF export | Sales Management > Monthly Reports |
| One salesperson's referrals and totals | Salespeople > click a row |
| One referred school's payments and commissions | Customer Referrals > click a row |
| Payouts recorded | Commission Payments > Payment history |
| All users with their school | Users |
| Unlinked instructor accounts across schools | Users > Instructor sign-in check |
Note
All money figures cover referred schools only.
There is no report of all schools, total subscription revenue, registrations, expiring subscriptions, pending payments across schools, add-on sales or usage.
17. What is not built¶
| Area | Missing |
|---|---|
| Schools | A school list; activating or deactivating a school; editing a school; deleting a school; impersonation; viewing a school's data |
| Subscriptions | Ending, suspending or cancelling a subscription; extending a trial; cancelling a pending payment; undoing an activation; credit notes |
| Plans | Any screen for plans, prices, limits, features, add-ons or bundles; promotion codes |
| Users | Creating or changing any user as SuperAdmin; adding a second SuperAdmin; renaming a role |
| Sales | Deleting a salesperson; salesperson sign-in; partial refunds; editing or undoing a payout, an approval or a reversal; remittance documents; notifications to salespeople; more than 12 months of commission |
| Platform | A platform settings page; platform email settings in the application; an audit log; platform-wide reports; maintenance mode |
| Security | Two-factor sign-in |
18. Quick reference: messages¶
| Message | Where | Meaning |
|---|---|---|
| The salesperson code is invalid or inactive. | Referral code | Unknown code, or the salesperson is not Active |
| This school's referral code can no longer be changed: it has already paid. | Subscriptions | The referral is locked |
| A referral code can only be applied before the school's first subscription payment. | Subscriptions | The school has paid and has no referral |
| That payment reference has already been used. | Subscriptions | The reference exists on another payment |
| An annual subscription runs in whole years (12, 24, 36... months). | Subscriptions | Annual with a duration not divisible by 12 |
| {Plan} is priced by quote. Enter the agreed amount for the period. | Subscriptions | Enterprise Custom without an amount |
| {Add-on} isn't included in the {plan} plan. Upgrade the plan first. | Add-ons | The plan lacks the feature |
| The referral code 'X' is already used by another salesperson. | Salespeople | Duplicate code |
| The commission period must be between 1 and 12 months. | Salespeople | Period out of range |
| {Gateway} already has an active {currency} rate from ... | Gateway fees | Overlapping rates |
| Say why the payment was refunded. | Sales Commissions | The reason is empty |
| A payment with this reference is already recorded for this salesperson. | Commission Payments | Duplicate payout reference |
| Some of the selected commissions can no longer be paid. Refresh the list and try again. | Commission Payments | A commission is no longer Approved and unpaid |
| This role is assigned to users and cannot be deleted. | Roles | The role is in use |
| You don't have access to this page | Any Sales page | The user is not a SuperAdmin |