Real Time Payroll

Enroll employees in Real Time Payroll and understand how it differs from a pay schedule.

Real Time Payroll is a way of paying an employee instead of through regular payroll. You enroll an employee in it, or take them out of it, with one endpoint.

Enrollment is not a pay schedule. A worker's pay schedule or payroll calendar stays as it is when you enroll them, so an enrolled employee's profile can still show their regular schedule, such as Weekly. Enroll with the dedicated endpoint below, not by setting paySchedule.

Real Time Payroll applies to employees. Contractors can't be enrolled.


Enroll an employee

Call Update Real Time Payroll enrollment with the worker's ID and enrolled: true:

PUT https://api.everee.com/integration/v1/real-time-payroll/enrollment

{
  "id": "maid360-worker-12",
  "enrolled": true
}

id is the worker's external worker ID if one has been set, or their Everee worker ID if not.

The response confirms the change and says when it takes effect:

{
  "enrolled": true,
  "effectiveDate": "2026-11-06"
}

effectiveDate is the day after the company's current pay period ends. You don't need to close or finish the current pay period first.

To take an employee out of Real Time Payroll, send the same request with enrolled: false. See the endpoint reference for how pay is handled around the change.


What not to do

  • Don't send REAL_TIME as a paySchedule. The valid paySchedule values are pay frequencies, and Real Time Payroll isn't one of them.
  • Don't try to enroll through the worker payment-info endpoint. It sets how a worker is paid, such as direct deposit or pay card, but it doesn't enroll them in Real Time Payroll.

Errors

StatusCause
400The worker isn't an employee. Contractors can't be enrolled.
400No worker matches the id you sent for the company in your request's tenant.

If you get an unexpected result, first confirm you're using the right tenant ID and token for the environment you intend. A worker created in one instance doesn't exist in the other.

An employee enrolled in Real Time Payroll must have an hourly position. Updating such a worker to a position that isn't hourly returns a 400.


Did this page help you?