📘
Contractors and employees work differently
Only W-2 employees, not contractors, are included in regularly scheduled payroll cycles, so while you can pay out payable items to employees either "immediately" or "with payroll", contractors can only be paid using the "immediately" approach. You must call this endpoint to pay contractors.
See the Payables Guide for more information.

In Everee, W-2 employees are paid on a regular pay cycle and contractors are not. Any payable items for employees will be automatically included as part of their regular payroll if they aren't processed into off-cycle payments beforehand using this endpoint.

All payable items for contractors must be processed by calling this endpoint, since contractors don't have regular payroll cycles that would process payable items as part of payroll automatically.

This behavior is controlled with the includeWorkersOnRegularPayCycle parameter. It's false by default, so the default behavior is to only process contractors' payable items into off-cycle payments, and allow employees' items to be included in their payroll.

🚧
Are you in the staffing industry? Stick with the defaults
The Payables API is designed to work well out-of-the-box for the staffing industry. Payable items for contractors are typically pushed to Everee alongside timesheet hours and payable items for employees, all at the same time, once they're approved and ready for payroll.
That means once you've pushed all timesheet hours and payable items for all workers, simply call this endpoint to process payable items for payout, and we'll automatically do the right thing: process contractors' payable items into off-cycle payments, and process employees' payable items into their regularly scheduled payroll payments.

Setting the parameter to true will include employees' payable items for immediate (i.e. off-cycle) processing as well, and will cause those payable items to be processed into payments separate from their regularly scheduled payroll. You may or may not want this, depending on your payroll workflow, your workers' expectations, your cash flow, and many other factors.

You can use the following scenarios to help decide how to manage the different classifications:

Are you only paying contractors?

You have to call this endpoint in order for any payable items to be paid out.

Are you only paying employees?

You have to choose whether you want employees' payable items to be paid out immediately or with regular payroll. By default, employees' payable items will wait for regular payroll and won't be paid out immediately.

See the includeWorkersOnRegularPayCycle parameter to control this.

Are you paying both contractors and employees?

You have to call this endpoint in order for any payable items to be paid out to contractors.

For employees, you have to choose whether you want employees' payable items to be paid out immediately, as they are for contractors, or wait for them to be included with regular payroll. By default, employees' payable items will wait for regular payroll and won't be paid out immediately.

See the includeWorkersOnRegularPayCycle parameter to control this.

After processing payable items for payout

Once payout has been requested, this operation populates a paymentStatus field on affected payable items. Any payable items successfully processed for payout will trigger a payment-payables.status-changed webhook event.