Common Workflows Overview

The API reference describes each endpoint. These guides describe how to combine them to get a job done: what to call, in what order, what to listen for, and what can go wrong.

Every integration follows the same lifecycle, whatever it's built for:

Step	What happens	Guide
1. Set up	Work locations, approval groups, payroll calendars, pay codes, cost centers	Setting up your organization
2. Onboard	Create workers, get them through onboarding, keep their profiles current	Onboarding and managing workers
3. Send pay	Hosted payroll: shifts and classified hours for hourly employees, payable items for everything else. Payroll Infrastructure: items on a payroll run	Time and attendance, Sending pay to Everee, Running payroll
4. Payroll runs	Payroll is approved, Everee calculates and funds, workers are paid	Everee admin portal (hosted payroll), or the Payroll Run API (Payroll Infrastructure): see Running payroll
5. Reconcile	Payment data, payroll journal, cost segments, deduction reconciliation	Reconciling payroll and posting to your GL

Steps 1, 2, 3, and 5 are yours. In hosted payroll, step 4 belongs to Everee and your customer's payroll admins. In Payroll Infrastructure, you calculate and approve each payroll run through the API, and Everee funds it and pays the workers. No money moves until payroll is approved, so it's safe to send data early and often.

Where to start

If you're building...	Start with	Then
Something new, and nothing is set up yet	Setting up your organization	Onboarding and managing workers
A hiring or onboarding flow, such as an ATS	Onboarding and managing workers	Time and attendance
A timekeeping or scheduling system	Time and attendance	Sending pay to Everee
A platform that pays contractors or gig workers	Onboarding and paying contractors	Reconciling payroll and posting to your GL
Billing or accounting software	Reconciling payroll and posting to your GL	Setting up your organization, for cost centers
A benefits or retirement administration platform	Syncing benefit and retirement deductions	Onboarding and managing workers, to match workers
Paid time off administration	Managing leave and PTO	Time and attendance

For the same scenarios told from the point of view of your business type, see Integrating with Everee.

Use webhooks instead of polling

Almost every workflow here has a moment where you wait for Everee: a worker finishing onboarding, a payment being paid, a report finishing. Instead of polling, subscribe to webhook events. The ones you'll use most:

Event	What it tells you	Used in
`worker.onboarding-completed`	The worker is ready to be paid	Onboarding and managing workers
`worker.profile-updated`	Something on the profile changed; re-sync your copy	Onboarding and managing workers
`payment.paid`	A payment has been submitted for deposit	Sending pay to Everee, Reconciling payroll and posting to your GL
`payment.deposit-returned`	A worker's bank returned a deposit	Sending pay to Everee
`report.completed`	A report you requested is ready to download	Reconciling payroll and posting to your GL
`payroll-run.status-changed`	A payroll run was calculated, blocked, approved or paid (Payroll Infrastructure)	Running payroll
`requirement.created`	Something must be fixed before payroll can process (Payroll Infrastructure)	Running payroll

See Implementing a webhook handler and Securing your handler before you go live.

When something goes wrong

If a request fails, or does something you didn't expect, the Request Log API shows what Everee received and what it answered, including the request body and the error response. See Diagnosing a failed request.