Constructor Detail

Method Detail

• id

   final String id()

  A stable Finch id (UUID v4) for an individual in the company.

• classCode

   final Optional<String> classCode()

  Worker's compensation classification code for this employee

• department

   final Optional<EmploymentData.EmploymentDataResponseBody.Department> department()

  The department object.

• employment

   final Optional<EmploymentData.EmploymentDataResponseBody.Employment> employment()

  The employment object.

• employmentStatus

   final Optional<EmploymentData.EmploymentDataResponseBody.EmploymentStatus> employmentStatus()

  The detailed employment status of the individual.

• endDate

   final Optional<String> endDate()

• firstName

   final Optional<String> firstName()

  The legal first name of the individual.

• flsaStatus

   final Optional<EmploymentData.EmploymentDataResponseBody.FlsaStatus> flsaStatus()

  The FLSA status of the individual. Available options: exempt, non_exempt, unknown.

• isActive

   final Optional<Boolean> isActive()

  true if the individual an an active employee or contractor at the company.

• lastName

   final Optional<String> lastName()

  The legal last name of the individual.

• latestRehireDate

   final Optional<String> latestRehireDate()

• location

   final Optional<Location> location()

• manager

   final Optional<EmploymentData.EmploymentDataResponseBody.Manager> manager()

  The manager object representing the manager of the individual within the org.

• middleName

   final Optional<String> middleName()

  The legal middle name of the individual.

• startDate

   final Optional<String> startDate()

• title

   final Optional<String> title()

  The current title of the individual.

• customFields

   final Optional<List<EmploymentData.EmploymentDataResponseBody.CustomField>> customFields()

  Custom fields for the individual. These are fields which are defined by the employer in the system. Custom fields are not currently supported for assisted connections.

• income

   final Optional<Income> income()

  The employee's income as reported by the provider. This may not always be annualized income, but may be in units of bi-weekly, semi-monthly, daily, etc, depending on what information the provider returns.

• incomeHistory

   final Optional<List<Income>> incomeHistory()

  The array of income history.

• sourceId

   final Optional<String> sourceId()

  The source system's unique employment identifier for this individual

• workId

  @Deprecated(message = "deprecated") final Optional<String> workId()

  This field is deprecated in favour of source_id

• _id

   final JsonField<String> _id()

  Returns the raw JSON value of id.

  Unlike id, this method doesn't throw if the JSON field has an unexpected type.

• _classCode

   final JsonField<String> _classCode()

  Returns the raw JSON value of classCode.

  Unlike classCode, this method doesn't throw if the JSON field has an unexpected type.

• _department

   final JsonField<EmploymentData.EmploymentDataResponseBody.Department> _department()

  Returns the raw JSON value of department.

  Unlike department, this method doesn't throw if the JSON field has an unexpected type.

• _employment

   final JsonField<EmploymentData.EmploymentDataResponseBody.Employment> _employment()

  Returns the raw JSON value of employment.

  Unlike employment, this method doesn't throw if the JSON field has an unexpected type.

• _employmentStatus

   final JsonField<EmploymentData.EmploymentDataResponseBody.EmploymentStatus> _employmentStatus()

  Returns the raw JSON value of employmentStatus.

  Unlike employmentStatus, this method doesn't throw if the JSON field has an unexpected type.

• _endDate

   final JsonField<String> _endDate()

  Returns the raw JSON value of endDate.

  Unlike endDate, this method doesn't throw if the JSON field has an unexpected type.

• _firstName

   final JsonField<String> _firstName()

  Returns the raw JSON value of firstName.

  Unlike firstName, this method doesn't throw if the JSON field has an unexpected type.

• _flsaStatus

   final JsonField<EmploymentData.EmploymentDataResponseBody.FlsaStatus> _flsaStatus()

  Returns the raw JSON value of flsaStatus.

  Unlike flsaStatus, this method doesn't throw if the JSON field has an unexpected type.

• _isActive

   final JsonField<Boolean> _isActive()

  Returns the raw JSON value of isActive.

  Unlike isActive, this method doesn't throw if the JSON field has an unexpected type.

• _lastName

   final JsonField<String> _lastName()

  Returns the raw JSON value of lastName.

  Unlike lastName, this method doesn't throw if the JSON field has an unexpected type.

• _latestRehireDate

   final JsonField<String> _latestRehireDate()

  Returns the raw JSON value of latestRehireDate.

  Unlike latestRehireDate, this method doesn't throw if the JSON field has an unexpected type.

• _location

   final JsonField<Location> _location()

  Returns the raw JSON value of location.

  Unlike location, this method doesn't throw if the JSON field has an unexpected type.

• _manager

   final JsonField<EmploymentData.EmploymentDataResponseBody.Manager> _manager()

  Returns the raw JSON value of manager.

  Unlike manager, this method doesn't throw if the JSON field has an unexpected type.

• _middleName

   final JsonField<String> _middleName()

  Returns the raw JSON value of middleName.

  Unlike middleName, this method doesn't throw if the JSON field has an unexpected type.

• _startDate

   final JsonField<String> _startDate()

  Returns the raw JSON value of startDate.

  Unlike startDate, this method doesn't throw if the JSON field has an unexpected type.

• _title

   final JsonField<String> _title()

  Returns the raw JSON value of title.

  Unlike title, this method doesn't throw if the JSON field has an unexpected type.

• _customFields

   final JsonField<List<EmploymentData.EmploymentDataResponseBody.CustomField>> _customFields()

  Returns the raw JSON value of customFields.

  Unlike customFields, this method doesn't throw if the JSON field has an unexpected type.

• _income

   final JsonField<Income> _income()

  Returns the raw JSON value of income.

  Unlike income, this method doesn't throw if the JSON field has an unexpected type.

• _incomeHistory

   final JsonField<List<Income>> _incomeHistory()

  Returns the raw JSON value of incomeHistory.

  Unlike incomeHistory, this method doesn't throw if the JSON field has an unexpected type.

• _sourceId

   final JsonField<String> _sourceId()

  Returns the raw JSON value of sourceId.

  Unlike sourceId, this method doesn't throw if the JSON field has an unexpected type.

• _workId

  @Deprecated(message = "deprecated") final JsonField<String> _workId()

  Returns the raw JSON value of workId.

  Unlike workId, this method doesn't throw if the JSON field has an unexpected type.

• _additionalProperties

   final Map<String, JsonValue> _additionalProperties()

• toBuilder

   final EmploymentData.EmploymentDataResponseBody.Builder toBuilder()

• validate

   final EmploymentData.EmploymentDataResponseBody validate()

  Validates that the types of all values in this object match their expected types recursively.

  This method is not forwards compatible with new types from the API for existing fields.

• isValid

   final Boolean isValid()

• equals

   Boolean equals(Object other)

• hashCode

   Integer hashCode()

• toString

   String toString()

• builder

   final static EmploymentData.EmploymentDataResponseBody.Builder builder()

  Returns a mutable builder for constructing an instance of EmploymentDataResponseBody.

  The following fields are required:

  .id()
  .classCode()
  .department()
  .employment()
  .employmentStatus()
  .endDate()
  .firstName()
  .flsaStatus()
  .isActive()
  .lastName()
  .latestRehireDate()
  .location()
  .manager()
  .middleName()
  .startDate()
  .title()