Integrating with Everee

This page is for the engineers (and agents) building an integration with Everee. It lists three common integration scenarios, and for each one, the API sections you'll use and the order to approach them. For a product-level overview of the full API surface, see the Everee Integration API home page.

📘
New B2B integrations require review before going live
If you're building an integration that will be used by multiple Everee customers, Everee must review it before we approve and publish it for use with live customers. You're free to build and test against a sandbox company instance at any time. Contact your Everee Customer Success manager, or email [email protected], early in your build so we can plan the review with you.

Before you start

Every scenario below shares the same foundations:

Authentication. Requests use a server-side API token. Never put it in client-side code. See Authentication & API Tokens.
Conventions. Requests & responses, pagination, and rate limits are the same across every API.
Company instances. Each Everee company has its own instance and tenant ID. Customers with several EINs have several instances; see multiple EIN company instances.
Money doesn't move until a payroll admin approves it. Submitting wages through the API is safe to do early and often.

1. Staffing or frontline-workforce company

You place or manage large, changing workforces, and want Everee to onboard workers, pay them accurately for the hours and amounts you record, and give you the data to bill clients and reconcile.

Step	What you need	APIs
Set up locations and groups	Work locations, approval groups, and reference data so wages get the right tax jurisdiction, workers' comp class, and pay cycle.	Organization API
Onboard workers	Start Everee-managed onboarding for employees and contractors, or add complete records, and rehire or separate workers as assignments change.	Create Worker API, Embedded Experience API
Keep worker data in sync	Update personal info, addresses, pay rates, work location, and payment preferences when they change on your side.	Worker Data API
Send hours	Push shifts (with breaks) or pre-classified pay period hours for hourly employees. Everee handles overtime, multiple rates and locations, and tax jurisdiction.	Timesheets API
Send everything else	Contractor pay, bonuses, stipends, and reimbursements as payable items. Tag hours and payables with cost centers, such as client or job, to allocate costs later.	Payables API, cost centers
Reconcile and bill	Pull itemized payments for each payroll run to tie out to your books and invoice clients.	Payment Data API
Post to the GL	Retrieve each payroll funding as balanced debits and credits with your GL codes, ready to post to your accounting system.	Payroll journal, GL mappings
React to events	Learn when workers finish onboarding, payments are paid or returned, and reports are ready.	Webhook events

A typical flow: create the worker and send them to onboarding, receive worker.onboarding-completed, submit shifts and payables as work happens, then use payment.paid to trigger a pull of payment data for that pay date and the payroll journal for your GL.

2. ATS and/or timekeeping system

You manage candidates or time capture, and want hired workers to land in Everee and their hours or pay amounts to flow into payroll.

Step	What you need	APIs
Map your structure	Match your sites, departments, or groups to Everee work locations and approval groups.	Organization API
Onboard hires	Kick off onboarding with minimal data when a candidate is hired. Everee collects the sensitive details itself, so you don't have to handle tax or banking information.	Create Worker API
Submit time	Send shifts as they're worked, or classified hours per pay period. Include break times if you capture them, since some jurisdictions require shift detail on pay stubs. If your customers allocate labor by client, job, or department, tag each shift with cost centers.	Timesheets API, cost centers
Submit non-hourly pay	Send bonuses, commissions, reimbursements, or contractor pay as payable items, with the same cost centers if you use them.	Payables API
React to events	Know when a worker is ready to be paid, and keep your records current.	Webhook events

A typical flow: hire a candidate, call the onboarding endpoint, wait for worker.onboarding-completed, then begin sending that worker's timesheet data. If you send pre-classified hours, read Complying with the OBBBA overtime rule first.

3. Benefits or retirement TPA (or similar provider)

You administer benefit or retirement plans, and need the right deductions taken from each worker's pay, matching the elections in your system.

Step	What you need	APIs
Find and match workers	List, search, and retrieve workers, and store your own identifier on each worker so you can match records.	Worker Data API
Sync deductions	Start, change, or end recurring benefit, retirement, and other deductions with a single request per worker and pay code.	Deductions API
Reconcile	Read back what payroll actually deducted and contributed, to tie out to your own records.	Get deduction reconciliation

A typical flow: match each plan participant to an Everee worker, apply their deductions with an effective date, and reconcile after each payroll.

Not sure which fits?

Most integrations combine pieces of these. The Everee Integration API home page describes every API and how they work together, and the sections in this reference are organized by API.