Public Web Service Methods

The following table describes the full list of publicly exposed web service methods used for synchronizing an employee record.

Web Method Description Input Output
GetEmployeesAll Returns all employees for the specified company. EmployeeRequest EmployeeData
GetEmployeesByDateRange Returns all employees for the specified company where the employee record has been modified during the specified begin and end dates.*Effective dates must be converted to UTC. EmployeeRequest, BeginDate, EndDate EmployeeData
GetEmployeesByEffectiveDate Returns all employees for the specified company where the employee record has been modified on or after the specified begin date.*Effective date must be converted to UTC. EmployeeRequest, BeginDate EmployeeData
GetEmployeesByChangeType Returns all employees for the specified company where the employee’s data (filtered by category) has been changed by the specified change types (add, update, delete) between the effective and expiration dates.*Effective date must be converted to UTC.Pending release of Change Reporting Service Pack 2014 EmployeeRequest, BeginDate, EndDate, DataCategory_ID, IncludeAdds, IncludeChanges, IncludeDeletes EmployeeData
GetEmployeeChanges Returns all employees for the specified company where the employee’s data (filtered by Category IDs [array of int]) has been modified by the specified change type (add, update, delete) between the effective and expiration dates.The employees are returned with necessary info only (EmployeeInfoSkinny object) and includes a collection of Changed Fields.*Effective date must be converted to UTC.Pending release of Change Reporting Service Pack 2014 EmployeeRequest, BeginDate, EndDate, DataCategories, IncludeAdds, IncludeChanges, IncludeDeletes EmployeeData (Note: use EmployeeInfoSkinny object instead of EmployeeInfo.)
UpdateEmployees Used to update the employee mapping between InfinityHR and the 3rd party payroll system database. This is critical when first setting up the mapping of payroll employee IDs to InfinityHR Person IDs. This method updates the EMPLOYEE ID field on the Employee Demographics Screen in InfinityHR with the Payroll Employee ID.The EMPLOYEE ID field will be used as the mapped relationship for SSO and Payroll. EmployeeRequest, Array of Type [EmployeeInfo] Void
UpsertEmployeePaystubs Used to upsert an employee pay stub. The actual file content is transmitted as a byte array and stored to against an employee. PayStubRequest Void
UpsertEmployeePaystubData Used to upsert employee pay stub data. This method upserts the raw data needed to create a pay stub from within the InfinityHR application. This is different than the file method in that a file is not needed to create the pay stub. PayStubDataRequest Void
GetCurrentBenefitStructure Gets the current benefit structure: Package, Benefit, Plan and option levels.The package that is currently active for the current date is returned in the results BenefitRequest BenefitStructure
UpsertEmployeesThis web method is described further in section 2.3.1. This method will upsert employee information in InfinityHR and is intended for systems that are pushing data into InfinityHR. Systems utilizing this web method are acting as the system of record. Whereas, this method takes an array or EmployeeInfo objects, only some properties are updated.  EmployeeRequest, EmployeeDataThe following EmployeeInfo properties are available for insert/update: PayrollEmployeeID SSN FirstName MiddleName LastName Address1 Address2 City State Zip BirthDate Gender (M/F) MaritalStatus (Undefined, Single, Married) HireDate ReHireDate HomePhone TobaccoUser WorkPhone WorkEmail MobilePhone EmployeeStatus (Undefined, Full Time, Part Time, Terminated, Retired, Leave of Absence) EmployeeType Department JobCode OrigHireDate HoursWorked HourlyRate Manager UserDefined1 UserDefined2 UserDefined3 UserDefined4 UserDefined5 Void
GetEmployeeTypes Gets a collection of company specific employee types defined in InfinityHR. EmployeeRequest LookupData
GetDataCategories Gets a collection of InfinityHR Data Categories used to log changes against the employee recordPending release of Change Reporting Service Pack 2014  EmployeeRequest LookupData
GetDepartments Gets a collection of company specific departments defined in InfinityHR. EmployeeRequest LookupData
GetJobCodes Gets a collection of company specific job codes defined in InfinityHR. EmployeeRequest LookupData
GetEnterpriseCompanyInfo Gets a collection of companies that are associated with an InfinityHR enterprise account.Tip: This web method is helpful when you have companies under an enterprise account in InfinityHR and you are looking to perform a sync across all companies of an enterprise account. This is described in more detail in section 2.3.2 CompanyRequest CompanyData
GetCompanyInfo Gets the company information for a specific company determined by the Vendor ID. CompanyRequest CompanyData
GetEmployeeIDs_All Gets all employees for a company by vendor ID. This method will only populate the internal employee identifier property from InfinityHR. EmployeeRequest EmployeeData
GetEmployeeIDs_ByEffectiveDate Gets all employees for a company by vendor ID. This method will only populate the internal employee identifier property from InfinityHR for changed employees by the specified effective date. EmployeeRequest EmployeeData
UploadEmployeeW2 Uploads W2 files to the employee documents section of the InfinityHR application. Note: PDF file formats are only accepted at this time. One PDF per employee is required although multiple files may be uploaded at one time per employee. W2Request Void
GetPayschedules Returns a collection of pay schedules for a specific account in HR. The year must be specified so that the proper pay dates are returned. EmployeeRequest, Year PayScheduleData
UploadTimeOffBalance Uploads time off balance accruals. TimeOffBalanceRequest Void
MapEmployeesForSSO Used to update the employee mapping between InfinityHR and the 3rd party payroll system database. This does NOT update the Employee ID Field on the Demographics Screen or any other Demoraphic Fields.  EmployeeRequest, Array of Type [EmployeeInfo] Void
GetCostCenters Used to retrieve all cost centers configured in the company. CompanyRequest CostCenterData
Was this article helpful?
0 out of 0 found this helpful