Hosted payroll or Payroll Infrastructure?
The two ways to use Everee, which APIs each one uses, and what you see when you call one that doesn't match the company.
Everee works in two modes. A company is in exactly one of them, and it decides which APIs you use, who approves payroll, and who classifies overtime.
- Hosted payroll. The company runs payroll in the Everee admin portal. Your product integrates through the API: you send hours (shifts or timesheets) and payable items, and a payroll admin, or auto-approval, approves payroll.
- Payroll Infrastructure. Your platform runs payroll for its customers. There is no admin portal. You send each worker's pay as items on a payroll run and approve the run through the API.
Everee sets a company's mode. You can't change it with the API. Payroll Infrastructure is for platform partners with a partnership agreement in place: see Who Payroll Infrastructure is for.
What's different
| Hosted payroll | Payroll Infrastructure | |
|---|---|---|
| Who approves payroll | A payroll admin in the Everee admin portal, or auto-approval | Your platform, by approving a payroll run |
| How you send pay | Shifts and timesheets for hours, and payable items for flat amounts | Items on a payroll run. See Running payroll |
| Overtime and double time | Everee classifies shifts. See Overtime classification rules | You classify hours and send them under pay codes. See Pay codes and gross pay basics |
| Shifts, timesheets and payables APIs | Available | Not available. Creating them returns 400 |
| Payroll Run API | Not available for writes. See the error you'll see | Available |
| Workweek and workday start | Company settings that Everee configures for you on request | Not used, because you classify hours |
| Onboarding workers | Embedded onboarding, hosted onboarding, or a complete record | A complete record only |
| Admin portal and admin users | Yes | No |
| Messages to workers from Everee | Yes, such as invitations and payment notices | None. You tell your workers |
| Worker accounts and pay card | Yes | No |
| API keys | A company API key | A partner key, plus a company key for each company |
| Sandbox | Sandbox companies are hosted unless a partner test key created them | A partner test key creates Sandbox companies. See Sandbox & Production |
Guides that apply to one mode say so at the top. If a guide doesn't say, it applies to both.
The errors you'll see
| You called | On a company that is | You get |
|---|---|---|
| A payroll run write, such as adding items | Hosted | 400, "This company isn't set up for embedded payroll. Manage its payroll through the Everee portal instead." |
| Create a shift, timesheet or payable | Payroll Infrastructure | 400. Send the pay as items on a payroll run instead |
If you see the first error and you're building a Payroll Infrastructure integration, the company was probably created outside your partner relationship, so it is hosted. Sandbox companies created without a partner test key are hosted too. To build against the payroll run APIs you need a partner test key, and Payroll Infrastructure access follows the partnership agreement. See Who Payroll Infrastructure is for and, to evaluate in the meantime, Evaluate Payroll Infrastructure before you have access.
Updated about 14 hours ago