Verso is an embedded payroll API platform designed for SaaS companies who need to provide payroll services to their clients. It enables you to integrate comprehensive payroll calculations directly into your applications, handling everything from employee management to detailed pay slip generation.
Understanding Partners and Tenants
If you're reading this documentation, you are a Partner — a SaaS company using Verso's API to deliver payroll services.
| Concept | Definition | Example |
|---|---|---|
| Partner | Your company (the SaaS provider using Verso) | Your GTA or payroll SaaS platform |
| Tenant | Your end clients (companies you provide payroll services to) | SMBs, startups, enterprises |
How it works:
- You receive a Partner ID and API Key when you onboard with Verso
- You create Tenants to represent each of your clients
- You access each tenant's payroll data using the route pattern:
/partners/{partnerId}/tenants/{tenantId}/... - This architecture ensures complete isolation between your clients' data
Key Capabilities
| Component | Description |
|---|---|
| Users | Create users who can manage payroll operations |
| Employees | Create and manage employee records with division assignments |
| Cases | Define payroll variables (salary, hours, allowances, deductions) |
| Payruns | Execute payroll calculations for one or multiple employees |
| Results | Retrieve detailed pay slip data with wage type breakdowns |
Real vs Forecast Mode
Verso API supports two execution modes:
| Mode | Description | Use Case |
|---|---|---|
| Real | Calculations become part of official records | Monthly payroll runs |
| Forecast | Simulations stored separately from official data | What-if scenarios, previews |
Learn more in Real vs Forecast Mode.
Getting Started
1. Get API Access
Contact your account manager to obtain your API credentials:
- API Key
- Division ID
- Payroll ID
2. Authenticate
All API requests require authentication. Include your API key in the request headers:
Authorization Header
See Authentication for details.
3. Run Your First Payroll
Follow the Quickstart Guide to run a complete payroll forecast in 5 minutes.
Resources
| Resource | Description |
|---|---|
| Quickstart | Complete 5-step workflow tutorial |
| Authentication | API key and security guide |
| Interactive API Reference | Try API calls in your browser |
| Postman Collection | Pre-configured workflow for testing |
Documentation
Guides
- Real vs Forecast Mode - Understanding execution modes
- OData Queries - Filtering, sorting, and pagination
- Error Handling - Understanding and resolving errors
Reference
- Case Fields - Complete list of payroll input fields
- Error Codes - API error code reference
API Endpoints Overview
All Verso API endpoints follow the partner route pattern:
| Method | Endpoint | Description |
|---|---|---|
| POST | /partners/{partnerId}/tenants/{tenantId}/users | Create a user |
| POST | /partners/{partnerId}/tenants/{tenantId}/employees | Create an employee |
| POST | /partners/{partnerId}/tenants/{tenantId}/payrolls/{id}/cases | Add payroll case values |
| POST | /partners/{partnerId}/tenants/{tenantId}/payruns/jobs | Start payrun calculation |
| GET | /partners/{partnerId}/tenants/{tenantId}/payrollresults/sets | Get detailed results |
For the complete API documentation, visit the API Reference.