bamboohr.com
    Preparing search index...

    Interface Fields

    interface Fields {
        acaStatus: string;
        acaStatusCategory: string;
        address1: string;
        address2: string;
        age: number;
        bestEmail: string;
        birthday: string;
        bonusAmount: CurrencyField;
        bonusComment: string;
        bonusDate: string;
        bonusReason: string;
        city: string;
        commisionDate: string;
        commissionAmount: CurrencyField;
        commissionComment: string;
        commissionDate: string;
        country: string;
        createdByUserId: number;
        dateOfBirth: string;
        department: string;
        displayName: string;
        division: string;
        eeo: string;
        employeeNumber: string;
        employmentHistoryStatus: string;
        ethnicity: string;
        exempt: string;
        firstName: string;
        flsaCode: string;
        fullName1: string;
        fullName2: string;
        fullName3: string;
        fullName4: string;
        fullName5: string;
        gender: string;
        hireDate: string;
        homeEmail: string;
        homePhone: string;
        id: number;
        includeInPayroll: boolean;
        isPhotoUploaded: boolean;
        jobTitle: string;
        lastChanged: string;
        lastName: string;
        location: string;
        maritalStatus: string;
        middleName: string;
        mobilePhone: string;
        nationalId: string;
        nationality: string;
        nin: string;
        originalHireDate: string;
        paidPer: string;
        payChangeReason: string;
        payFrequency: string;
        payGroup: string;
        payGroupId: number;
        payRate: CurrencyField;
        payRateEffectiveDate: string;
        paySchedule: string;
        payScheduleId: number;
        payType: string;
        preferredName: string;
        sin: string;
        ssn: string;
        standardHoursPerWeek: number;
        state: string;
        stateCode: string;
        status: StatusField;
        supervisor: string;
        supervisorEId: number;
        supervisorEmail: string;
        supervisorId: number;
        terminationDate: string;
        timeTrackingEnabled: boolean;
        workEmail: string;
        workPhone: string;
        workPhoneExtension: string;
        workPhonePlusExtension: string;
        zipcode: string;
    }
    Index

    Properties

    acaStatus acaStatusCategory address1 address2 age bestEmail birthday bonusAmount bonusComment bonusDate bonusReason city commisionDate commissionAmount commissionComment commissionDate country createdByUserId dateOfBirth department displayName division eeo employeeNumber employmentHistoryStatus ethnicity exempt firstName flsaCode fullName1 fullName2 fullName3 fullName4 fullName5 gender hireDate homeEmail homePhone id includeInPayroll isPhotoUploaded jobTitle lastChanged lastName location maritalStatus middleName mobilePhone nationalId nationality nin originalHireDate paidPer payChangeReason payFrequency payGroup payGroupId payRate payRateEffectiveDate paySchedule payScheduleId payType preferredName sin ssn standardHoursPerWeek state stateCode status supervisor supervisorEId supervisorEmail supervisorId terminationDate timeTrackingEnabled workEmail workPhone workPhoneExtension workPhonePlusExtension zipcode

    Properties

    acaStatus: string

    please use ‘acaStatusCategory’

    acaStatusCategory: string

    The employee's ACA (Affordable Care Act) status. This field can not be updated directly but is calculated based on mappings for employment statuses found on the employmentStatus table. Options are: contractor, full-time, intern-eligible, intern-ineligible, part-time-eligible, part-time-ineligible, and seasonal.

    address1: string

    The employee's first address line.

    address2: string

    The employee's second address line.

    age: number

    The employee's age. To change age, update dateOfBirth field.

    bestEmail: string

    The employee's work email if set, otherwise their home email.

    birthday: string

    The employee's month and day of birth. To change birthday, update dateOfBirth field.

    bonusAmount: CurrencyField

    The amount of the most recent bonus.

    bonusComment: string

    Comment about the most recent bonus.

    bonusDate: string

    The date of the last bonus.

    bonusReason: string

    The reason for the most recent bonus.

    city: string

    The employee's city.

    commisionDate: string

    This field name contains a typo, and exists for backwards compatibility.

    commissionAmount: CurrencyField

    The amount of the most recent commission.

    commissionComment: string

    Comment about the most recent commission.

    commissionDate: string

    The date of the last commission.

    country: string

    The employee's country.

    createdByUserId: number

    The id of the user who created the employee. Read only. May be null if employee was created before the release of this field.

    dateOfBirth: string

    The date the employee was born.

    department: string

    The employee's *current department.

    displayName: string

    The employee's name displayed in a format configured by the user. Read only.

    division: string

    The employee's *current division.

    eeo: string

    The employee's EEO job category. These are defined by the U.S. Equal Employment Opportunity Commission.

    employeeNumber: string

    Employee number (assigned by your company).

    employmentHistoryStatus: string

    The employee's *current employment status. Options are customized by account. Read-only starting with version 1.1; update using the employmentStatus table.

    ethnicity: string

    The employee's ethnicity.

    exempt: string

    The FLSA Overtime Status (Exempt or Non-exempt).

    firstName: string

    The employee's first name.

    flsaCode: string

    Deprecated please use 'exempt'

    fullName1: string

    The employee's first and last name. (e.g., John Doe). Read only.

    fullName2: string

    The employee's last and first name. (e.g., Doe, John). Read only.

    fullName3: string

    The employee's full name and their preferred name. (e.g., Doe, John Quentin (JDog)). Read only.

    fullName4: string

    The employee's full name without their preferred name, last name first. (e.g., Doe, John Quentin). Read only.

    fullName5: string

    The employee's full name without their preferred name, first name first. (e.g., John Quentin Doe). Read only.

    gender: string

    The employee's gender (Male or Female).

    hireDate: string

    The date the employee was hired.

    homeEmail: string

    The employee's home email address.

    homePhone: string

    The employee's home phone number.

    id: number

    The employee ID automatically assigned by BambooHR. Read only.

    includeInPayroll: boolean

    Should employee be included in payroll (Yes or No)

    isPhotoUploaded: boolean

    Whether a photo has been uploaded for the employee. Read only.

    jobTitle: string

    The current value of the employee's job title, updating this field will create a new row in position history.

    lastChanged: string

    The date and time that the employee record was last changed.

    lastName: string

    The employee's last name.

    location: string

    The employee's current location.

    maritalStatus: string

    The employee's marital status (Single, Married, or Domestic Partnership).

    middleName: string

    The employee's middle name.

    mobilePhone: string

    The employee's mobile phone number.

    nationalId: string

    The employee's National ID number

    nationality: string

    The employee's nationality

    nin: string

    The employee's NIN number

    originalHireDate: string

    The date the employee was originally hired. Available starting with version 1.1.

    paidPer: string

    The employee's current pay per. ie: "Hour", "Day", "Week", "Month", "Quarter", "Year".

    payChangeReason: string

    The reason for the employee's last pay rate change.

    payFrequency: string

    The employee's current pay frequency. ie: "Weekly", "Every other week", "Twice a month", "Monthly", "Quarterly", "Twice a year", or "Yearly"

    payGroup: string

    The custom pay group that the employee belongs to.

    payGroupId: number

    The ID value corresponding to the pay group that an employee belongs to.

    payRate: CurrencyField

    The employee's current pay rate (e.g., $8.25).

    payRateEffectiveDate: string

    The day the most recent change was made.

    paySchedule: string

    The employee's current pay schedule.

    payScheduleId: number

    The ID value corresponding to the pay schedule that an employee belongs to.

    payType: string

    The employee's current pay type. ie: "hourly","salary","commission","exception hourly","monthly","weekly","piece rate","contract","daily","pro rata".

    preferredName: string

    The employee's preferred name.

    sin: string

    The employee's Canadian Social Insurance Number.

    ssn: string

    The employee's Social Security number.

    standardHoursPerWeek: number

    The number of hours the employee works in a standard week.

    state: string

    The employee's state/province.

    stateCode: string

    The 2 character abbreviation for the employee's state (US only). Read only.

    status: StatusField

    The employee's employee status (Active or Inactive).

    supervisor: string

    The employee’s current supervisor. Read only.

    supervisorEId: number

    The ID of the employee's current supervisor. Read only.

    supervisorEmail: string

    The email of the employee's current supervisor. Read only.

    supervisorId: number

    The 'employeeNumber' of the employee's current supervisor. Read only.

    terminationDate: string

    The date the employee was terminated. Read-only starting with version 1.1; update using the employmentStatus table.

    timeTrackingEnabled: boolean

    Should time tracking be enabled for the employee (Yes or No)

    workEmail: string

    The employee's work email address.

    workPhone: string

    The employee's work phone number, without extension.

    workPhoneExtension: string

    The employee's work phone extension (if any).

    workPhonePlusExtension: string

    The employee's work phone and extension. Read only

    zipcode: string

    The employee's ZIP code.

    Settings

    Member Visibility

    On This Page

    Properties
    acaStatusacaStatusCategoryaddress1address2agebestEmailbirthdaybonusAmountbonusCommentbonusDatebonusReasoncitycommisionDatecommissionAmountcommissionCommentcommissionDatecountrycreatedByUserIddateOfBirthdepartmentdisplayNamedivisioneeoemployeeNumberemploymentHistoryStatusethnicityexemptfirstNameflsaCodefullName1fullName2fullName3fullName4fullName5genderhireDatehomeEmailhomePhoneidincludeInPayrollisPhotoUploadedjobTitlelastChangedlastNamelocationmaritalStatusmiddleNamemobilePhonenationalIdnationalityninoriginalHireDatepaidPerpayChangeReasonpayFrequencypayGrouppayGroupIdpayRatepayRateEffectiveDatepaySchedulepayScheduleIdpayTypepreferredNamesinssnstandardHoursPerWeekstatestateCodestatussupervisorsupervisorEIdsupervisorEmailsupervisorIdterminationDatetimeTrackingEnabledworkEmailworkPhoneworkPhoneExtensionworkPhonePlusExtensionzipcode