ACABenefitCategory

APIDescription
GET api/ACABenefitCategory?AuthenticationGUID={AuthenticationGUID}&PartyID={PartyID}

Returns an array of all available ACA Benefit Categories for the Company

POST api/ACABenefitCategory?AuthenticationGUID={AuthenticationGUID}&PartyID={PartyID}

Adds Additional ACA Benefit Categories for the provided LocationID or CompanyID

Bonus

APIDescription
GET api/Bonus?AuthenticationGUID={AuthenticationGUID}&PartyID={PartyID}

Returns an array of available bonus types for a LocationID or CompanyID

POST api/Bonus?AuthenticationGUID={AuthenticationGUID}&PartyID={PartyID}

Adds Additional Bonus Types for the provided LocationID or CompanyID

Branch

APIDescription
GET api/Branch?AuthenticationGUID={AuthenticationGUID}&PartyID={PartyID}

Returns an array of available Branches for a LocationID or CompanyID

POST api/Branch?AuthenticationGUID={AuthenticationGUID}&PartyID={PartyID}

Adds Additional Branches for the provided LocationID or CompanyID

Company

APIDescription
GET api/Company?AuthenticationGUID={AuthenticationGUID}

Returns a list of Companies for the supplied Authentication GUID. This contract will return more than one record if you are a Service Bureau customer

GET api/Company?AuthenticationGUID={AuthenticationGUID}&ExternalID={ExternalID}

Returns a Company class for the supplied AuthenticationGUID and ExternalID

PUT api/Company?AuthenticationGUID={AuthenticationGUID}

Returns a Company class for the supplied AuthenticationGUID and CompanyID

Department

APIDescription
GET api/Department?AuthenticationGUID={AuthenticationGUID}&PartyID={PartyID}

Returns an array of available Departments for a LocationID or CompanyID

POST api/Department?AuthenticationGUID={AuthenticationGUID}&PartyID={PartyID}

Adds Additional Departments for the provided LocationID or CompanyID

DirectDepositType

APIDescription
GET api/DirectDepositType?AuthenticationGUID={AuthenticationGUID}

Returns an array of available Direct Deposit Types for the company or service bureau identified by the authorization GUID

Division

APIDescription
GET api/Division?AuthenticationGUID={AuthenticationGUID}&PartyID={PartyID}

Returns an array of available Divisions for a LocationID or CompanyID

POST api/Division?AuthenticationGUID={AuthenticationGUID}&PartyID={PartyID}

Adds Additional Divisions for the provided LocationID or CompanyID

Employee

APIDescription
GET api/Employee?AuthenticationGUID={AuthenticationGUID}&ExternalID={ExternalID}&CompanyID={CompanyID}

Returns an array of employees for the supplied AuthenticationGUID, CompanyID, and ExternalID

GET api/Employee?AuthenticationGUID={AuthenticationGUID}&FirstName={FirstName}&LastName={LastName}&CompanyID={CompanyID}

Returns an array of employees with the given names for the Company

GET api/Employee?AuthenticationGUID={AuthenticationGUID}&PartyID={PartyID}

Returns the employee specified by the given party ID.

GET api/Employee?AuthenticationGUID={AuthenticationGUID}&CompanyID={CompanyID}&SSN={SSN}

Returns an employee for the given SSN and CompanyID

GET api/Employee?AuthenticationGUID={AuthenticationGUID}&RegReqID={RegReqID}

Returns an Employee Export Class for the supplied AuthenticationGUID, RegistrationRequestID

GET api/Employee?AuthenticationGUID={AuthenticationGUID}&CompanyID={CompanyID}&FirstName={FirstName}&LastName={LastName}&Email={Email}

Returns an Array of Employee Lookup Information matching the data provided

POST api/Employee?AuthenticationGUID={AuthenticationGUID}&CompanyID={CompanyID}&LocationID={LocationID}&RegRequestType={RegRequestType}&SendRegEmailYN={SendRegEmailYN}

Imports an Employee to EHX, creates the first RequestType and allows you to send a registration email to the employee

GET api/Employee?AuthenticationGUID={AuthenticationGUID}&CompanyID={CompanyID}&DaysBack={DaysBack}

Returns an Array of all Employees for the provided Company ID in the past DaysBack number of days

EmployeeStatus

APIDescription
GET api/EmployeeStatus?AuthenticationGUID={AuthenticationGUID}

Returns an array of available Employee Statuses for the company or service bureau identified by the authorization GUID

GET api/EmployeeStatus?AuthenticationGUID={AuthenticationGUID}&EmployeeID={EmployeeID}

Returns employee status based on provided employee ID.

EmployeeType

APIDescription
GET api/EmployeeType?AuthenticationGUID={AuthenticationGUID}

Returns an array of available Employee Types for the company or service bureau identified by the authorization GUID

Form

APIDescription
GET api/Form?AuthenticationGUID={AuthenticationGUID}&RegReqID={RegReqID}

Returns a base-64 encoded string that represents the PDF form for the supplied

Gender

APIDescription
GET api/Gender?AuthenticationGUID={AuthenticationGUID}

Returns an array of available Genders for the company or service bureau identified by the authorization GUID

Location

APIDescription
GET api/Location?AuthenticationGUID={AuthenticationGUID}&CompanyID={CompanyID}

Returns a list of Active Locations for the supplied Authentication GUID and Company.

GET api/Location?AuthenticationGUID={AuthenticationGUID}&ExternalManagerID={ExternalManagerID}&ExternalCompanyID={ExternalCompanyID}

Returns an array of locations for the supplied AuthenticationGUID, ExternalManagerID and ExternalCompanyID.

GET api/Location?AuthenticationGUID={AuthenticationGUID}&ManagerID={ManagerID}

Retrieves a list of Locations for the given ManagerID

POST api/Location?AuthenticationGUID={AuthenticationGUID}

Imports an List of Location classes to the EHX Database. Returns a List of Location classes.

PUT api/Location?AuthenticationGUID={AuthenticationGUID}

Updates a location in the EHX Database. Returns a Location class for the supplied AuthenticationGUID and Location.

LocationCode

APIDescription
GET api/LocationCode?AuthenticationGUID={AuthenticationGUID}&PartyID={PartyID}

Gets locations codes for the provided LocationID

POST api/LocationCode?AuthenticationGUID={AuthenticationGUID}&PartyID={PartyID}

Adds Additional Location Codes for the provided LocationID

Manager

APIDescription
GET api/Manager?AuthenticationGUID={AuthenticationGUID}&CompanyID={CompanyID}

Returns an array of managers for a given AuthenticationGUID, and CompanyID

POST api/Manager?AuthenticationGUID={AuthenticationGUID}

Imports a List of Manager Classes to the EHX Database. Returns a list of Manager classes

PUT api/Manager?AuthenticationGUID={AuthenticationGUID}

Updates a manager in the EHX Database. Returns the updated manager.

PUT api/Manager?AuthenticationGUID={AuthenticationGUID}&ManagerID={ManagerID}

Updates locations associated with a Manager ID based on a list of Location IDs. Returns a "SUCCESS" on successful update, or Error information as a string

MaritalStatus

APIDescription
GET api/MaritalStatus?AuthenticationGUID={AuthenticationGUID}

Returns an array of available Marital Statuses for the company or service bureau identified by the authorization GUID

OfferLetterTemplate

APIDescription
GET api/OfferLetterTemplate?AuthenticationGUID={AuthenticationGUID}&PartyID={PartyID}

Returns an array of available Offer letter templates for a LocationID or CompanyID

POST api/OfferLetterTemplate?AuthenticationGUID={AuthenticationGUID}&PartyID={PartyID}

Adds Additional Offer letter templates for the provided LocationID or CompanyID

Package

APIDescription
GET api/Package?AuthenticationGUID={AuthenticationGUID}&PartyID={PartyID}

Returns an array of available Packages for a LocationID or CompanyID

POST api/Package?AuthenticationGUID={AuthenticationGUID}&PartyID={PartyID}

Adds Additional Packages for the provided LocationID or CompanyID

PayFrequency

APIDescription
GET api/PayFrequency?AuthenticationGUID={AuthenticationGUID}

Returns an array of available Pay Frequencies for the company or service bureau identified by the authorization GUID

PayrollDeduction

APIDescription
GET api/PayrollDeduction?AuthenticationGUID={AuthenticationGUID}&PartyID={PartyID}

Returns an array of available payroll deducations for a LocationID or CompanyID

POST api/PayrollDeduction?AuthenticationGUID={AuthenticationGUID}&PartyID={PartyID}

Adds Additional Payroll Deducations for the provided LocationID or CompanyID

PayType

APIDescription
GET api/PayType?AuthenticationGUID={AuthenticationGUID}

Returns an array of available Pay Types for the company or service bureau identified by the authorization GUID

Position

APIDescription
GET api/Position?AuthenticationGUID={AuthenticationGUID}&PartyID={PartyID}

Returns an array of available Positions for a LocationID or CompanyID

POST api/Position?AuthenticationGUID={AuthenticationGUID}&PartyID={PartyID}

Adds Additional Positions for the provided LocationID or CompanyID

RegRequest

APIDescription
POST api/RegRequest?AuthenticationGUID={AuthenticationGUID}&RegRequestID={RegRequestID}

Sets the specified Registration Request to Exported.

GET api/RegRequest?AuthenticationGUID={AuthenticationGUID}&CompanyID={CompanyID}&RegRequestStatus={RegRequestStatus}&RegRequestType={RegRequestType}&DaysBack={DaysBack}

Gets all RegRequests for the given company created in the last {DaysBack} number of days.

RegRequestExport

APIDescription
GET api/RegRequestExport?AuthenticationGUID={AuthenticationGUID}&CompanyID={CompanyID}&RegistrationTypeCode={RegistrationTypeCode}&RegistrationStatus={RegistrationStatus}

Will return all employee regId's ready for export by company

RegTypeCode

APIDescription
GET api/RegTypeCode?AuthenticationGUID={AuthenticationGUID}&CompanyID={CompanyID}

Gets all avalable Reg type codes for a company

RegTypeStatuses

APIDescription
GET api/RegTypeStatuses?AuthenticationGUID={AuthenticationGUID}&CompanyID={CompanyID}

Gets all avalable Reg Request statusess for a company

GET api/RegTypeStatuses?AuthenticationGUID={AuthenticationGUID}&RegRequestID={RegRequestID}

Returns employee status based on provided registration request.

Reimbursement

APIDescription
GET api/Reimbursement?AuthenticationGUID={AuthenticationGUID}&PartyID={PartyID}

Returns an array of available reimbursement for a LocationID or CompanyID

POST api/Reimbursement?AuthenticationGUID={AuthenticationGUID}&PartyID={PartyID}

Adds Additional reimbursement types for the provided LocationID or CompanyID

SSO

APIDescription
GET api/SSO?AuthenticationGUID={AuthenticationGUID}&EmployeeID={EmployeeID}

Returns a Single Sign-on URL for a given AuthenticationGUID and PartyID. This contract applies for all user roles in EHX: Employee, Manager, Administrator. The EF API will manage security for the user in EHX.

GET api/SSO?AuthenticationGUID={AuthenticationGUID}&ExternalManagerID={ExternalManagerID}&ExternalCompanyID={ExternalCompanyID}

Returns a Single Sign-on URL for a given AuthenticationGUID ExternalManagerID, ExternalCompanyID. This contract applies for all user roles in EHX: Employee, Manager, Administrator. The EF API will manage security for the user in EHX.

WOTCPositionCode

APIDescription
GET api/WOTCPositionCode?AuthenticationGUID={AuthenticationGUID}&PartyID={PartyID}

Returns an array of available WOTC position codes for a LocationID or CompanyID

POST api/WOTCPositionCode?AuthenticationGUID={AuthenticationGUID}&PartyID={PartyID}

Adds Additional WOTC Position Codes for the provided LocationID or CompanyID