This is a list of all fields Donut requests from your HRIS.
💡 Please note: some HRIS systems / Integrations don’t provide or support all of the fields listed below. To determine which fields from this list are supported for your specific HRIS, you can check out Merge's article here.
💡 For BambooHR users, we've included specific permission recommendations at the end of this document → click here to skip to that section.
| Field | Description |
Company | Name | The company's display name |
| EINS | The company's Employer Identification Numbers |
| Legal name | The company's legal name |
| Modified at | This is the date/ time that this object was last updated by Merge |
Employee | Avatar | The URL of the employee's avatar image |
| Company | The ID of the employee's company |
| Custom fields | Custom fields configured for a given model |
| Date of birth | The employee's date of birth |
| display full name | The employee's full name, to use for display purposes. If a preferred first name is available, the full name will include the preferred first name. |
| Employee number | The employee's number that appears in the third-party integration's UI |
| Employment status | The employment status of the employee. Possible values include: ACTIVE, PENDING, INACTIVE. In cases where there is no clear mapping, the original value passed through will be returned. |
| Employments | Array of Employment IDs for this Employee |
| First name | The employee's first name |
| Group(s) | Groups the employee is associated with such as department, team or business unit |
| Hire date | The date that the employee was hired, usually the day that an offer letter is signed. If an employee has multiple hire dates from previous employments, this represents the most recent hire date. Note: If you're looking for the employee's start date, refer to the start_date field. |
| Last name | The employee's last name |
| Manager | The employee ID of the employee's manager |
| Modified at | This is the date/time that this object was last updated by Merge |
| Personal email | The employee's personal email |
| Remote created at | When the third party's employee was created |
| Start date | The date that the employee started working. If an employee was rehired, the most recent start date will be returned |
| Team | The employee's team |
| Termination date | The employee's termination date |
| Username | The employee's username that appears in the remote UI |
| Work email | The employee's work email |
| Work location | The employee's work address |
Employment | Effective date | The position's effective date. |
| Employee | The employee holding this position. |
| Employment type | The position's type of employment. Possible values include: FULL_TIME, PART_TIME, INTERN, CONTRACTOR, FREELANCE. In cases where there is no clear mapping, the original value passed through will be returned. |
| Fisa status | The position's FLSA status. Possible values include: EXEMPT, SALARIED_NONEXEMPT, NONEXEMPT, OWNER. In cases where there is no clear mapping, the original value passed through will be returned. |
| Job title | The position's title |
| Modified at | This is the date/time that this object was last updated by Merge |
Group | Modified at | This is the date/time that this object was last updated by Merge |
| Name | The group name |
| Parent group | The parent group for this group |
| Type | The group type Possible values include: TEAM, DEPARTMENT, COST_CENTER, BUSINESS_UNIT, GROUP. In cases where there is no clear mapping, the original value passed through will be returned. |
Location | City | The location's city |
| Country | The location's country. Possible values include: AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BQ, BA, BW, BV, BR, IO, BN, BG, BF, BI, CV, KH, CM, CA, KY, CF, TD, CL, CN, CX, CC, CO, KM, CG, CD, CK, CR, CI, HR, CU, CW, CY, CZ, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, SZ, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, NC, NZ, NI, NE, NG, NU, NF, KP, MK, MP, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RE, RO, RU, RW, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, GS, KR, SS, ES, LK, SD, SR, SJ, SE, CH, SY, TW, TJ, TZ, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, UM, US, UY, UZ, VU, VE, VN, VG, VI, WF, EH, YE, ZM, ZW. In cases where there is no clear mapping, the original value passed through will be returned. |
| Location type | The location's type. Can be either WORK or HOME Possible values include: HOME, WORK. In cases where there is no clear mapping, the original value passed through will be returned. |
| Modified at | This is the datetime that this object was last updated by Merge |
| Name | The location's name. |
| State | The location's state. Represents a region if outside of the US. |
| Zip code | The location's zip code or postal code. |
|
|
|
| Modified at | This is the datetime that this object was last updated by Merge |
| Name | The team's name. |
| Parent team | The team's parent team. |
Note: The following fields are requested by Donut, but not currently being used in the product. In the future, we see potential use for this data, such as automatically pausing messages and Intros when employees are on vacation.
Time-Off | Amount | The time off quantity measured by the prescribed “units”. |
| Approver | The Merge ID of the employee with the ability to approve the time off request. |
| Employee | The employee requesting time off. |
| Employee note | The employee note for this time off request. |
| End time | The day and time of the end of the time requested off. |
| Modified at | This is the date/time that this object was last updated by Merge |
| Request type | The type of time off request. Possible values include: VACATION, SICK, PERSONAL, JURY_DUTY, VOLUNTEER, BEREAVEMENT. In cases where there is no clear mapping, the original value passed through will be returned. |
| Start time | The day and time of the start of the time requested off. |
| Status | The status of this time off request. Possible values include: REQUESTED, APPROVED, DECLINED, CANCELLED, DELETED. In cases where there is no clear mapping, the original value passed through will be returned. |
| Units | The measurement that the third-party integration uses to count time requested. Possible values include: HOURS, DAYS. In cases where there is no clear mapping, the original value passed through will be returned. |
Time-Off Balance | Balance | The current remaining PTO balance, always measured in terms of hours |
| Employee | The employee the balance belongs to |
| Modified at | This is the date/time that this object was last updated by Merge |
| Policy type | The policy type of this time off balance. Possible values include: VACATION, SICK, PERSONAL, JURY_DUTY, VOLUNTEER, BEREAVEMENT. In cases where there is no clear mapping, the original value passed through will be returned. |
| Used | The amount of PTO used in terms of hours |
BambooHR Specific Permissions and Fields
For customers using BambooHR, it's possible to set up a user with restricted permissions to control access to sensitive fields. Here's a list of the minimal BambooHR permissions needed for Donut to import new hires into Journeys and Celebrations:
Section | Fields |
Basic Information | Status |
| Employee Number |
| First Name |
| Last Name |
| Birth Date |
Contact | Work Email |
| Home Email |
Job section (View access required) | Hire Date |
| Original Hire Date |
| Direct Reports |
| Team |
| Employment Status |
| Employment Status Date |
| Termination Type |
| Job Information |
| Job Title |
| Department |
| Division |
| Location |
| Job Information Date |
| Reporting To |
Important Note: Sensitive fields like SSN, phone numbers, and gender are not required and can be set to "No Access".