Common Workflows Overview

How the pieces of the Everee API fit together, and which workflow guide to read first.

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:

1. Set up        Work locations, approval groups, payroll calendars, pay codes, cost centers
2. Onboard       Create workers, get them through onboarding, keep their profiles current
3. Send pay      Shifts and classified hours for hourly employees, payable items for everything else
4. Payroll runs  A payroll admin approves, Everee calculates and funds, workers are paid
5. Reconcile     Payment data, payroll journal, cost segments, deduction reconciliation

Steps 1, 2, 3, and 5 are yours. Step 4 belongs to Everee and your customer's payroll admins. No money moves until a payroll admin approves it, so it's safe to send data early and often.


Where to start

If you're building...Start withThen
Something new, and nothing is set up yetSetting up your organizationOnboarding and managing workers
A hiring or onboarding flow, such as an ATSOnboarding and managing workersTime and attendance
A timekeeping or scheduling systemTime and attendanceSending pay to Everee
A platform that pays contractors or gig workersSending pay to EvereeReconciling payroll and posting to your GL
Billing or accounting softwareReconciling payroll and posting to your GLSetting up your organization, for cost centers
A benefits or retirement administration platformSyncing benefit and retirement deductionsOnboarding and managing workers, to match workers
Paid time off administrationManaging leave and PTOTime 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:

EventWhat it tells youUsed in
worker.onboarding-completedThe worker is ready to be paidOnboarding and managing workers
worker.profile-updatedSomething on the profile changed; re-sync your copyOnboarding and managing workers
payment.paidA payment has been submitted for depositSending pay to Everee, Reconciling payroll and posting to your GL
payment.deposit-returnedA worker's bank returned a depositSending pay to Everee
report.completedA report you requested is ready to downloadReconciling payroll and posting to your GL

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


Did this page help you?