Skip to main content

CREATE_PAYBATCH

Call the payroll plugin to create a new payroll batch

Example Usage

CREATE_PAYBATCH(2023-04-13,2023-04-10,0,0,2023-04-24 17:00)

Overview

Function signature
CREATE_PAYBATCH(paydate, periodending, offcycle, autorun, scheduledfor, paygroups)

Category
Plugin

Return data type
bool

Arguments

NameDataTypeList Options                          Description
paydatedateThe date employees will be paid
periodendingdateThe last day of the payperiod
offcycleboolWhen set this will be a manual selection of employees
autorunboolWhen set the batch will be processed when submitted
scheduledfordatetimeWhen not auto-run, the datetime to process the batch
paygroupslist``When not off-cycle, a list of one or more paygroups to pay