Skip to content

Paychex.Workers

Brian Tully edited this page Nov 29, 2017 · 7 revisions

Paychex.Workers.List(companyId, query)

Returns an array of Worker objects for a specific company

Paychex.Workers.list('XXXXX').then(function(workers){
  console.log(workers);
});

Optional query parameters

  • givenName
  • familyName
  • legalLastFour
  • searchStartDate
  • searchEndDate
Paychex.Workers.list('XXXXX', {familyName : 'Jones'}).then(function(workers){
  console.log(workers);
});

Paychex.Workers.get(workerId)

Get a worker by workerId
Returns an instance of a Worker

Paychex.Workers.get('XXXXXX').then(function(worker){
  console.log(worker);
});

Paychex.Workers.getByEmployeeId(companyId, employeeId)

Get a worker by companyId and employeeId Returns an instance of a Worker

Paychex.Workers.getByEmployeeId('companyId', 'employeeId').then(function(worker){
  console.log(worker);
});

Paychex.Workers.update(workerId, update)

Update a worker Returns an instance of a Worker

Paychex.Workers.update('XXXXXX', {employmentType : 'FULL_TIME'}).then(function(worker){
  console.log(worker);
});

Clone this wiki locally