> ## Documentation Index
> Fetch the complete documentation index at: https://docs.kombo.dev/llms.txt
> Use this file to discover all available pages before exploring further.
# Oracle HCM HRIS Integration
> Oracle HCM connector for Kombo's HRIS API
This connector is in open beta. You can freely enable it in your account.
The Oracle HCM HRIS integration allows you to sync HRIS data between Oracle HCM and your application through Kombo's unified API. The tool slug for this connector is `oraclehcm`.
## Guides and Resources
Step-by-step instructions to connect your Oracle HCM account to Kombo.
## Supported Features & Coverage
| Field | Notes |
| ------------------- | ----- |
| id | |
| remote\_id | |
| changed\_at | |
| remote\_deleted\_at | |
| name | |
| remote\_data | |
| Field | Notes |
| ------------------- | ----- |
| id | |
| remote\_id | |
| changed\_at | |
| remote\_deleted\_at | |
| name | |
| address | |
| remote\_data | |
| Field | Notes |
| --------------------- | ----- |
| id | |
| remote\_id | |
| changed\_at | |
| remote\_deleted\_at | |
| employee\_number | |
| first\_name | |
| last\_name | |
| nationality | |
| display\_full\_name | |
| job\_title | |
| work\_email | |
| personal\_email | |
| mobile\_phone\_number | |
| ssn | |
| gender | |
| ethnicity | |
| marital\_status | |
| employment\_status | |
| employment\_type | |
| work\_location\_id | |
| legal\_entity\_id | |
| manager\_id | |
| home\_address | |
| date\_of\_birth | |
| start\_date | |
| termination\_date | |
| remote\_created\_at | |
| custom\_fields | |
| integration\_fields | |
| remote\_data | |
| Field | Notes |
| ----------------------- | ----- |
| id | |
| remote\_id | |
| changed\_at | |
| remote\_deleted\_at | |
| name | |
| unit | |
| half\_days\_supported | |
| exact\_times\_supported | |
| remote\_data | |
| Field | Notes |
| ------------------- | ----- |
| id | |
| remote\_id | |
| changed\_at | |
| remote\_deleted\_at | |
| employee\_id | |
| start\_date | |
| end\_date | |
| start\_time | |
| end\_time | |
| amount | |
| unit | |
| status | |
| employee\_note | |
| type\_id | |
| remote\_data | |
| Field | Notes |
| ------------------- | ----- |
| id | |
| remote\_id | |
| changed\_at | |
| remote\_deleted\_at | |
| employee\_id | |
| job\_title | |
| pay\_rate | |
| pay\_period | |
| employment\_type | |
| pay\_currency | |
| effective\_date | |
| Field | Notes |
| ------------------- | ----- |
| id | |
| remote\_id | |
| changed\_at | |
| remote\_deleted\_at | |
| name | |
| type | |
| remote\_data | |
| Field | Notes |
| ------------------- | ----- |
| id | |
| remote\_id | |
| changed\_at | |
| remote\_deleted\_at | |
| employee\_id | |
| started\_at | |
| ended\_at | |
| payable\_hours | |
| approval\_status | |
| comment | |
| custom\_fields | |
| integration\_fields | |
| remote\_data | |
| Field | Notes |
| ------------------- | ----- |
| id | |
| remote\_id | |
| changed\_at | |
| remote\_deleted\_at | |
| review\_cycle\_id | |
| reviewee\_id | |
| reviewer\_id | |
| type | |
| summary\_comment | |
| summary\_rating | |
| remote\_data | |
| Field | Notes |
| --------------------------- | ----- |
| id | |
| remote\_id | |
| changed\_at | |
| remote\_deleted\_at | |
| name | |
| review\_period\_start\_date | |
| remote\_data | |
| Field | Notes |
| ------------------- | ----- |
| employee\_id | |
| team\_id | |
| id | |
| changed\_at | |
| remote\_deleted\_at | |
Oracle HCM requires `legal_entity_id`, `start_date` and `nationality` when creating employees. Please provide it in the request body. Oracle HCM requires a business unit and a department to be assigned when creating employees. Please provide it in the request body via the `remote_fields`.
| Input Field | Notes |
| ----------------------- | ----- |
| first\_name | |
| last\_name | |
| work\_email | |
| job\_title | |
| home\_address.street\_1 | |
| home\_address.street\_2 | |
| home\_address.city | |
| home\_address.state | |
| home\_address.zip\_code | |
| home\_address.country | |
| date\_of\_birth | |
| mobile\_phone\_number | |
| nationality | |
| start\_date | |
| legal\_entity\_id | |
| location\_id | |
For detailed information about [creating employees with form](/hris/implementation-guide/create-employee), please see the [**Create Employee with Form** tab](#create-employee-with-form) above.
| Input Field | Notes |
| -------------------- | ----- |
| staffing\_entity\_id | |
| properties | |
| Feature | Notes |
| ---------------- | ----- |
| Connection Guide | |
| API Passthrough | |
| Scope Testing | |
| Group Types | |
| TEAM | |
| DEPARTMENT | |
| COST\_CENTER | |
Some **required** form fields are referencing the following data models:
* Groups
* Legal Entities
Additionally, there are some **optional** form fields that reference:
* Employees
Consider enabling these in your [scope configuration](/hris/features/scopes).
**Correspondence Language**
Preferred language for communication. Valid values are defined in the commonLookupsLOV.
**Blood Type**
Blood type of the person. Valid values are defined in the commonLookupsLOV.
**Date of Birth**
Date of birth of the person.
**Date of Death**
Date of death of the person.
**Country of Birth**
Country of birth of the person. Valid values are defined in the hcmCountriesLOV.
**Region of Birth**
Region of birth of the person.
**Town of Birth**
Town of birth of the person.
**Applicant Number**
Applicant number in the external application.
**Addresses**
The addresses resource is a child of the workers resource. It provides all the addresses of a worker as of the specified date. By default, the current date is retained.
**Address Line 1**
First line of the primary mail address.
**Address Line 2**
Second line of the primary mail address.
**Address Line 3**
Third line of the primary mail address.
**Address Line 4**
Fourth line of the primary mail address.
**Town or City**
Town or city in which the address is located.
**Region 1**
Primary region in which the address is located.
**Region 2**
Secondary region within the primary region.
**Region 3**
Additional secondary region within the primary region.
Country in which the address is located. Valid values are defined in the hcmCountriesLov.
**Postal Code**
Postal code of the primary mail address.
**Long Postal Code**
Long postal code of the primary mail address.
**Additional Address Attribute 1**
Additional address column used by localizations.
**Additional Address Attribute 2**
Additional address column used by localizations.
**Additional Address Attribute 3**
Additional address column used by localizations.
**Additional Address Attribute 4**
Additional address column used by localizations.
**Additional Address Attribute 5**
Additional address column used by localizations.
Building information associated with the address.
**Floor Number**
Floor number associated with the building.
**Type**
Type of address. Valid values are defined in the commonLookupsLOV.
**Validation Status Code**
Level of accuracy of an address, as determined by an address provider.
Company that has validated the address.
Distance between the prime meridian and an address located to its east or west, expressed in degrees and minutes.
Distance between the equator and an address located to its north or south, expressed in degrees and minutes.
**Validate Address Flag**
Indicates whether the address is sent for validation. Valid values are true and false. The default value is false.
**Citizenships**
The citizenships resource is a child of the workers resource. It provides all the citizenships of a worker as of the specified date. By default, the current date is retained.
Citizenship legislation code. Valid values are defined in the hcmCountriesLov.
**From Date**
Date from when the citizenship is valid.
**To Date**
Date until when the citizenship is valid.
**Citizenship Status**
Status of the citizenship. Valid values are defined in the commonLookupsLOV.
**Disabilities**
The disabilities resource is a child of the workers resource. It provides all the worker disabilities as of the specified date. By default, the current date is retained.
**Country**
Legislation code for the disability. Valid values are defined in the hcmCountriesLov.
**FTE**
Person's full time equivalency.
Status of the person's disability.
Reason for the person's disability.
Extent to which the disability impacts the person's abilities.
**Self-Disclosed Disability**
Type of disability disclosed by the worker. Used explicitly for the Japanese, United Kingdom, and United States legislation.
**Disclosure Date**
Date on which the disability has been disclosed by the worker. Used explicitly for the Japanese, United Kingdom, and United States legislation.
**Reasonable Accommodation Request**
Request for accommodation.
**Registration Date**
Date on which the disability was registered with the disability organization.
**Expiration Date**
Expiration date of the disability registration.
**Registration ID**
Identification detail given to the person by the disability organization.
**Disability Organization**
Unique identifier of the organization.
Description of the person's disability.
**Work Restrictions**
Details of any work restrictions due to the disability.
**Attachments**
The attachments resource is used to view, create, and update attachments.
**Type**
A value that indicates the data type.
**File Name**
The file name of the attachment.
**Dm Folder Path**
The folder path from which the attachment is created.
**Dm Document Id**
The document ID from which the attachment is created.
**Dm Version Number**
The document version number from which the attachment is created.
The URL of a web page type attachment.
**Category**
The category of the attachment.
The URI of a Topology Manager type attachment.
**File Url**
The URI of the file.
**Uploaded Text**
The text content for a new text attachment.
**Uploaded File Content Type**
The content type of the attachment.
**File Size**
The size of the attachment file.
**Uploaded File Name**
The name to assign to a new attachment file.
**Shared**
Indicates whether the attachment is shared
The title of the attachment.
The description of the attachment.
**Error Status Code**
The error code, if any, for the attachment.
**Error Status Message**
The error message, if any, for the attachment.
**Asynchronous Upload Tracker Id**
Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.
JSON object represented as a string containing information used to programmatically retrieve a file attachment.
**Post Processing Action**
The name of the action that can be performed after an attachment is uploaded.
**Driver Licenses**
The driverLicenses resource is a child of the workers resource. It provides all the driver licenses of a worker as of the specified date. By default, the current date is retained.
**License Type**
Type of license. Valid values are defined in the commonLookupsLOV.
**Issuing Country**
Country in which the driver's license was issued. Valid values are defined in the hcmCountriesLov.
**License Number**
Driver's license number.
**Issuing Authority**
Issuing authority of the driver's license.
**Place of Issue**
Location where the driver's license was issued.
**From Date**
Date from when the driver's license is valid.
**To Date**
Date until when the driver's license is valid.
**Number of Points**
Number of penalty points on the license.
Number of violations on the license.
**License Suspended**
Indicates whether the driver's license is suspended.
**Suspended-from Date**
Start date of suspension period, if any.
**Suspension-to Date**
End date of suspension period, if any.
**Emails**
The emails resource is a child of the workers resource. It provides all the emails of a worker as of the specified date. By default, the current date is retained.
**Type**
Type of email such as work, personal, and so on. Valid values are defined in the commonLookupsLOV.
**Email**
Email address of the person.
**To Date**
Date until when the email address is valid.
**Ethnicities**
The ethnicities resource is a child of the workers resource. It provides all the ethnicities of a worker as of the specified date. By default, the current date is retained.
**Primary**
Indicates whether the ethnicity is the primary ethnicity record for the person.
**Country**
Legislation code of the ethnicity. Valid values are defined in the hcmCountriesLov.
Person's ethnicity. Valid values are defined in the commonLookupsLOV.
**External Identifiers**
The externalIdentifiers resource is a child of the workers resource. It provides all the external identifiers of a worker as of the specified date. By default, the current date is retained.
**Sequence**
Sequence of the external identifier.
**Identifier**
External identifier number.
**Identifier Type**
Type of external identifier, such as Third-Party Payroll ID. Valid values are defined in the commonLookupsLOV.
**Assignment ID**
Unique identifier of the assignment to which this external identifier relates.
**Identifier Comments**
Comments for the external identifier.
**Assignment Number**
Assignment number to which the external identifier belongs.
**Legislative Information**
The legislativeInfo resource is a child of the workers resource. It provides the legislative information of a worker as of the specified date. By default, the current date is retained.
**Country**
Legislation code. Valid values are defined in the hcmCountriesLov.
Gender of the person. Valid values are defined in the commonLookupsLOV.
**Marital Status**
Marital status of the person. Valid values are defined in the commonLookupsLOV.
**Marital Status Change Date**
Date from when the marital status came into effect.
**Highest Education Level**
Legislation-specific value that identifies the person's highest education level. Valid values are defined in the commonLookupsLOV.
**Messages**
The messages resource is a child of the workers resource. It provides all the available messages of a worker.
**Notification**
Content of the message notification.
**Names**
The names resource is a child of the workers resource. It provides all the names of a worker as of the specified date. By default, the current date is retained.
**Country**
Legislation code. Valid values are defined in the hcmCountriesLov.
**Last Name**
Person's last name.
**First Name**
Person's first name.
Person salutation such as Mr., Ms., and so on. Valid values are defined in the commonLookupsLOV.
**Prefix**
Part of the name added before a person's first name.
Part of the name appended to a person's last name such as Jr., III, and so on.
**Middle Names**
Person's middle name.
Higher qualification appended to a person's name such as PhD.
**Known As**
Person's preferred name.
**Previous Last Name**
Person's previous last name.
**Military Rank**
Person's military rank.
**Name Information 1**
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
**Name Information 2**
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
**Name Information 3**
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
**Name Information 4**
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
**Name Information 5**
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
**Name Information 6**
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
**Name Information 7**
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
**Name Information 8**
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
**Name Information 9**
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
**Name Information 10**
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
**Name Information 11**
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
**Name Information 12**
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
**Name Information 13**
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
**Name Information 14**
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
**Name Information 15**
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
**Name Information 16**
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
**Name Information 17**
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
**Name Information 18**
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
**Name Information 19**
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
**Name Information 20**
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
**Name Information 21**
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
**Name Information 22**
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
**Name Information 23**
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
**Name Information 24**
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
**Name Information 25**
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
**Name Information 26**
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
**Name Information 27**
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
**Name Information 28**
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
**Name Information 29**
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
**Name Information 30**
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
**Country**
Legislation code of the local language. Valid values are defined in the hcmCountriesLov.
**Last Name**
Person's last name in local language.
**First Name**
Person's first name in local language.
**Title**
Person's salutation such as Mr., Ms., and so on in local language. Valid values are defined in the commonLookupsLOV.
**Prefix**
Part of the name added before a person's first name in local language.
**Suffix**
Part of the name appended to a person's last name such as Jr., III, and so on, in local language.
**Middle Names**
Person's middle name in local language.
**Honors**
Higher qualification appended to a person's name such as PhD in local language.
**Known As**
Person's preferred name in local language.
**Previous Last Name**
Person's previous last name in local language.
**Military Rank**
Person's military rank in local language.
**Local-Name Language**
Local language of the name. This isn't required for global names. If you're creating a local name, you must provide the language code.
**Name Information 1**
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
**Name Information 2**
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
**Name Information 3**
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
**Name Information 4**
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
**Name Information 5**
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
**Name Information 6**
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
**Name Information 7**
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
**Name Information 8**
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
**Name Information 9**
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
**Name Information 10**
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
**Name Information 11**
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
**Name Information 12**
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
**Name Information 13**
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
**Name Information 14**
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
**Name Information 15**
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
**Name Information 16**
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
**Name Information 17**
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
**Name Information 18**
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
**Name Information 19**
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
**Name Information 20**
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
**Name Information 21**
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
**Name Information 22**
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
**Name Information 23**
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
**Name Information 24**
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
**Name Information 25**
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
**Name Information 26**
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
**Name Information 27**
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
**Name Information 28**
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
**Name Information 29**
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
**Name Information 30**
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
**National Identifiers**
The nationalIdentifiers resource is a child of the workers resource. It provides all the national identifiers of a worker as of the specified date. By default, the current date is retained.
**Country**
Legislation code of the national identifier. Valid values are defined in the hcmCountriesLov.
**National ID Type**
Type of national identifier. Valid values are defined in the commonLookupsLOV.
**National ID**
National identification number.
**Issue Date**
Issue date of the national identifier.
**Expiration Date**
Expiration date of the national identifier.
**Place of Issue**
Place where the national identifier was issued.
**Other Communication Accounts**
The otherCommunicationAccounts resource is a child of the workers resource. It provides all the other communication accounts of a worker as of the specified date. By default, the current date is retained.
Provider of the account such as Facebook and Twitter. Valid values are defined in the commonLookupsLOV.
**Account Name**
Name of the account.
**To Date**
End date of the account.
**Passports**
The passports resource is a child of the workers resource. It provides all worker of a worker as of the specified date. By default, the current date is retained.
**Issuing Country**
Country in which the passport was issued. Valid values are defined in the hcmCountriesLov.
**Type**
Type or category of the passport. Valid values are defined in the commonLookupsLOV.
**Number**
Passport number of the person.
**Issuing Authority**
Issuing authority for the passport.
**Issue Date**
Issue date of the passport.
**Expiration Date**
Expiration date of the passport.
**Issuing Location**
Location where the passport was issued.
Profession of the passport holder.
**Phones**
The phones resource is a child of the workers resource. It provides all the phones of a worker as of the specified date. By default, the current date is retained.
**Type**
Type of phone such as Work, Home, and so on. Valid values are defined in the commonLookupsLOV.
**Country**
Phone legislation code.
**Country Code**
Country code of the phone number. Valid values are defined in the hcmCountriesLov.
**Area Code**
Area code of the phone number.
**Number**
Phone number of various phone types such as Work, Home, and so on.
Extension number for the phone.
**To Date**
Date until when the phone number is valid.
Time of day when a person can be reached at a specific phone number.
**Photos**
The photo resource is a child of the workers resource. It provides the all photos of a worker as of the specified date. By default, the current date is retained.
**Primary**
Indicates whether the image is primary.
**Type**
Type of photo such as Profile or Cover. Valid values are defined in the commonLookupsLOV.
**Photo Name**
Name of the image file.
**Religions**
The religions resource is a child of the workers resource. It provides all the religions of a worker as of the specified date. By default, the current date is retained.
**Country**
Religion legislation code. Valid values are defined in the hcmCountriesLov.
**Primary**
Indicates whether the religion is the person's primary religion for this legislation.
Religion of the person. Valid values are defined in the commonLookupsLOV.
**Visa Permits**
The visasPermits resource is a child of the workers resource. It provides all the visas and permits of a worker as of the specified date. By default, the current date is retained.
**Issuing Country**
Country in which the visa or permit was issued. Valid values are defined in the hcmCountriesLov.
**Type**
Visa or permit type. Valid values are defined in the commonLookupsLOV.
**Category**
Category of the visa or permit. Valid values are defined in the commonLookupsLOV.
**Number**
Visa or permit number.
**Status**
Indicates if the visa or permit is current. Valid values are defined in the commonLookupsLOV.
**Issuing Authority**
Issuing authority for the visa or permit.
**Place of Issue**
Location where the visa or permit was issued.
**Issue Date**
Date of issue of the visa or permit.
**Entry Date**
Entry date of the person into the country.
**Expiration Date**
Expiration date of the visa or permit.
**Status Change Date**
Date from when the permit status is effective.
Profession of the visa or permit holder.
**Work Relationships**
The workRelationships resource is a child of the workers resource. It provides all the work relationships of a worker as of the specified date. By default, the current date is retained.
**Legal Entity ID**
Unique identifier for the legal entity of the work relationship.
References `/v1/hris/legal-entities?remote_model=legal_entity`
**Worker Type**
Worker type for the period of service such as Employee (E), Contingent Worker (C), Pending Worker (P), or Nonworker (N). Valid values are defined in the commonLookupsLOV.
**Primary**
Indicates whether the work relationship is the primary work relationship for the worker. Valid values are Yes and No.
**Seniority Date**
Date on which a person's legal-employer service of a particular type, such as employee, contingent worker, or nonworker, is based.
**Enterprise Seniority Date**
Adjusted service date. For example, for a rehire who was part of an acquisition, all plans might use the original hire date if rehired within 90 days of termination. However, a 401k plan might use the adjusted service date which was originally populated upon acquisition.
**On Military Service**
Indicates whether the person is on military service.
**Worker Number**
Unique identifier for the worker.
**Include for Automatic Conversion**
Indicates whether the pending worker is ready to be converted to the proposed worker type.
**Projected Termination Date**
Projected last date of employment for the period of service.
**Assignments**
The assignments resource is a child of the workRelationships resource. It provides all the worker assignments as of the specified date. By default, the current date is retained.
**Assignment Number**
Unique identifier for the assignment.
**Business Title**
Business title of the worker assignment.
**Action Code**
Action being performed for this assignment, such as, Hire, Add Pending Worker, Manager Change and so on. Valid values are defined in the actionsLOV.
**Reason Code**
Reason for the action being performed on the record. Valid values are defined in the actionReasonsLOV.
**Business Unit ID**
Unique identifier for the business unit of the assignment.
References `/v1/hris/groups?types=TEAM`
**Business Unit**
Name of the business unit for the worker assignment. Valid values are defined in the hcmBusinesUnitsLOV.
**Assignment Status Code**
Code for the assignment status type.
**User Person Type ID**
Unique identifier for the user person type.
**User Person Type**
User-defined value that identifies the person type such as employee or contingent worker. Valid values are defined in the personTypesLOV.
**Proposed User Person Type ID**
Unique identifier for the proposed user person type.
**Proposed Person Type**
Code of the proposed user person type. Valid values are defined in the personTypesLOV.
**Projected Start Date**
Expected start date for applicants. This value is required for pending workers.
**Projected End Date**
Date when the assignment is expected to end.
**Primary Assignment**
Indicates whether the current assignment is primary for the work relationship. Valid values are true or false.
**Position ID**
Unique identifier for the worker's position.
**Position Code**
Code for the worker's position.
**Synchronize from Position**
Indicates whether attributes from the position can be overridden on the assignment when using position synchronization. Valid values are true or false.
**Job ID**
Unique identifier for the worker's job.
**Job Code**
Code for the worker's job. Valid values are defined in the jobsLov.
**Grade ID**
Unique identifier for the worker's grade.
**Grade Code**
Code of the assignment grade. Valid values are defined in the gradesLov.
**Grade Ladder ID**
Unique identifier for the grade ladder used for benefits.
**Grade Ladder**
Name of the grade ladder used for benefits. Valid values are defined in the gradeLaddersLov.
**Include in Grade Step Progression**
Indicates whether the assignment is eligible for grade-step progression. Valid values are true or false.
**Department ID**
Unique identifier for the worker's department.
**Department**
Name of the department for the worker assignment. Valid values are defined in the departmentsLov.
**Reporting Establishment ID**
Unique identifier for the reporting establishment.
**Reporting Establishment**
Name of the reporting establishment. Valid values are defined in the reportingEstablishmentsLOV.
**Location ID**
Unique identifier for the worker's location.
**Location Code**
Code for the worker's location.
**Working at Home**
Indicates whether the worker works at home for the assignment.
**Assignment Category**
User-defined category for the assignment such as full-time, permanent, and so on. Valid values are defined in the commonLookupsLOV.
**Worker Category**
Category of the worker such as blue collar, civil servant, and so on. Valid values are defined in the commonLookupsLOV.
**Regular or Temporary**
Indicates whether the worker is regular or temporary. Valid values are defined in the commonLookupsLOV.
**Full Time or Part Time**
Indicates whether the worker works full-time or part-time. Valid values are defined in the commonLookupsLOV.
**Working as a Manager**
Indicates whether the worker is a manager.
**Hourly Paid or Salaried**
Identifies whether the assignment is paid by the hour or by a salary. Either maintained at the assignment level or employment or placement terms but not both. Valid values are defined in the commonLookupsLOV.
**Working Hours**
Normal working hours, such as 37.5. Specify with the Frequency attribute.
Frequency of normal working hours such as week or month. Specify with the NormalHours attribute. Valid values are defined in the commonLookupsLOV.
**Start Time**
Normal start time for the working day.
**End Time**
Normal end time for the working day.
**Basis for Seniority Calculation**
Basis for calculating seniority for the person. Valid values are defined in the commonLookupsLOV.
**Probation Period**
Duration of the probation period. Specify with the ProbationPeriodUnit attribute.
**Probation Unit**
Unit of measure for the probation period. Specify with the ProbationPeriod attribute. Valid values are defined in the commonLookupsLOV.
**Probation End Date**
End date of the probation period.
**Notice Period**
Notice period for the assignment. Specify with the NoticePeriodUOM attribute.
**Notice Period Units**
Unit of measure for the notice period. Specify with the NoticePeriod attribute. Valid values are defined in the commonLookupsLOV.
**Work Tax Address ID**
Unique identifier for the address used for taxation purposes. This can be different from the mailing address.
**Expense Check Send-to Address**
Determines whether expense checks are sent to the home or office address.
**Retirement Age**
Age at which the worker is retiring.
**Retirement Date**
Planned retirement date of the worker.
**Union Member**
Indicates whether the worker is a labor union member.
**Union ID**
Unique identifier of the worker union for the assignment.
**Union**
Name of the worker union for the assignment. Valid values are defined in the unionsLov.
**Bargaining Unit**
Code for the bargaining unit.
**Collective Agreement ID**
Surrogate identifier for the collective agreement.
**Collective Agreement**
Name for the collective agreement. Valid values are defined in the collectiveAgreementsLov.
**Contract ID**
Surrogate identifier for the contract.
**Contract Number**
Number of the contract.
**Building**
Building information associated with the work location.
**Floor**
Floor information associated with the work location.
**Office Number**
Office number associated with the work location.
**Mail Stop**
Internal mail location.
**Default Expense Account**
Default expense account of the assignment. If the expense account is configured with multiple segments, then provide the concatenated value. Separate the values using the separator configured for the expense account.
**People Group**
People Group Key flexfield for the assignment. If people group is configured with multiple segments, provide the concatenated value, separating the values with the separator configured for the People Group Key flexfield.
**Standard Working Hours**
Standard working hours such as 40.
**Standard Frequency**
Frequency of standard working hours such as week or month.
**Adjusted FTE**
Adjusted Full Time Equivalent for the worker assignment.
**Annual Working Duration**
Annual working duration for the worker assignment.
**Annual Working Duration Units**
Description of the annual working duration units.
**Annual Working Ratio**
Annual working ratio for the worker assignment.
**Assignment Standard Working Hours Units**
Standard frequency for the worker assignment.
**Assignment Standard Working Hours**
Standard working hours for the worker assignment.
**Standard Annual Working Duration**
Standard annual working duration for the worker assignment.
**assignments D D F**
**Assignment Type**
**assignments D F F**
**Assignment Type**
**Workspace Category**
**Original\_Start\_Date**
**assignments E F F**
**Assignment Type**
**EFF Context**
**Grade Steps**
The gradeSteps resource is a child of the assignments resource. It provides all the assignment grade steps of a worker as of the specified date. By default, the current date is retained.
**Grade Step ID**
Surrogate identifier for the grade step.
**Name**
Name of the grade step. Valid values are defined in the gradeStepNamesLOV.
**Action Code**
Action being performed for the assignment such as Hire, Add Pending Worker, Manager Change and so on. Valid values are defined in the actionsLOV.
**Reason Code**
Reason for the change.Valid values are defined in the actionReasonsLOV.
**Managers**
The managers resource is a child of the assignments resource. It provides all the assignment managers of a worker as of the specified date. By default, the current date is retained.
**Assignment ID**
Surrogate identifier for the assignment supervisor.
**Assignment Number**
Assignment number of the supervisor.
References `/v1/hris/employees?remote_model=employee`
**Type**
Role the supervisor has with regards to the overall organization structure such as functional, project leader, and so on. Valid values are defined in the commonLookupsLOV.
**Action Code**
Action being performed on the assignment such as Hire, Add Pending Worker, Manager Change and so on. Valid values are defined in the actionsLOV.
**Reason Code**
Reason for the change. Valid values are defined in the actionReasonsLOV.
**Work Measures**
The workMeasures resource is a child of the assignments resource. It provides all the assignment work measures of a worker as of the specified date. By default, the current date is retained.
Value of the work measure.
Unit of measure. Valid values are defined in the commonLookupsLOV.
**Action Code**
Action being performed on the assignment such as Hire, Add Pending Worker, Manager Change and so on. Valid values are defined in the actionsLOV.
**Reason Code**
Reason for the change.Valid values are defined in the actionReasonsLOV.
**Calculate FTE and Headcount Automatically**
Indicates whether the full time equivalency (FTE) should be calculated automatically.
**Contracts**
The contracts resource is a child of the workRelationships resource and you can create or edit a contract only with an assignment. The resource provides all the contracts of a worker as of the specified date. By default, the current date is retained.
**Contract Number**
Number of the contract.
**Contract End Date**
Date when the contract ends.
**Contract Type**
Type of the contract.
Description of the contract.
**Initial Duration**
Initial duration of the contract.
**Initial Duration Units**
Unit for the initial duration of the contract.
**Extension Period**
Extension period of the contract.
**Extension Period Units**
Unit for the extension period of the contract.
**Action Code**
Action code for the employment contract.
**Contract Extension Flag**
Indicates whether the contract should be extended. Valid values are Yes and No. The default value is null.
**workers D F F**
**Employee Rewards Points**
**workers E F F**
**Category Code**
**Start Date**
The start date of the employee