Use this endpoint to manage a worker's enrollment in Real Time Payroll. All changes to enrollment take effect on the next pay period boundary.

For example, if a worker is currently on weekly payroll and you call this endpoint with enrolled: true, they'll receive a regular weekly payroll payment for the current week, but starting on the first day of the next pay period, they will be enrolled in Real Time Payroll.

If a worker is currently enrolled in Real Time Payroll and you call this endpoint with enrolled: false, they will continue to receive Real Time Payroll payments until the end of the current pay period. Starting on the first day of the next pay period, their earnings will accrue for payment with regularly-scheduled payroll rather than via Real Time Payroll.

Real Time Payroll is subject to credit approval by Everee.

Real Time Payroll is an enrollment, not a pay schedule. Enrolling a worker doesn't change their pay schedule, and you can't enroll a worker by setting paySchedule. The response returns enrolled and an effectiveDate, which is the day after the company's current pay period ends. See Real Time Payroll for a walkthrough.

Only employees can be enrolled. The endpoint responds with 400 if the worker is a contractor, or if no worker matches id.