Everee Payroll Infrastructure
Offer full-stack embedded payroll in your platform, with Everee handling the compliance and payroll support.
Everee Payroll Infrastructure lets you offer full-stack embedded payroll inside your own product. Your platform onboards each customer as a company, loads its workers and settings, and sends the hours and pay items every cycle. Everee calculates pay and taxes, pays workers, and reports the results back to you. Your customers never leave your product, except for the embedded screens for contract signing and the funding bank account.
Payroll Infrastructure is managed. Everee is certified to process payroll in all 50 states, and handles most of the compliance, so you don't have to become a payroll company:
- Tax rule updates
- Tax remittance and filing
- Garnishment and retirement remittance
- New hire and termination reporting
- Payroll support workflows. Your customers are supported directly by Everee Customer Success, and you transfer payroll issues to Everee.
You build the experience: onboarding screens, worker management, the hours and pay items you send, payroll approval, and financial reporting for your customers.
Payroll Infrastructure and hosted payrollEveree hosted payroll is the other way to use Everee: your customer runs payroll in the Everee admin portal, and your product integrates through the API. Where a guide covers both, it says "in hosted payroll" and "in Payroll Infrastructure". Hosted payroll is not part of Payroll Infrastructure. Auto-approval, admin users, and the admin portal apply to hosted payroll only.
Who Payroll Infrastructure is for
Payroll Infrastructure is for platform partners: products that run payroll for their own customers. Access follows a partnership agreement with Everee, so a real partner relationship has to be in place before Everee sets up your access and issues your keys. Everee can give a prospective partner evaluation access, a time-limited test key, before the agreement is signed. A business that runs payroll for itself uses hosted payroll instead.
Everee sets whether a company is hosted or in Payroll Infrastructure, and you can't change it with the API. Until your access is in place, try the flows in the simulators. See Hosted payroll or Payroll Infrastructure? for what differs.
How the API tells you what's next
Payroll Infrastructure is built around reads that tell you what's still outstanding, not a fixed sequence of calls you have to get right.
- Onboarding a company: Get onboarding status returns
readiness.missing, a code for each gap. Submit whenreadiness.completeistrue. See The readiness check. - Running payroll: a run's blockers, and the requirements behind them, each say what's wrong and how to fix it, in
resolutionInstructions. A requirement opens when a calculation or a returned deposit finds a problem, so calculate runs early to find them well before the approval deadline. - Funding: a run's funding that needs action has
NEEDS_ACTIONandresolutionInstructions.
The loop is always the same: make a change, read the state again, and act on what's left.
- Don't hard-code the steps. Everee can add a requirement, and codes appear and disappear as a company's answers or a worker's details change.
- Map codes to your screens. Each gap has a machine-readable code and plain-language instructions. Send the user to the screen for each code you know, and show the instructions for any you don't.
- Use webhooks to know when to read again. Events such as
company-onboarding.status-changed,requirement.createdandpayroll-run.status-changedtell you something changed. They don't replace the read.
If you're building with a coding agent, give it this section first: build your flows as loops around these reads.
The path
Payroll Infrastructure follows these areas, from signing up a customer to supporting them. Each links to the guides and references to start with.
| Area | What you do | Start with |
|---|---|---|
| 1. Get your keys | Claim your test key, build in Sandbox, and get your production key | Getting your partner API key, Sandbox and production |
| 2. Onboard a company | Create the company, collect what Everee needs, show the embedded contract signing, and submit for review | Onboarding a company |
| 3. Set up the company | Create work locations, payroll calendars, approval groups, cost centers, pay codes and webhook endpoints | Setting up the company |
| 4. Manage workers | Create complete worker records, keep them in sync, and send deductions, garnishments and leave | Managing workers |
| 5. Run payroll | Add each worker's pay to a payroll run, calculate it, fix what blocks it, approve it, and follow its funding | Running payroll, Funding payroll, Corrections and off-cycle runs |
| 6. After payroll | Follow payouts, show workers what they were paid, and reconcile | After payroll |
| 7. Support and operate | Hand payroll issues to Everee, follow announcements and alerts, and look after your keys | Support and operations |
Foundations
- Authentication and API tokens: partner keys and company keys, the tenant ID header, and how to manage a company's API keys.
- Sandbox and production: a test key creates Sandbox companies and a production key, issued after Everee approves your integration, creates Production companies.
- Company instances and multiple EINs, rate limits, and requests and responses.
- Webhooks: company webhook events, including the payroll run events, and managing a company's webhook endpoints. Partners also have partner webhooks.
- Embedded components: Payroll Infrastructure uses two. Signing the agreements covers the contract signing, and Funding bank account covers the bank account. See Embedded Experiences for the full set.
Build with an agent
The pre-release Payroll Infrastructure partner guide is written so a coding agent can plan and build your payroll workflow and UX on top of Payroll Infrastructure. It has a prompt for each area. A Markdown version is at files.everee.com, and the docs index for agents is llms.txt.
Updated 8 days ago