Skip to main content

SearchEmployeesResultNode

A SearchEmployeesResultNode is represents an employee in any state of the membership lifecycle. The underlying data will either describe an employee who is registered with First Dollar but has not opened an HSA, an employee who has an opened HSA with First Dollar, or a pending membership that has not been committed.

type SearchEmployeesResultNode {
  benefitsEligibilityStatus: BenefitsEligibilityStatus!
  email: String!
  employmentStatus: OrganizationEmploymentStatus!
  enrolledSince: DateString
  enrollmentStatus: HsaEnrollmentStatus!
  funded: Boolean
  maskedHsaAccountNumber: String
  name: PersonName!
  payrollToken: JSON
  roles: [OrganizationRole!]!
  token: JSON!
  uid: ID!
}

Fields​

SearchEmployeesResultNode.benefitsEligibilityStatus ● BenefitsEligibilityStatus! non-null enum​

The eligibility status for this employee with respect to Benefit Offerings (can they be enrolled in a Benefit?)

SearchEmployeesResultNode.email ● String! non-null scalar​

The email used when pre-registering the employee.

SearchEmployeesResultNode.employmentStatus ● OrganizationEmploymentStatus! non-null enum​

The employment status of the employee.

SearchEmployeesResultNode.enrolledSince ● DateString scalar​

The date the user enrolled in the HSA, null if the user has not opened an HSA.

SearchEmployeesResultNode.enrollmentStatus ● HsaEnrollmentStatus! non-null enum​

The enrollment status of this employee.

SearchEmployeesResultNode.funded ● Boolean scalar​

True if the user has funded their HSA, false otherwise.

SearchEmployeesResultNode.maskedHsaAccountNumber ● String scalar​

The masked HSA account number, present if the user has an HSA and the Admin/Org supports unmasking HSA account numbers.

SearchEmployeesResultNode.name ● PersonName! non-null object​

The name of the Employee.

SearchEmployeesResultNode.payrollToken ● JSON scalar​

This token is an opaque JSON value that can be passed to payroll-dependent operations for this user. It is present if the user was added via a payroll system or was manually linked to the payroll system and encodes the payroll ID of the user.

SearchEmployeesResultNode.roles ● [OrganizationRole!]! non-null enum​

The roles this employee has.

SearchEmployeesResultNode.token ● JSON! non-null scalar​

This token is an opaque JSON value that can be passed to employee or user-specific operations.

SearchEmployeesResultNode.uid ● ID! non-null scalar​

The user ID of the the employee

Member of​

SearchEmployeesResult object