Module 10: Settings, Admin, Staff & Labor
⛔ SUPERSEDED 2026-06-11 — Sprig-era feature spec (pre-pivot). The authoritative current design is the locked schema in docs/SCHEMA.md, the module's entry in docs/PROJECT_DECISIONS.md, and the responsibility/seam maps in docs/MODULE_INDEX.md + docs/CROSS_MODULE_CONTRACTS.md. This file is retained for historical feature context only; do NOT treat its scope/table/feature claims as current (it predates the nursery→generic pivot, the HR-out-of-scope cut, the identity/payments/integrations/files extractions, and the schema locks). Superseded note added 2026-06-11.
⚠️ Identity + Integrations Extraction (Architecture Redesign 2026-05-13): Two responsibilities are being extracted from Admin into dedicated Core & Platform Layer modules:
- Identity / Auth — users, roles, permissions, sessions, 2FA, SSO. Group 3 features 3.1–3.14 (auth-related) move to the Identity module. Group 3 features 3.15–3.19 (tenant HR: onboarding, training, certifications, documents, disciplinary) remain in Admin.
- Integrations — external connector implementations (QuickBooks, Stripe Connect/Terminal, Twilio, Resend, Mailchimp/SendGrid, Picas, webhooks). Group 10 connector code moves to the Integrations module. The tenant-level enable/disable + settings UI for those integrations remains in Admin.
See PROJECT_DECISIONS.md → "Architecture Redesign (Locked 2026-05-13)" §5 (new modules / layers) and the annotated Group 3 / Group 10 sections below.
⛔ SCOPE NOTE 2026-06-10 — Admin is TENANT CONFIGURATION only. Several groups in this spec do NOT map to Admin schema tables:
| Group(s) |
Reason excluded from Admin schema |
| Group 3 auth features (3.1–3.14) |
→ Identity module (already locked). Admin is UI only. |
| Group 3 tenant HR (3.15–3.19) |
⛔ HR is OUT OF SCOPE for Vrida entirely — not v1, not deferred. No staff certifications, disciplinary records, or onboarding workflow tables. |
| Groups 4, 5, 6 (Scheduling, Time Clock, Labor) |
⛔ HR is OUT OF SCOPE for Vrida entirely — shifts, time entries, wages, commissions, tips, payroll export. Businesses use Gusto/ADP/Homebase. |
| Group 7 (Subscription & Billing Settings) |
Platform UI pass-through — no Admin schema. Calls PlatformService. |
| Group 17 (Internal Comms) |
Out of v1 scope — bulletin board, knowledge base, staff calendar not core to merchant operations. |
Groups that DO inform the Admin schema (tenant config scope): 1, 2, 8, 9, 10, 11, 12, 13, 14, 15, 16, 18.
See PROJECT_DECISIONS.md → "Admin Module Scope (Decided 2026-06-10)". Spec content below is retained for reference — do not build HR, scheduling, time clock, labor, or internal comms tables.
Status: ✅ Locked for v1.0 (Identity + Integrations extractions pending; HR groups 3.15–3.19 + 4 + 5 + 6 out of scope per 2026-06-10 decision; spec retained as reference)
Schema: admin — tenant configuration only (business profile, branding, settings, tax config, hardware, integration config, approval workflows, data privacy/retention, audit-log config)
Feature count: 165 features in v1.0 → config-scope features: Groups 1+2+8+9+10+11+12+13+14+15+16+18 ≈ 99 features map to Admin schema. HR/scheduling/labor groups (4+5+6+3.15–3.19 ≈ 37 features) out of scope; Group 3 auth (14) → Identity; Group 7 (9) → Platform pass-through; Group 17 (3) → out of v1. Original 165-count preserved below for reference.
Build estimate: Strategic spec only — implementation effort TBD
Last updated: 2026-06-10 (HR out of scope; config-only boundary locked)
Overview
Settings, Admin, Staff & Labor is the comprehensive tenant administration module. It houses the Owner Dashboard — the configuration center referenced by every other module's "configurable defaults" — plus user management, staff scheduling, time clock, labor cost tracking, tenant profile, security, integrations, audit logs, white-label branding, and tenant onboarding.
This is one of the largest modules because it touches every configurable behavior across the entire platform. The Owner Dashboard is the single entry point where tenants configure every default, threshold, policy, and rule referenced elsewhere.
Admin depends on Billing (subscription tier), CRM (customer context for permissions), and consumes from every operational module for audit and reporting purposes.
Target Customer Profile
- Mid-size growth-stage retail nursery, $500K–$5M revenue
- 5–20 staff with multiple roles (owner, manager, cashier, buyer, marketing)
- Operating in 1–10 sites
- Requires custom approval workflows for large purchases or scheduling
- Insurance certificates, business licenses, and compliance docs to manage
- Seasonal staffing patterns (spring crunch, winter slowdown)
- Mix of W-2 employees and 1099 contractors
Architecture Principle: Configurability
Module 10 IS the configuration system. Every behavior in every other module that references "configurable per tenant via Owner Dashboard" is implemented here.
Tier Behavior
| Tier |
Admin capability |
| Starter |
Basic admin: 1 user, 1 site, simple roles, basic settings |
| Pro |
Full admin: multi-user, multi-site, custom roles, integrations, advanced settings, internal communication |
| Enterprise |
+ SSO + IP whitelisting + custom approval workflows + advanced security + white-label + API access + audit log granularity + custom permissions |
Feature Hierarchy (165 features across 18 groups)
Group 1: Owner Dashboard — Tenant Configuration Hub (8 features)
| # |
Feature |
Notes |
| 1.1 |
Owner Dashboard landing page |
Single configuration entry point for owner role |
| 1.2 |
Tenant-wide settings categories |
Organized: Business / Operations / Financial / Marketing / Tech / Compliance |
| 1.3 |
Global tenant settings |
Tenant name, business type, legal entity, federal tax ID |
| 1.4 |
Search settings |
Find any setting across the dashboard |
| 1.5 |
Recent settings changes |
What was changed, by whom, when |
| 1.6 |
Setting change history |
Full audit trail of all configuration changes |
| 1.7 |
Setting rollback |
Revert recent setting changes if needed |
| 1.8 |
Per-site setting overrides |
Tenant-wide settings can be overridden per site |
Group 2: Tenant Profile & Branding (13 features)
| # |
Feature |
Notes |
| 2.1 |
Business name and legal name |
Captured separately for legal docs |
| 2.2 |
Business type / classification |
LLC, corporation, sole proprietorship |
| 2.3 |
Federal tax ID (EIN) |
Stored encrypted |
| 2.4 |
Business address(es) |
Operating address(es) and registered address |
| 2.5 |
Business contact info |
Phone, email, website |
| 2.6 |
Business hours (tenant-wide default) |
Default operating hours; site-specific overrides supported |
| 2.7 |
Business logo / branding |
Logo upload for receipts, customer app, emails |
| 2.8 |
Brand colors / fonts |
Customizable for customer-facing branded experience |
| 2.9 |
Slogan / tagline |
For customer communications |
| 2.10 |
Social media handles |
Instagram, Facebook, etc. |
| 2.11 |
Tenant compliance document storage |
Business license, agreements, certifications — searchable |
| 2.12 |
Insurance certificate tracking |
Workers' comp, liability — expirations tracked |
| 2.13 |
DBAs (doing business as) |
Tenant operating under multiple names |
Group 3: User & Staff Account Management (19 features — being SPLIT in Foundation refactor)
Auth/HR boundary (Architecture Redesign 2026-05-13):
- Authentication is about who can log in and what they can do — that's the Identity module. Features 3.1–3.14 move to Identity (14 features). The "user record" in Admin becomes a thin tenant-context wrapper around the
identity.user record.
- Tenant HR is about employment record, training, compliance, documents — that's tenant-side personnel data. Features 3.15–3.19 remain in Admin (5 features).
The line between the two: if it's about logging in, permissioning, or access — Identity. If it's about employment, training records, certifications, documents, or disciplinary records — Admin (tenant HR).
→ Moving to Identity module (14 features)
| # |
Feature |
Notes |
| 3.1 |
Tenant user creation |
Add staff members to the system. → Identity |
| 3.2 |
User invitation flow |
Email invite with onboarding. → Identity |
| 3.3 |
User profile per staff |
Name, email, phone, photo, role, hire date. → Identity (the auth-relevant fields; HR fields like hire date may dual-home with Admin tenant HR record) |
| 3.4 |
Built-in roles |
Owner, Manager, Cashier, Buyer, Marketing, Bookkeeper. → Identity |
| 3.5 |
Custom roles (Enterprise) |
Define new roles with specific permissions. → Identity |
| 3.6 |
Role-based permissions matrix |
Granular: who can do what. → Identity |
| 3.7 |
Permission templates |
Pre-built permission sets for common roles. → Identity |
| 3.8 |
User-to-site assignment |
Which sites user can access. → Identity |
| 3.9 |
User permissions per site |
Different role at different sites. → Identity |
| 3.10 |
User deactivation |
Disable access without deleting user. → Identity |
| 3.11 |
User credentials & 2FA |
Password, security questions, optional 2FA. → Identity |
| 3.12 |
User session management |
View active sessions; force logout. → Identity |
| 3.13 |
User password policies |
Configurable: length, complexity, expiration. → Identity |
| 3.14 |
User access logs |
When user logged in, from where. → Identity |
→ Remaining in Admin as tenant HR (5 features)
| # |
Feature |
Notes |
| 3.15 |
Multi-step staff onboarding workflow |
Welcome new hire: docs, training, role setup checklist. Stays in Admin (tenant HR workflow). |
| 3.16 |
Staff training tracking |
Which training each staff completed; expiration dates. Stays in Admin (tenant HR). |
| 3.17 |
Staff certifications tracking |
Pesticide license, forklift cert, etc.; expiration alerts. Stays in Admin (tenant HR / compliance). |
| 3.18 |
Staff document storage |
I-9, W-9, contracts, NDAs, performance docs. Stays in Admin (tenant HR documents; uses Files shared service for storage). |
| 3.19 |
Staff disciplinary records |
Written warnings, terminations; tracked with manager visibility. Stays in Admin (tenant HR). |
Group 4: Staff Scheduling & Shifts (12 features)
| # |
Feature |
Notes |
| 4.1 |
Staff schedule per site |
Daily/weekly schedule for each site |
| 4.2 |
Shift creation |
Specify time, role, assigned staff |
| 4.3 |
Shift assignment / unassignment |
Drag-and-drop or list view |
| 4.4 |
Repeating shifts |
Schedule "every Tuesday 9am-5pm" |
| 4.5 |
Shift swaps |
Staff requests swap with another staff member |
| 4.6 |
Manager approval for swaps |
Manager reviews and approves |
| 4.7 |
Time-off requests |
Staff requests time off; manager approves |
| 4.8 |
Time-off balance tracking |
Vacation days, sick days available |
| 4.9 |
Schedule notifications |
Staff notified of new shifts |
| 4.10 |
Shift conflicts detection |
Same staff scheduled twice; flag |
| 4.11 |
Schedule conflicts with operating hours |
Schedule outside business hours; warn |
| 4.12 |
Cross-site shift visibility |
Manager sees all sites' schedules |
Group 5: Time Clock & Attendance (10 features)
| # |
Feature |
Notes |
| 5.1 |
Staff clock-in via phone |
Tap to start shift |
| 5.2 |
Staff clock-out via phone |
Tap to end shift |
| 5.3 |
Break tracking |
Mandatory or optional break recording |
| 5.4 |
Late / early clock-in handling |
Flagged for manager review |
| 5.5 |
Missed clock-in handling |
If staff forgot to clock in; manual correction by manager |
| 5.6 |
GPS / location verification (optional) |
Verify staff at site when clocking in |
| 5.7 |
Cross-site clock-in/out |
Staff at different sites |
| 5.8 |
Daily / weekly hours report |
Per-staff hours for payroll |
| 5.9 |
Overtime tracking |
Hours over 40/week flagged |
| 5.10 |
Manual time correction |
Manager edits time records with audit |
Group 6: Labor Cost & Payroll (10 features)
Boundary: Commissions, tips, and bonuses are tracked and exported. Calculation rules are tenant-configured but Vrida does not run payroll. Exports flow to external payroll providers (Gusto, ADP, etc.) per OUT_OF_SCOPE.md.
| # |
Feature |
Notes |
| 6.1 |
Staff wage rate per role |
Hourly, salary, or commission-based |
| 6.2 |
Staff wage rate per individual |
Override role-default per person |
| 6.3 |
Labor cost calculation |
Hours × wage rate |
| 6.4 |
Labor cost per site |
Tracked separately per site |
| 6.5 |
Labor cost per category |
Sales staff vs production vs admin |
| 6.6 |
Payroll-ready export |
CSV/Excel formatted for payroll providers |
| 6.7 |
Payroll period definition |
Weekly, biweekly, monthly |
| 6.8 |
Sales commission tracking |
Per-staff commissions earned |
| 6.9 |
Tip pool distribution |
If gratuity enabled, tip allocation rules |
| 6.10 |
Bonus / incentive tracking |
Performance bonuses captured |
Group 7: Subscription & Billing Settings (9 features)
| # |
Feature |
Notes |
| 7.1 |
Current subscription view |
Tier, status, next billing date |
| 7.2 |
Plan upgrade / downgrade |
Change subscription tier |
| 7.3 |
Billing payment method |
Manage credit card on file |
| 7.4 |
Billing history & invoices |
View past Vrida invoices |
| 7.5 |
Usage tracking |
Current SKU count, user count, site count — vs tier limits |
| 7.6 |
Tier limit warnings |
Alert when approaching limits |
| 7.7 |
Billing contact |
Who receives billing emails |
| 7.8 |
Tax-exempt status for billing |
If tenant is tax-exempt with Vrida |
| 7.9 |
Subscription cancellation & pause flow |
Tenant initiates cancellation; pause option for seasonal businesses; retention attempts |
Group 8: Tax & Regulatory Configuration (12 features)
| # |
Feature |
Notes |
| 8.1 |
Tax jurisdictions configuration |
Federal, state, county, city tax rules |
| 8.2 |
Sales tax rates per jurisdiction |
Specific rates with effective dates |
| 8.3 |
Tax-exempt customer rules |
When to apply tax exemption |
| 8.4 |
Multi-jurisdiction tax handling |
When sites span multiple jurisdictions |
| 8.5 |
Tax filing schedule |
Monthly, quarterly, annual obligations |
| 8.6 |
Tax filing reminders |
Auto-alerts before filing deadlines |
| 8.7 |
Tax holiday support |
Specific dates when certain items are tax-exempt |
| 8.8 |
Tax rate change scheduling |
Schedule future rate changes |
| 8.9 |
Tax reporting export |
Formatted for state tax filings |
| 8.10 |
Resale certificate tracking |
Tenant-level resale certificates (Vrida-Tenant relationship, not Tenant-Customer). Distinct from CRM Group 9 which stores customer-level certs. |
| 8.11 |
Federal tax ID security |
EIN stored encrypted; audit access |
| 8.12 |
1099 generation for vendors |
Year-end vendor tax forms |
Group 9: Hardware Configuration (10 features) — STAYS in Admin
Confirmed in Architecture Redesign (2026-05-13): Hardware configuration (register pairing, receipt printer setup, cash drawer connection, Stripe Terminal pairing at the hardware level, barcode scanner pairing, customer-facing display, hardware diagnostics) is tenant configuration of physical devices, not external-system integration. It stays in Admin. Note that Stripe Terminal device pairing is hardware configuration (Admin); the Stripe Terminal API client and payment processing is PaymentsService (Payments module).
| # |
Feature |
Notes |
| 9.1 |
Register hardware registration |
Each register identified per site |
| 9.2 |
Receipt printer setup |
Bluetooth printers paired |
| 9.3 |
Cash drawer connection |
Configured per register |
| 9.4 |
Stripe Terminal setup |
BBPOS WisePOS E pairing |
| 9.5 |
Barcode scanner pairing |
Optional Bluetooth scanners |
| 9.6 |
Customer-facing display |
Optional secondary screen |
| 9.7 |
Hardware diagnostics |
Test prints, swipes, drawer pulse |
| 9.8 |
Per-site hardware inventory |
What hardware exists at each site |
| 9.9 |
Hardware replacement scheduling |
When to upgrade/replace |
| 9.10 |
Hardware troubleshooting guides |
Built-in support documentation |
Group 10: Integration Configuration (10 features — being SPLIT in Foundation refactor)
Connector/Config boundary (Architecture Redesign 2026-05-13):
- Connector implementations — OAuth flows, API clients, sync jobs, webhook handlers, vendor SDKs — move to the Integrations module (Core & Platform Layer). One unified connector pattern; QuickBooks now, Shopify / Sage / Xero / workforce tools later. Stripe Connect and Terminal API clients move to the Payments module (
PaymentsService).
- Tenant-level configuration UI — the on/off toggle, API key entry, sync schedule, status display per tenant — remains in Admin. Admin renders the configuration UI for each integration; the integration code itself lives in Integrations (or Payments, for Stripe-family connectors).
The line: if it's a vendor SDK, OAuth flow, webhook handler, or integration runtime — it moves. If it's the per-tenant settings UI ("enable QuickBooks for this tenant; here's the sync schedule") — it stays in Admin.
| # |
Feature |
Notes |
| 10.1 |
QuickBooks integration |
OAuth flow, sync runtime, webhook handler → Integrations module. Per-tenant enable/configure UI stays in Admin. QB Desktop direct sync remains out-of-scope; Sage / Sage Intacct / Xero deferred to v1.5 — all delivered through Integrations module's connector pattern. |
| 10.2 |
QuickBooks sync schedule |
Schedule configuration UI stays in Admin; scheduler runtime → Integrations module. |
| 10.3 |
Stripe Connect |
Merchant account setup runtime → Payments module (PaymentsService). Per-site enable/configure UI stays in Admin. |
| 10.4 |
Stripe Terminal |
Terminal API client → Payments module (PaymentsService). Per-site device pairing UI stays in Admin (Group 9 covers hardware pairing). |
| 10.5 |
Twilio (SMS) integration |
API client → Integrations module. Per-tenant config UI (API keys, sender ID) stays in Admin. |
| 10.6 |
Resend (email) integration |
API client → Integrations module. Per-tenant config UI stays in Admin. |
| 10.7 |
Mailchimp / SendGrid integration |
API client → Integrations module. Per-tenant config UI stays in Admin. |
| 10.8 |
Picas CSV export configuration |
Export-format runtime → Integrations module. Per-tenant export settings UI stays in Admin. |
| 10.9 |
API webhook configuration |
Webhook delivery runtime → Integrations module. Per-tenant webhook URL / event subscription UI stays in Admin. |
| 10.10 |
Integration status dashboard |
Health-check runtime → Integrations module. Tenant-facing status display UI stays in Admin. |
Group 11: Notifications & Alerts (Tenant-Wide) (10 features)
| # |
Feature |
Notes |
| 11.1 |
Owner notification preferences |
What owner wants to be alerted about |
| 11.2 |
Manager notification preferences |
Per-manager alert subscriptions |
| 11.3 |
Operational alerts |
Low stock, A/R aging, security events |
| 11.4 |
Financial alerts |
Daily sales summary, weekly P&L |
| 11.5 |
Customer alerts |
New review, complaint, large purchase |
| 11.6 |
Vendor alerts |
PO confirmations, late deliveries |
| 11.7 |
System alerts |
Maintenance, downtime, version updates |
| 11.8 |
Compliance alerts |
Tax filing due, certification expiring |
| 11.9 |
Alert delivery channels |
Email, SMS, push, in-app |
| 11.10 |
Alert frequency / digest |
Real-time, hourly digest, daily summary |
Group 12: Security & Access Control (12 features)
| # |
Feature |
Notes |
| 12.1 |
Tenant-wide password policy |
Length, complexity, expiration rules |
| 12.2 |
Two-factor authentication (2FA) |
Optional or required per role |
| 12.3 |
Single Sign-On (SSO) |
Enterprise tier; SAML/OAuth |
| 12.4 |
Session timeout |
Configurable inactivity period |
| 12.5 |
IP whitelisting |
Restrict access from specific IPs (Enterprise) |
| 12.6 |
Login attempt monitoring |
Failed login alerts, lockouts |
| 12.7 |
Suspicious activity detection |
AI-powered fraud/security alerts |
| 12.8 |
Audit log access |
View all security events |
| 12.9 |
Force logout / kick session |
Admin action |
| 12.10 |
Security incident reporting |
Workflow for reporting compromises |
| 12.11 |
Custom approval workflows |
Define multi-step approvals (e.g., "Manager X approves POs over $5K") |
| 12.12 |
Approval routing rules |
Configure which manager approves what; flexible chains |
Group 13: Data Privacy & Retention (9 features)
| # |
Feature |
Notes |
| 13.1 |
Data retention policies |
How long to keep different data types |
| 13.2 |
Customer data export |
GDPR right to access |
| 13.3 |
Customer data deletion |
Right to be forgotten |
| 13.4 |
Internal data retention |
Audit logs, sales history retention |
| 13.5 |
Privacy policy display |
Tenant's privacy policy linked from app |
| 13.6 |
Terms of service display |
Tenant's TOS |
| 13.7 |
Data sharing preferences |
What customer data can be shared with partners |
| 13.8 |
Compliance documentation |
GDPR, CCPA, PCI compliance status |
| 13.9 |
Tenant data backup management |
Tenant-initiated backups; restore points; backup status visibility |
Group 14: API & Webhook Configuration (Enterprise Tier) (6 features)
| # |
Feature |
Notes |
| 14.1 |
API access enable/disable |
Master toggle |
| 14.2 |
API key management |
Generate, revoke, audit |
| 14.3 |
Webhook URL configuration |
External endpoints for events |
| 14.4 |
Webhook event subscriptions |
Which events to send |
| 14.5 |
API rate limits |
Per-tenant request limits |
| 14.6 |
API usage monitoring |
Calls per day, errors, performance |
Group 15: White-Label & Custom Branding (Enterprise) (6 features)
Scope clarification: White-label here means tenant branding inside the shared Customer App, not separate app binaries. Single app in App Store / Play Store; theming is per-connected-tenant. See PROJECT_DECISIONS White-Label Definition.
| # |
Feature |
Notes |
| 15.1 |
Custom domain |
Tenant.sprig.com → custom.tenant.com |
| 15.2 |
Custom email templates |
Tenant-specific email designs |
| 15.3 |
Custom SMS templates |
Tenant-specific message content |
| 15.4 |
Custom branding in customer app |
No Vrida branding for end consumers |
| 15.5 |
Custom branded help docs |
White-label support |
| 15.6 |
Custom branded marketing |
Email signatures, etc. |
Group 16: Audit Log Configuration (4 features)
| # |
Feature |
Notes |
| 16.1 |
Audit log granularity |
What's logged (everything vs. only sensitive) |
| 16.2 |
Audit log retention |
How long to keep (compliance requirements) |
| 16.3 |
Audit log access control |
Who can view audit logs |
| 16.4 |
Audit log export |
For compliance reporting |
Group 17: Internal Communication & Calendar (3 features)
| # |
Feature |
Notes |
| 17.1 |
Internal calendar / events |
Staff meetings, training sessions, holidays — tenant-wide |
| 17.2 |
Staff bulletin board / announcements |
Owner posts messages visible to all staff |
| 17.3 |
Knowledge base for staff |
"How do we handle damaged plants?" — searchable internal docs |
Group 18: Tenant Onboarding & Migration (2 features)
| # |
Feature |
Notes |
| 18.1 |
Tenant onboarding wizard |
First-time setup walkthrough; guided configuration |
| 18.2 |
Tenant usage reporting |
What features tenant uses; for internal tracking and tenant insight |
Configurable Defaults (Owner Dashboard)
Module 10 IS the configuration system. Defaults live within each setting's UI. Cross-module defaults (cart-lock timeouts, manager PIN thresholds, etc.) are inherited from the relevant operational module's spec.
AI Features in Settings, Admin, Staff & Labor
| Feature # |
AI capability |
| 4.10 |
AI shift conflict detection |
| 8.6 |
AI tax filing deadline tracking |
| 11.10 |
AI digest summarization |
| 12.7 |
AI suspicious activity / fraud detection |
| 12.11 |
AI suggested approval routing based on PO type / amount |
| 18.2 |
AI usage pattern analysis (suggest features tenant should explore) |
All AI features use AWS Bedrock with Claude Haiku 4.5.
Events Emitted
admin.user_created
admin.user_role_changed
admin.user_deactivated
admin.shift_created
admin.shift_swapped
admin.time_off_requested
admin.time_off_approved
admin.staff_clocked_in
admin.staff_clocked_out
admin.tenant_settings_changed
admin.tax_rate_changed
admin.api_key_generated
admin.api_key_revoked
admin.audit_log_exported
admin.security_event_detected
admin.password_policy_changed
admin.integration_connected
admin.integration_disconnected
admin.subscription_changed
admin.staff_onboarding_started
admin.staff_onboarding_completed
admin.staff_certification_expiring
admin.staff_document_uploaded
admin.disciplinary_record_added
admin.compliance_document_uploaded
admin.insurance_certificate_expiring
admin.approval_workflow_triggered
admin.approval_granted
admin.approval_denied
admin.tenant_backup_initiated
admin.tenant_data_restored
admin.bulletin_board_post
admin.knowledge_base_updated
Events Consumed
billing.subscription_changed (update tier limits and feature availability)
pos.suspicious_activity_detected (security audit)
crm.gdpr_data_export_requested (track GDPR requests)
inventory.stock_changed (operational alerts)
purchasing.po_sent (vendor alerts)
API Contract (AdminService — public methods)
High-level surface (detailed signatures during implementation):
- Tenant settings:
updateTenantProfile, setBranding, manageDocuments, uploadInsurance, manageDBAs
- User management:
createUser, inviteUser, setRole, setPermissions, assignToSite, manageDocuments, recordCertification, trackOnboardingProgress, recordDisciplinary
- Scheduling:
createShift, swapShift, requestTimeOff, approveTimeOff, detectConflicts
- Time tracking:
clockIn, clockOut, recordBreak, correctTime, getHoursReport
- Labor:
setWageRate, calculateLaborCost, exportPayroll, trackCommission
- Subscription:
getSubscription, upgradeTier, pauseSubscription, cancelSubscription
- Tax:
setTaxJurisdiction, setTaxRates, generateTaxReport, track1099
- Security:
setPasswordPolicy, enable2FA, configureSSO, setIPWhitelist, monitorLoginAttempts, defineApprovalWorkflow, routeApproval
- Data:
exportTenantData, deleteTenantData, manageBackups, restoreFromBackup
- API:
generateAPIKey, revokeAPIKey, configureWebhook, monitorAPIUsage
- White-label:
setCustomDomain, customizeEmailTemplates, customizeBranding
- Audit:
getAuditLog, setAuditRetention, exportAuditLog
- Internal comms:
postBulletinBoard, manageKnowledgeBase, createEvent
- Onboarding:
startOnboardingWizard, getUsageReport
Out of Scope
| Capability |
Why excluded |
| Full HR / payroll system |
Use Gusto, ADP, etc. for actual payroll |
| Performance review system |
Future v2.0+ |
| Benefits administration |
Use external HR tools |
| Time-and-motion studies |
Niche |
| Multi-tenant analytics |
Privacy concern |
| Custom permission scripting |
Out of scope; predefined permissions only |
| Multi-currency for billing |
Defer; US tenants only initially |
| Tenant-to-tenant communication |
Out of scope (privacy) |
| Reseller / referral partner management |
Future v2.0 |
| Tenant business succession planning |
Niche |
Gaps Identified from Market Research
Source: See docs/MARKET_RESEARCH_GAPS.md for the master gap registry.
Status: All gaps below are Open — pending decision. None have been accepted into scope yet.
| Gap # |
Gap |
What's missing in this module |
Research source |
Possible options |
| 1 |
Shopify/Woo/Wix ecommerce sync |
Admin Group 10 Integration Configuration has no Shopify/Woo/Wix entry |
Research §2.1 #6 |
Deferred (v1.5+) — Native connectors ship v1.5+. See ROADMAP v1.5. |
| 7 |
Unified AI copilot UX |
No unified "AI assistant" surface across modules |
Research §6.3.3 |
Deferred (v1.5) — Needs year of multi-tenant signal. See ROADMAP v1.5. |
| 11 |
QB Desktop / Sage / Sage Intacct / Xero |
Admin 10.1 covers QB Online only |
Research §5.1 |
Deferred (v1.5) for Sage/Sage Intacct/Xero; Rejected for QB Desktop (CSV export only, out-of-scope). |
| 14 |
AI staff training assistant |
No AI-assisted staff training yet |
Research §6.3.5 |
Deferred (v1.2) — Part of v1.2 AI expansion bundle. See ROADMAP v1.2. |
| 19 |
Rugged hardware support documentation |
Hardware recommendations belong in help docs |
Research §9.B |
Rejected — Documented in customer help docs, not module specs. |
| 20 |
Workforce mgmt integrations |
Built-in scheduling + payroll CSV export only |
Research §9 |
Deferred (v1.5) — Integrations ship with Enterprise launch. See ROADMAP v1.5. |
| 21 |
App ecosystem / marketplace |
Enterprise API in v1.5; no marketplace yet |
Research §5.1 |
Deferred (v2.0) — Marketplace ships v2.0. See ROADMAP v2.0. |
| 27 |
Named migration playbooks |
Admin Group 18 has onboarding wizard; no named QuickBooks POS / Square / Lightspeed migration playbooks as first-class flows |
Research §2.1 — QuickBooks POS sunset trigger |
(a) Coupled with inventory gap 27 / (b) Document as GTM-only |