Working with Employee Date-effective Historical Information

The WFH Employee schema includes date-effective fields, meaning that the field values can change over time. WFH includes several date-effective Employee fields, including:

  • Organization (Location, Department, or Position)
  • Manager
  • Employee Type
  • General date-effective fields (e.g., job title)

Use the Get Employee Organization History endpoint to see the history for an employee for a specific organization level.  You will need to provide the employeeId and organizationLevelId when calling this endpoint.  If you don’t know the OrganizationLevelId, you can use the Get Company Organization Levels endpoint to get it.

Use the following endpoints to get date-effective field historical information:

Note: Anytime an endpoint is called that returns date-effective information, if no beginEffectiveDate and endEffectiveDate range is provided, only the “current” value of the date-effective field will be returned. If a range is provided, only the values in that range will be returned.

For example, if employee “John Carter” was hired on February 17th and had an initial Location (a date-effective) field of “Houston, TX”, and then on April 27th had changed Location to “Austin, TX”, then both Locations would be stored in (and visible in) WFH. If an endpoint such as Get Employees or Get Employee Organization History was called and included a begin and end effective date, then only date-effective fields in the defined date range would be returned.