PayPeriod Property

Payroll property: Indicates how often employees are paid.

Syntax

 employee.getPayPeriod([callback])
 employee.setPayPeriod( payPeriod, [callback])

Possible Values

  0 (ppNotSet), 
  1 (ppDaily), 
  2 (ppWeekly), 
  3 (ppBiweekly), 
  4 (ppSemimonthly), 
  5 (ppMonthly), 
  6 (ppQuarterly), 
  7 (ppYearly)

Default Value

0

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for the getPayPeriod([callback]) method is defined as:

function(err, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

The callback for the setPayPeriod([callback]) method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

Indicates how often employees are paid. The default value is whatever the QuickBooks user has set in the QuickBooks Employee Preferences. This property is required for an Update request.

Data Type

Integer