Update Existing API Integrations to Use Enhanced Employee Gender

Enhanced Employee Gender Playbook

Version
R2025.1.1
Update Existing API Integrations to Use Enhanced Employee Gender

With Enhanced Employee Gender, data becomes less of a “one size fits all” solution, because it now depends on the following factors:

  • Has the customer done any configuration in the Gender administration screen (HR Admin > Employee Gender Admin)?
  • Does the customer operate in the United States or Canada? Or are their employees in other countries too?
  • Does the customer have non-binary employees?
  • Will the customer allow their employees to provide multiple different assigned sex and gender identity values for different locations where they live or work?
  • Has this customer enabled the Display Enhanced Gender Last Modification Information and Effective Dating client property?

Customers currently populate the EmployeeBase.Gender field for gender information. If customers want to update their API integration, they need to populate the fields described in the following table.

New API fields for using enhanced employee gender
Field Purpose
EmployeeAssignedSexAndGenderIdentity.Country.XRefCode This is the country that the record is for.
EmployeeAssignedSexAndGenderIdentity.State.XRefCode This is the state or province for the United States or Canada.
EmployeeAssignedSexAndGenderIdentity.AssignedSexCountryAware.XRefCode

This is where the assigned sex value will be provided (e.g., M, F)

This was previously known as gender and was entered in EmployeeBase.Gender.

EmployeeAssignedSexAndGenderIdentity.GenderIdentityCountryAware.XRefCode

This is where the gender identity value will be provided.

This was previously entered in EmployeeBase.GenderIdentity.XRefCode

EmployeeAssignedSexAndGenderIdentity.EffectiveStart This is used if effective dating is enabled.
EmployeeAssignedSexAndGenderIdentity.EffectiveEnd This is used if effective dating is enabled.

GET Requests

If a customer is using the GET Employee Details endpoint and wants to include Assigned Sex or Gender Identity values following the adoption of Enhanced Employee Gender functionality, they need to use the EmployeeAssignedSexAndGenderIdentity expander.

For more information about expanders and the GET Employee Details endpoint, see the Dayforce Developer Network (developers.dayforce.com).

POST Requests

The following code shows an example of a JSON payload for the new POST EmployeeAssignedSexAndGenderIdentity endpoint:

Copy
{
  "Country": {
    "Name": "string",
    "XRefCode": "string",
    "ShortName": "string",
    "LongName": "string",
    "LastModifiedTimestamp": "2024-12-19T16:25:07.504Z"
  },
  "State": {
    "Name": "string",
    "XRefCode": "string",
    "ShortName": "string",
    "LongName": "string",
    "LastModifiedTimestamp": "2024-12-19T16:25:07.504Z"
  },
  "AssignedSexCountryAware": {
    "AssignedSexComplianceCode": {
      "ComplianceCode": "string",
      "XRefCode": "string",
      "ShortName": "string",
      "LongName": "string",
      "LastModifiedTimestamp": "2024-12-19T16:25:07.504Z"
    },
    "UserDefinedComplianceCode": "string",
    "XRefCode": "string",
    "ShortName": "string",
    "LongName": "string",
    "LastModifiedTimestamp": "2024-12-19T16:25:07.504Z"
  },
  "GenderIdentityCountryAware": {
    "XRefCode": "string",
    "ShortName": "string",
    "LongName": "string",
    "LastModifiedTimestamp": "2024-12-19T16:25:07.504Z"
  },
  "EffectiveStart": "2024-12-19T16:25:07.504Z",
  "EffectiveEnd": "2024-12-19T16:25:07.504Z",
  "LastModifiedTimestamp": "2024-12-19T16:25:07.504Z"
}