Web API Help Page

Introduction

*When using the XML version of our APIs, please order the XML elements in the designated order to insure proper functionality.
*You can get the signatures of the api calls by calling a get to the root of a controller with out any params.

Company

API	Description
GET api/company/terminationreasons?companycode={companycode}	Gets the list of termination reasons for a company.

GetHired

API	Description
POST api/GetHired	No documentation available.

FormImport

Class FormImportController.

API	Description
POST api/FormImport	Posts the specified model.
PUT api/FormImport	Puts the specified XML document.

EmployeeType

End Point for EmployeeTypes.

API	Description
GET api/EmployeeType?companyCode={companyCode}&divisionCode={divisionCode}&employeeTypeCode={employeeTypeCode}	Gets the specified Employee Type.
GET api/EmployeeType?companyCodes={companyCodes}	Gets a list of Employee Types for a company.

TimesheetImport

API	Description
POST api/TimesheetImport	Imports timesheets to be used in a future payroll.
DELETE api/TimesheetImport	Deletes timesheets that are not currently being used in a payroll
GET api/TimesheetImport?start={start}&end={end}&companyCode={companyCode}	Gets the list of timesheet records for the given date range and company code
GET api/TimesheetImport?start={start}&end={end}	Gets the list of timesheet records for the given date range

TimePunches

Class TimePunchesController.

API	Description
GET api/TimePunches?fromDate={fromDate}&toDate={toDate}&companyCodes={companyCodes}	Gets the earnings data for all the employees of the companies in the list between the passed in dates.
POST api/TimePunches	Inserts a time punch. note: A calculation must occur for the punch earning to account for inserted time punches, as well as any system punch generated at the time of calculation based on company rule configurations.

CompanyPayees

Class CompanyPayeesController.

API	Description
GET api/CompanyPayees?companyCode={companyCode}	Gets all payees for the specified company code.

NewHireImport

Class NewHireImportController.

API	Description
POST api/NewHireImport	Imports a collection of NewHireImport records.

RawTimePunches

Class TimePunchesController.

API	Description
GET api/RawTimePunches?fromDate={fromDate}&toDate={toDate}&companyCodes={companyCodes}	Gets Raw Time Punch data for all the employees of the companies in the list between the passed in dates.

Position

Controller for Position Data Access

API	Description
GET api/Position?companyCode={companyCode}	Gets the listing of all Positions for a specific company code.
GET api/Position?companyCode={companyCode}&positionId={positionId}	Gets information for a specific Position given a PositionId and CompanyCode.

Payrate

API	Description
POST api/Payrate	Updates employee payrates. If the employee is a salaried employee, then the supplied payrate is treated as the employee's annual salary amount. Otherwise, the supplied payrate is treated as the employee's hourly pay amount.

Demographics

Class DemographicsController.

API	Description
GET api/Demographics?companyIds={companyIds}	Gets demographic information for the specified list of company ids. The default transport format is JSON. To force the use of XML you can use the &frmt=xml option or add an "Accept" HTML header with the value of "application/xml:
GET api/Demographics?companyIds={companyIds}&since={since}	Gets demographic information for the specified list of company ids that have changed on or after the Date sepcified in the since parameter. The default transport format is JSON. To force the use of XML you can use the &frmt=xml option or add an "Accept" HTML header with the value of "application/xml:
POST api/Demographics	Posts the specified employee codes list.

Hire

Class HireController.

API	Description
GET api/Hire?employeeId={employeeId}	Gets the specified company ids.
GET api/Hire?companyCodes={companyCodes}	Gets the employee hire information for the provided company Codes.

Deductions

Class DeductionsController.

API	Description
GET api/Deductions?employeeId={employeeId}	RESTfull Get Method to return all employee deduction records for a specific employee.
GET api/Deductions?companyIds={companyIds}	RESTfull Get Method to return all employee deduction records for employees by company ids.
POST api/Deductions	Posts the specified deduction.
PUT api/Deductions	Puts the specified deduction.
DELETE api/Deductions?deductionCode={deductionCode}&employeeId={employeeId}&companyCode={companyCode}	Deletes the specified deduction code.

Hireology

API	Description
POST api/Hireology	Stores the information provided about the user being onboarded

EmployeeLookup

Class EmployeeLookupController

API	Description
POST api/EmployeeLookup	Gets employee demographics/information by SSN and company code.

AffordableCareAct

Class AffordableCareActController

API	Description
GET api/AffordableCareAct?employeeId={employeeId}	Gets the specified ACA Hours information for the provided employee.
GET api/AffordableCareAct?companyCodes={companyCodes}	Gets the specified ACA Hours information for each employee in the provided companies.

CompanyDeductions

Class CompanyDeductionsController.

API	Description
GET api/CompanyDeductions?companyCode={companyCode}	Gets the specified companycode.

EmployeeDependents

API	Description
POST api/EmployeeDependents	No documentation available.

Location

Class LocationController.

API	Description
GET api/Location?locationId={locationId}	Gets the specified location identifier.

Employees

API	Description
POST api/Employees	Terminates the list of employees passed in and optionally you can set the following attributes: Termination Date, Eligible for Rehire, Termination Type and Termination Reason. The attribute, Eligible for Rehire, defaults to false. If you choose to pass in the Termination Type, you must pass either VOL or INVOL meaning Voluntary or Involuntary. If you choose to pass a Termination Reason, then you must call api/company/terminationreasons?companycode={companycode} to get the valid termination reason list.

API

Description

POST api/Employees

Terminates the list of employees passed in and optionally you can set the following attributes: Termination Date, Eligible for Rehire, Termination Type and Termination Reason. The attribute, Eligible for Rehire, defaults to false. If you choose to pass in the Termination Type, you must pass either VOL or INVOL meaning Voluntary or Involuntary. If you choose to pass a Termination Reason, then you must call api/company/terminationreasons?companycode={companycode} to get the valid termination reason list.

BackgroundCheck

Class BackgroundCheckController

API	Description
POST api/BackgroundCheck	Posts the specified background reports.

ContactInfo

API	Description
GET api/ContactInfo?companyCodes={companyCodes}	Gets contact information for all employees in a company.