oraclehcm.
Guides and Resources
Connection Setup Guide
Step-by-step instructions to connect your Oracle HCM account to Kombo.
Supported Features & Coverage
- Models
- Actions
- Features
- Create Employee with Form
Legal Entities
Legal Entities
| Field | Notes |
|---|---|
| id | |
| remote_id | |
| changed_at | |
| remote_deleted_at | |
| name | |
| remote_data |
Work Locations
Work Locations
| Field | Notes |
|---|---|
| id | |
| remote_id | |
| changed_at | |
| remote_deleted_at | |
| name | |
| address | |
| remote_data |
Employees
Employees
| 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 |
Absence Types
Absence Types
| Field | Notes |
|---|---|
| id | |
| remote_id | |
| changed_at | |
| remote_deleted_at | |
| name | |
| unit | |
| half_days_supported | |
| exact_times_supported | |
| remote_data |
Absences
Absences
| 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 |
Employments
Employments
| Field | Notes |
|---|---|
| id | |
| remote_id | |
| changed_at | |
| remote_deleted_at | |
| employee_id | |
| job_title | |
| pay_rate | |
| pay_period | |
| employment_type | |
| pay_currency | |
| effective_date |
Groups
Groups
| Field | Notes |
|---|---|
| id | |
| remote_id | |
| changed_at | |
| remote_deleted_at | |
| name | |
| type | |
| remote_data |
Timesheets
Timesheets
| 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 |
Performance Review Cycles
Performance Review Cycles
| Field | Notes |
|---|---|
| id | |
| remote_id | |
| changed_at | |
| remote_deleted_at | |
| name | |
| review_period_start_date | |
| remote_data |
Performance Reviews
Performance Reviews
| Field | Notes |
|---|---|
| id | |
| remote_id | |
| changed_at | |
| remote_deleted_at | |
| review_cycle_id | |
| reviewee_id | |
| reviewer_id | |
| type | |
| summary_comment | |
| summary_rating | |
| remote_data |
Skill Proficiency Scales
Skill Proficiency Scales
| Field | Notes |
|---|---|
| id | |
| remote_id | |
| changed_at | |
| remote_deleted_at | |
| scale | |
| remote_data |
Skills
Skills
| Field | Notes |
|---|---|
| id | |
| remote_id | |
| changed_at | |
| remote_deleted_at | |
| name | |
| proficiency_scale_id | |
| remote_data |
Skill Rating Providers
Skill Rating Providers
| Field | Notes |
|---|---|
| id | |
| remote_id | |
| changed_at | |
| remote_deleted_at | |
| name | |
| remote_data |
Employee Skill Proficiency Ratings
Employee Skill Proficiency Ratings
| Field | Notes |
|---|---|
| id | |
| remote_id | |
| changed_at | |
| remote_deleted_at | |
| employee_id | |
| skill_id | |
| proficiency | |
| rating_source | |
| rating_provider_id | |
| remote_data |
Employee <> Group
Employee <> Group
| Field | Notes |
|---|---|
| employee_id | |
| team_id | |
| id | |
| changed_at | |
| remote_deleted_at |
Create employee
Create employee
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 |
Create employee (v2)
Create employee (v2)
For detailed information about creating employees with form, please see the Create Employee with Form tab above.
| Input Field | Notes |
|---|---|
| staffing_entity_id | |
| properties |
Upsert employee skill proficiency rating
Upsert employee skill proficiency rating
Oracle HCM can assign a skill to an employee but not rate it, so a submitted
proficiency is rejected.| Input Field | Notes |
|---|---|
| employee_id | |
| skill_id | |
| rating.rating_source | |
| rating.proficiency |
| Feature | Notes |
|---|---|
| API Passthrough | |
| Scope Testing | |
| Connection Guide | |
| Group Types | |
| TEAM | |
| DEPARTMENT | |
| COST_CENTER |
Some required form fields are referencing the following data models:
- Groups
- Legal Entities
- Employees
single_select
Correspondence Language
Preferred language for communication. Valid values are defined in the commonLookupsLOV.
Preferred language for communication. Valid values are defined in the commonLookupsLOV.
single_select
Blood Type
Blood type of the person. Valid values are defined in the commonLookupsLOV.
Blood type of the person. Valid values are defined in the commonLookupsLOV.
date
Date of Birth
Date of birth of the person.
Date of birth of the person.
date
Date of Death
Date of death of the person.
Date of death of the person.
single_select
Country of Birth
Country of birth of the person. Valid values are defined in the hcmCountriesLOV.
Country of birth of the person. Valid values are defined in the hcmCountriesLOV.
text
Region of Birth
Region of birth of the person.
Region of birth of the person.
text
Town of Birth
Town of birth of the person.
Town of birth of the person.
text
Applicant Number
Applicant number in the external application.
Applicant number in the external application.
object
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.
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.
Show properties
Show properties
text
Address Line 1
First line of the primary mail address.
First line of the primary mail address.
text
Address Line 2
Second line of the primary mail address.
Second line of the primary mail address.
text
Address Line 3
Third line of the primary mail address.
Third line of the primary mail address.
text
Address Line 4
Fourth line of the primary mail address.
Fourth line of the primary mail address.
text
Town or City
Town or city in which the address is located.
Town or city in which the address is located.
text
Region 1
Primary region in which the address is located.
Primary region in which the address is located.
text
Region 2
Secondary region within the primary region.
Secondary region within the primary region.
text
Region 3
Additional secondary region within the primary region.
Additional secondary region within the primary region.
single_select
required
Country in which the address is located. Valid values are defined in the hcmCountriesLov.
text
Postal Code
Postal code of the primary mail address.
Postal code of the primary mail address.
text
Long Postal Code
Long postal code of the primary mail address.
Long postal code of the primary mail address.
text
Additional Address Attribute 1
Additional address column used by localizations.
Additional address column used by localizations.
text
Additional Address Attribute 2
Additional address column used by localizations.
Additional address column used by localizations.
text
Additional Address Attribute 3
Additional address column used by localizations.
Additional address column used by localizations.
text
Additional Address Attribute 4
Additional address column used by localizations.
Additional address column used by localizations.
text
Additional Address Attribute 5
Additional address column used by localizations.
Additional address column used by localizations.
text
Building information associated with the address.
text
Floor Number
Floor number associated with the building.
Floor number associated with the building.
single_select
required
Type
Type of address. Valid values are defined in the commonLookupsLOV.
Type of address. Valid values are defined in the commonLookupsLOV.
text
Validation Status Code
Level of accuracy of an address, as determined by an address provider.
Level of accuracy of an address, as determined by an address provider.
text
Company that has validated the address.
number
Distance between the prime meridian and an address located to its east or west, expressed in degrees and minutes.
number
Distance between the equator and an address located to its north or south, expressed in degrees and minutes.
checkbox
Validate Address Flag
Indicates whether the address is sent for validation. Valid values are true and false. The default value is false.
Indicates whether the address is sent for validation. Valid values are true and false. The default value is false.
object
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.
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.
Show properties
Show properties
single_select
required
Citizenship legislation code. Valid values are defined in the hcmCountriesLov.
date
From Date
Date from when the citizenship is valid.
Date from when the citizenship is valid.
date
To Date
Date until when the citizenship is valid.
Date until when the citizenship is valid.
single_select
required
Citizenship Status
Status of the citizenship. Valid values are defined in the commonLookupsLOV.
Status of the citizenship. Valid values are defined in the commonLookupsLOV.
object
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.
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.
Show properties
Show properties
single_select
required
Country
Legislation code for the disability. Valid values are defined in the hcmCountriesLov.
Legislation code for the disability. Valid values are defined in the hcmCountriesLov.
number
FTE
Person’s full time equivalency.
Person’s full time equivalency.
single_select
Status of the person’s disability.
single_select
Reason for the person’s disability.
number
Extent to which the disability impacts the person’s abilities.
text
Self-Disclosed Disability
Type of disability disclosed by the worker. Used explicitly for the Japanese, United Kingdom, and United States legislation.
Type of disability disclosed by the worker. Used explicitly for the Japanese, United Kingdom, and United States legislation.
date
Disclosure Date
Date on which the disability has been disclosed by the worker. Used explicitly for the Japanese, United Kingdom, and United States legislation.
Date on which the disability has been disclosed by the worker. Used explicitly for the Japanese, United Kingdom, and United States legislation.
text
Reasonable Accommodation Request
Request for accommodation.
Request for accommodation.
date
Registration Date
Date on which the disability was registered with the disability organization.
Date on which the disability was registered with the disability organization.
date
Expiration Date
Expiration date of the disability registration.
Expiration date of the disability registration.
text
Registration ID
Identification detail given to the person by the disability organization.
Identification detail given to the person by the disability organization.
number
Disability Organization
Unique identifier of the organization.
Unique identifier of the organization.
text
Description of the person’s disability.
text
Work Restrictions
Details of any work restrictions due to the disability.
Details of any work restrictions due to the disability.
object
Attachments
The attachments resource is used to view, create, and update attachments.
The attachments resource is used to view, create, and update attachments.
Show properties
Show properties
text
Type
A value that indicates the data type.
A value that indicates the data type.
text
File Name
The file name of the attachment.
The file name of the attachment.
text
Dm Folder Path
The folder path from which the attachment is created.
The folder path from which the attachment is created.
text
Dm Document Id
The document ID from which the attachment is created.
The document ID from which the attachment is created.
text
Dm Version Number
The document version number from which the attachment is created.
The document version number from which the attachment is created.
text
The URL of a web page type attachment.
text
Category
The category of the attachment.
The category of the attachment.
text
The URI of a Topology Manager type attachment.
text
File Url
The URI of the file.
The URI of the file.
text
Uploaded Text
The text content for a new text attachment.
The text content for a new text attachment.
text
Uploaded File Content Type
The content type of the attachment.
The content type of the attachment.
number
File Size
The size of the attachment file.
The size of the attachment file.
text
Uploaded File Name
The name to assign to a new attachment file.
The name to assign to a new attachment file.
checkbox
Shared
Indicates whether the attachment is shared
Indicates whether the attachment is shared
text
The title of the attachment.
text
The description of the attachment.
text
Error Status Code
The error code, if any, for the attachment.
The error code, if any, for the attachment.
text
Error Status Message
The error message, if any, for the attachment.
The error message, if any, for the attachment.
text
Asynchronous Upload Tracker Id
Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.
Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.
text
JSON object represented as a string containing information used to programmatically retrieve a file attachment.
text
Post Processing Action
The name of the action that can be performed after an attachment is uploaded.
The name of the action that can be performed after an attachment is uploaded.
object
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.
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.
Show properties
Show properties
single_select
License Type
Type of license. Valid values are defined in the commonLookupsLOV.
Type of license. Valid values are defined in the commonLookupsLOV.
single_select
required
Issuing Country
Country in which the driver’s license was issued. Valid values are defined in the hcmCountriesLov.
Country in which the driver’s license was issued. Valid values are defined in the hcmCountriesLov.
text
License Number
Driver’s license number.
Driver’s license number.
text
Issuing Authority
Issuing authority of the driver’s license.
Issuing authority of the driver’s license.
text
Place of Issue
Location where the driver’s license was issued.
Location where the driver’s license was issued.
date
From Date
Date from when the driver’s license is valid.
Date from when the driver’s license is valid.
date
To Date
Date until when the driver’s license is valid.
Date until when the driver’s license is valid.
number
Number of Points
Number of penalty points on the license.
Number of penalty points on the license.
number
Number of violations on the license.
checkbox
License Suspended
Indicates whether the driver’s license is suspended.
Indicates whether the driver’s license is suspended.
date
Suspended-from Date
Start date of suspension period, if any.
Start date of suspension period, if any.
date
Suspension-to Date
End date of suspension period, if any.
End date of suspension period, if any.
object
required
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.
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.
object
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.
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.
Show properties
Show properties
object
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.
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.
Show properties
Show properties
number
required
Sequence
Sequence of the external identifier.
Sequence of the external identifier.
text
required
Identifier
External identifier number.
External identifier number.
single_select
required
Identifier Type
Type of external identifier, such as Third-Party Payroll ID. Valid values are defined in the commonLookupsLOV.
Type of external identifier, such as Third-Party Payroll ID. Valid values are defined in the commonLookupsLOV.
number
Assignment ID
Unique identifier of the assignment to which this external identifier relates.
Unique identifier of the assignment to which this external identifier relates.
text
Identifier Comments
Comments for the external identifier.
Comments for the external identifier.
text
Assignment Number
Assignment number to which the external identifier belongs.
Assignment number to which the external identifier belongs.
object
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.
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.
Show properties
Show properties
single_select
required
Country
Legislation code. Valid values are defined in the hcmCountriesLov.
Legislation code. Valid values are defined in the hcmCountriesLov.
single_select
Gender of the person. Valid values are defined in the commonLookupsLOV.
single_select
Marital Status
Marital status of the person. Valid values are defined in the commonLookupsLOV.
Marital status of the person. Valid values are defined in the commonLookupsLOV.
date
Marital Status Change Date
Date from when the marital status came into effect.
Date from when the marital status came into effect.
single_select
Highest Education Level
Legislation-specific value that identifies the person’s highest education level. Valid values are defined in the commonLookupsLOV.
Legislation-specific value that identifies the person’s highest education level. Valid values are defined in the commonLookupsLOV.
object
Messages
The messages resource is a child of the workers resource. It provides all the available messages of a worker.
The messages resource is a child of the workers resource. It provides all the available messages of a worker.
Show properties
Show properties
text
Notification
Content of the message notification.
Content of the message notification.
object
required
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.
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.
Show properties
Show properties
single_select
required
Country
Legislation code. Valid values are defined in the hcmCountriesLov.
Legislation code. Valid values are defined in the hcmCountriesLov.
text
required
Last Name
Person’s last name.
Person’s last name.
text
First Name
Person’s first name.
Person’s first name.
single_select
Person salutation such as Mr., Ms., and so on. Valid values are defined in the commonLookupsLOV.
text
Prefix
Part of the name added before a person’s first name.
Part of the name added before a person’s first name.
text
Part of the name appended to a person’s last name such as Jr., III, and so on.
text
Middle Names
Person’s middle name.
Person’s middle name.
text
Higher qualification appended to a person’s name such as PhD.
text
Known As
Person’s preferred name.
Person’s preferred name.
text
Previous Last Name
Person’s previous last name.
Person’s previous last name.
text
Military Rank
Person’s military rank.
Person’s military rank.
text
Name Information 1
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
text
Name Information 2
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
text
Name Information 3
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
text
Name Information 4
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
text
Name Information 5
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
text
Name Information 6
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
text
Name Information 7
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
text
Name Information 8
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
text
Name Information 9
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
text
Name Information 10
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
text
Name Information 11
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
text
Name Information 12
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
text
Name Information 13
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
text
Name Information 14
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
text
Name Information 15
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
text
Name Information 16
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
text
Name Information 17
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
text
Name Information 18
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
text
Name Information 19
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
text
Name Information 20
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
text
Name Information 21
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
text
Name Information 22
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
text
Name Information 23
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
text
Name Information 24
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
text
Name Information 25
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
text
Name Information 26
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
text
Name Information 27
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
text
Name Information 28
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
text
Name Information 29
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
text
Name Information 30
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
single_select
Country
Legislation code of the local language. Valid values are defined in the hcmCountriesLov.
Legislation code of the local language. Valid values are defined in the hcmCountriesLov.
text
Last Name
Person’s last name in local language.
Person’s last name in local language.
text
First Name
Person’s first name in local language.
Person’s first name in local language.
single_select
Title
Person’s salutation such as Mr., Ms., and so on in local language. Valid values are defined in the commonLookupsLOV.
Person’s salutation such as Mr., Ms., and so on in local language. Valid values are defined in the commonLookupsLOV.
text
Prefix
Part of the name added before a person’s first name in local language.
Part of the name added before a person’s first name in local language.
text
Suffix
Part of the name appended to a person’s last name such as Jr., III, and so on, in local language.
Part of the name appended to a person’s last name such as Jr., III, and so on, in local language.
text
Middle Names
Person’s middle name in local language.
Person’s middle name in local language.
text
Honors
Higher qualification appended to a person’s name such as PhD in local language.
Higher qualification appended to a person’s name such as PhD in local language.
text
Known As
Person’s preferred name in local language.
Person’s preferred name in local language.
text
Previous Last Name
Person’s previous last name in local language.
Person’s previous last name in local language.
text
Military Rank
Person’s military rank in local language.
Person’s military rank in local language.
text
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.
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.
text
Name Information 1
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
text
Name Information 2
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
text
Name Information 3
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
text
Name Information 4
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
text
Name Information 5
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
text
Name Information 6
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
text
Name Information 7
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
text
Name Information 8
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
text
Name Information 9
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
text
Name Information 10
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
text
Name Information 11
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
text
Name Information 12
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
text
Name Information 13
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
text
Name Information 14
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
text
Name Information 15
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
text
Name Information 16
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
text
Name Information 17
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
text
Name Information 18
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
text
Name Information 19
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
text
Name Information 20
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
text
Name Information 21
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
text
Name Information 22
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
text
Name Information 23
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
text
Name Information 24
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
text
Name Information 25
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
text
Name Information 26
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
text
Name Information 27
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
text
Name Information 28
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
text
Name Information 29
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
text
Name Information 30
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
object
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.
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.
Show properties
Show properties
single_select
required
Country
Legislation code of the national identifier. Valid values are defined in the hcmCountriesLov.
Legislation code of the national identifier. Valid values are defined in the hcmCountriesLov.
single_select
required
National ID Type
Type of national identifier. Valid values are defined in the commonLookupsLOV.
Type of national identifier. Valid values are defined in the commonLookupsLOV.
text
required
National ID
National identification number.
National identification number.
date
Issue Date
Issue date of the national identifier.
Issue date of the national identifier.
date
Expiration Date
Expiration date of the national identifier.
Expiration date of the national identifier.
text
Place of Issue
Place where the national identifier was issued.
Place where the national identifier was issued.
object
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.
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.
object
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.
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.
Show properties
Show properties
single_select
required
Issuing Country
Country in which the passport was issued. Valid values are defined in the hcmCountriesLov.
Country in which the passport was issued. Valid values are defined in the hcmCountriesLov.
single_select
Type
Type or category of the passport. Valid values are defined in the commonLookupsLOV.
Type or category of the passport. Valid values are defined in the commonLookupsLOV.
text
Number
Passport number of the person.
Passport number of the person.
text
Issuing Authority
Issuing authority for the passport.
Issuing authority for the passport.
date
Issue Date
Issue date of the passport.
Issue date of the passport.
date
Expiration Date
Expiration date of the passport.
Expiration date of the passport.
text
Issuing Location
Location where the passport was issued.
Location where the passport was issued.
text
Profession of the passport holder.
object
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.
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.
Show properties
Show properties
single_select
required
Type
Type of phone such as Work, Home, and so on. Valid values are defined in the commonLookupsLOV.
Type of phone such as Work, Home, and so on. Valid values are defined in the commonLookupsLOV.
single_select
Country
Phone legislation code.
Phone legislation code.
text
Country Code
Country code of the phone number. Valid values are defined in the hcmCountriesLov.
Country code of the phone number. Valid values are defined in the hcmCountriesLov.
text
Area Code
Area code of the phone number.
Area code of the phone number.
text
required
Number
Phone number of various phone types such as Work, Home, and so on.
Phone number of various phone types such as Work, Home, and so on.
text
Extension number for the phone.
date
To Date
Date until when the phone number is valid.
Date until when the phone number is valid.
single_select
Time of day when a person can be reached at a specific phone number.
object
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.
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.
object
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.
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.
Show properties
Show properties
object
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.
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.
Show properties
Show properties
single_select
required
Issuing Country
Country in which the visa or permit was issued. Valid values are defined in the hcmCountriesLov.
Country in which the visa or permit was issued. Valid values are defined in the hcmCountriesLov.
single_select
Type
Visa or permit type. Valid values are defined in the commonLookupsLOV.
Visa or permit type. Valid values are defined in the commonLookupsLOV.
text
Category
Category of the visa or permit. Valid values are defined in the commonLookupsLOV.
Category of the visa or permit. Valid values are defined in the commonLookupsLOV.
text
Number
Visa or permit number.
Visa or permit number.
single_select
Status
Indicates if the visa or permit is current. Valid values are defined in the commonLookupsLOV.
Indicates if the visa or permit is current. Valid values are defined in the commonLookupsLOV.
text
Issuing Authority
Issuing authority for the visa or permit.
Issuing authority for the visa or permit.
text
Place of Issue
Location where the visa or permit was issued.
Location where the visa or permit was issued.
date
Issue Date
Date of issue of the visa or permit.
Date of issue of the visa or permit.
date
Entry Date
Entry date of the person into the country.
Entry date of the person into the country.
date
Expiration Date
Expiration date of the visa or permit.
Expiration date of the visa or permit.
date
Status Change Date
Date from when the permit status is effective.
Date from when the permit status is effective.
text
Profession of the visa or permit holder.
object
required
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.
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.
Show properties
Show properties
single_select
required
Legal Entity ID
Unique identifier for the legal entity of the work relationship.
References
Unique identifier for the legal entity of the work relationship.
References
/v1/hris/legal-entities?remote_model=legal_entitysingle_select
required
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.
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.
checkbox
Primary
Indicates whether the work relationship is the primary work relationship for the worker. Valid values are Yes and No.
Indicates whether the work relationship is the primary work relationship for the worker. Valid values are Yes and No.
date
Seniority Date
Date on which a person’s legal-employer service of a particular type, such as employee, contingent worker, or nonworker, is based.
Date on which a person’s legal-employer service of a particular type, such as employee, contingent worker, or nonworker, is based.
date
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.
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.
checkbox
On Military Service
Indicates whether the person is on military service.
Indicates whether the person is on military service.
text
Worker Number
Unique identifier for the worker.
Unique identifier for the worker.
checkbox
Include for Automatic Conversion
Indicates whether the pending worker is ready to be converted to the proposed worker type.
Indicates whether the pending worker is ready to be converted to the proposed worker type.
date
Projected Termination Date
Projected last date of employment for the period of service.
Projected last date of employment for the period of service.
object
required
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.
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.
Show properties
Show properties
text
Assignment Number
Unique identifier for the assignment.
Unique identifier for the assignment.
text
Business Title
Business title of the worker assignment.
Business title of the worker assignment.
single_select
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.
Action being performed for this assignment, such as, Hire, Add Pending Worker, Manager Change and so on. Valid values are defined in the actionsLOV.
single_select
Reason Code
Reason for the action being performed on the record. Valid values are defined in the actionReasonsLOV.
Reason for the action being performed on the record. Valid values are defined in the actionReasonsLOV.
single_select
required
Business Unit ID
Unique identifier for the business unit of the assignment.
References
Unique identifier for the business unit of the assignment.
References
/v1/hris/groups?types=TEAMsingle_select
Business Unit
Name of the business unit for the worker assignment. Valid values are defined in the hcmBusinesUnitsLOV.
Name of the business unit for the worker assignment. Valid values are defined in the hcmBusinesUnitsLOV.
single_select
Assignment Status Code
Code for the assignment status type.
Code for the assignment status type.
number
User Person Type ID
Unique identifier for the user person type.
Unique identifier for the user person type.
single_select
User Person Type
User-defined value that identifies the person type such as employee or contingent worker. Valid values are defined in the personTypesLOV.
User-defined value that identifies the person type such as employee or contingent worker. Valid values are defined in the personTypesLOV.
text
Proposed User Person Type ID
Unique identifier for the proposed user person type.
Unique identifier for the proposed user person type.
single_select
Proposed Person Type
Code of the proposed user person type. Valid values are defined in the personTypesLOV.
Code of the proposed user person type. Valid values are defined in the personTypesLOV.
date
Projected Start Date
Expected start date for applicants. This value is required for pending workers.
Expected start date for applicants. This value is required for pending workers.
date
Projected End Date
Date when the assignment is expected to end.
Date when the assignment is expected to end.
checkbox
Primary Assignment
Indicates whether the current assignment is primary for the work relationship. Valid values are true or false.
Indicates whether the current assignment is primary for the work relationship. Valid values are true or false.
number
Position ID
Unique identifier for the worker’s position.
Unique identifier for the worker’s position.
single_select
Position Code
Code for the worker’s position.
Code for the worker’s position.
checkbox
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.
Indicates whether attributes from the position can be overridden on the assignment when using position synchronization. Valid values are true or false.
number
Job ID
Unique identifier for the worker’s job.
Unique identifier for the worker’s job.
single_select
Job Code
Code for the worker’s job. Valid values are defined in the jobsLov.
Code for the worker’s job. Valid values are defined in the jobsLov.
number
Grade ID
Unique identifier for the worker’s grade.
Unique identifier for the worker’s grade.
single_select
Grade Code
Code of the assignment grade. Valid values are defined in the gradesLov.
Code of the assignment grade. Valid values are defined in the gradesLov.
number
Grade Ladder ID
Unique identifier for the grade ladder used for benefits.
Unique identifier for the grade ladder used for benefits.
single_select
Grade Ladder
Name of the grade ladder used for benefits. Valid values are defined in the gradeLaddersLov.
Name of the grade ladder used for benefits. Valid values are defined in the gradeLaddersLov.
checkbox
Include in Grade Step Progression
Indicates whether the assignment is eligible for grade-step progression. Valid values are true or false.
Indicates whether the assignment is eligible for grade-step progression. Valid values are true or false.
number
Department ID
Unique identifier for the worker’s department.
Unique identifier for the worker’s department.
single_select
Department
Name of the department for the worker assignment. Valid values are defined in the departmentsLov.
Name of the department for the worker assignment. Valid values are defined in the departmentsLov.
number
Reporting Establishment ID
Unique identifier for the reporting establishment.
Unique identifier for the reporting establishment.
single_select
Reporting Establishment
Name of the reporting establishment. Valid values are defined in the reportingEstablishmentsLOV.
Name of the reporting establishment. Valid values are defined in the reportingEstablishmentsLOV.
number
Location ID
Unique identifier for the worker’s location.
Unique identifier for the worker’s location.
single_select
Location Code
Code for the worker’s location.
Code for the worker’s location.
checkbox
Working at Home
Indicates whether the worker works at home for the assignment.
Indicates whether the worker works at home for the assignment.
single_select
Assignment Category
User-defined category for the assignment such as full-time, permanent, and so on. Valid values are defined in the commonLookupsLOV.
User-defined category for the assignment such as full-time, permanent, and so on. Valid values are defined in the commonLookupsLOV.
single_select
Worker Category
Category of the worker such as blue collar, civil servant, and so on. Valid values are defined in the commonLookupsLOV.
Category of the worker such as blue collar, civil servant, and so on. Valid values are defined in the commonLookupsLOV.
single_select
Regular or Temporary
Indicates whether the worker is regular or temporary. Valid values are defined in the commonLookupsLOV.
Indicates whether the worker is regular or temporary. Valid values are defined in the commonLookupsLOV.
single_select
Full Time or Part Time
Indicates whether the worker works full-time or part-time. Valid values are defined in the commonLookupsLOV.
Indicates whether the worker works full-time or part-time. Valid values are defined in the commonLookupsLOV.
checkbox
Working as a Manager
Indicates whether the worker is a manager.
Indicates whether the worker is a manager.
single_select
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.
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.
number
Working Hours
Normal working hours, such as 37.5. Specify with the Frequency attribute.
Normal working hours, such as 37.5. Specify with the Frequency attribute.
single_select
Frequency of normal working hours such as week or month. Specify with the NormalHours attribute. Valid values are defined in the commonLookupsLOV.
text
Start Time
Normal start time for the working day.
Normal start time for the working day.
text
End Time
Normal end time for the working day.
Normal end time for the working day.
single_select
Basis for Seniority Calculation
Basis for calculating seniority for the person. Valid values are defined in the commonLookupsLOV.
Basis for calculating seniority for the person. Valid values are defined in the commonLookupsLOV.
number
Probation Period
Duration of the probation period. Specify with the ProbationPeriodUnit attribute.
Duration of the probation period. Specify with the ProbationPeriodUnit attribute.
single_select
Probation Unit
Unit of measure for the probation period. Specify with the ProbationPeriod attribute. Valid values are defined in the commonLookupsLOV.
Unit of measure for the probation period. Specify with the ProbationPeriod attribute. Valid values are defined in the commonLookupsLOV.
date
Probation End Date
End date of the probation period.
End date of the probation period.
number
Notice Period
Notice period for the assignment. Specify with the NoticePeriodUOM attribute.
Notice period for the assignment. Specify with the NoticePeriodUOM attribute.
text
Notice Period Units
Unit of measure for the notice period. Specify with the NoticePeriod attribute. Valid values are defined in the commonLookupsLOV.
Unit of measure for the notice period. Specify with the NoticePeriod attribute. Valid values are defined in the commonLookupsLOV.
number
Work Tax Address ID
Unique identifier for the address used for taxation purposes. This can be different from the mailing address.
Unique identifier for the address used for taxation purposes. This can be different from the mailing address.
single_select
Expense Check Send-to Address
Determines whether expense checks are sent to the home or office address.
Determines whether expense checks are sent to the home or office address.
number
Retirement Age
Age at which the worker is retiring.
Age at which the worker is retiring.
date
Retirement Date
Planned retirement date of the worker.
Planned retirement date of the worker.
checkbox
Union Member
Indicates whether the worker is a labor union member.
Indicates whether the worker is a labor union member.
number
Union ID
Unique identifier of the worker union for the assignment.
Unique identifier of the worker union for the assignment.
single_select
Union
Name of the worker union for the assignment. Valid values are defined in the unionsLov.
Name of the worker union for the assignment. Valid values are defined in the unionsLov.
single_select
Bargaining Unit
Code for the bargaining unit.
Code for the bargaining unit.
number
Collective Agreement ID
Surrogate identifier for the collective agreement.
Surrogate identifier for the collective agreement.
single_select
Collective Agreement
Name for the collective agreement. Valid values are defined in the collectiveAgreementsLov.
Name for the collective agreement. Valid values are defined in the collectiveAgreementsLov.
number
Contract ID
Surrogate identifier for the contract.
Surrogate identifier for the contract.
single_select
Contract Number
Number of the contract.
Number of the contract.
text
Building
Building information associated with the work location.
Building information associated with the work location.
text
Floor
Floor information associated with the work location.
Floor information associated with the work location.
text
Office Number
Office number associated with the work location.
Office number associated with the work location.
text
Mail Stop
Internal mail location.
Internal mail location.
text
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.
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.
text
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.
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.
number
Standard Working Hours
Standard working hours such as 40.
Standard working hours such as 40.
text
Standard Frequency
Frequency of standard working hours such as week or month.
Frequency of standard working hours such as week or month.
number
Adjusted FTE
Adjusted Full Time Equivalent for the worker assignment.
Adjusted Full Time Equivalent for the worker assignment.
number
Annual Working Duration
Annual working duration for the worker assignment.
Annual working duration for the worker assignment.
text
Annual Working Duration Units
Description of the annual working duration units.
Description of the annual working duration units.
number
Annual Working Ratio
Annual working ratio for the worker assignment.
Annual working ratio for the worker assignment.
text
Assignment Standard Working Hours Units
Standard frequency for the worker assignment.
Standard frequency for the worker assignment.
number
Assignment Standard Working Hours
Standard working hours for the worker assignment.
Standard working hours for the worker assignment.
number
Standard Annual Working Duration
Standard annual working duration for the worker assignment.
Standard annual working duration for the worker assignment.
object
object
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.
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.
Show properties
Show properties
number
required
Grade Step ID
Surrogate identifier for the grade step.
Surrogate identifier for the grade step.
single_select
Name
Name of the grade step. Valid values are defined in the gradeStepNamesLOV.
Name of the grade step. Valid values are defined in the gradeStepNamesLOV.
single_select
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.
Action being performed for the assignment such as Hire, Add Pending Worker, Manager Change and so on. Valid values are defined in the actionsLOV.
single_select
Reason Code
Reason for the change.Valid values are defined in the actionReasonsLOV.
Reason for the change.Valid values are defined in the actionReasonsLOV.
object
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.
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.
Show properties
Show properties
number
required
Assignment ID
Surrogate identifier for the assignment supervisor.
Surrogate identifier for the assignment supervisor.
single_select
Assignment Number
Assignment number of the supervisor.
References
Assignment number of the supervisor.
References
/v1/hris/employees?remote_model=employeesingle_select
required
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.
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.
single_select
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.
Action being performed on the assignment such as Hire, Add Pending Worker, Manager Change and so on. Valid values are defined in the actionsLOV.
single_select
Reason Code
Reason for the change. Valid values are defined in the actionReasonsLOV.
Reason for the change. Valid values are defined in the actionReasonsLOV.
object
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.
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.
Show properties
Show properties
number
required
Value of the work measure.
single_select
required
Unit of measure. Valid values are defined in the commonLookupsLOV.
single_select
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.
Action being performed on the assignment such as Hire, Add Pending Worker, Manager Change and so on. Valid values are defined in the actionsLOV.
single_select
Reason Code
Reason for the change.Valid values are defined in the actionReasonsLOV.
Reason for the change.Valid values are defined in the actionReasonsLOV.
checkbox
Calculate FTE and Headcount Automatically
Indicates whether the full time equivalency (FTE) should be calculated automatically.
Indicates whether the full time equivalency (FTE) should be calculated automatically.
object
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.
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.
Show properties
Show properties
text
Contract Number
Number of the contract.
Number of the contract.
date
Contract End Date
Date when the contract ends.
Date when the contract ends.
single_select
Contract Type
Type of the contract.
Type of the contract.
text
Description of the contract.
number
Initial Duration
Initial duration of the contract.
Initial duration of the contract.
single_select
Initial Duration Units
Unit for the initial duration of the contract.
Unit for the initial duration of the contract.
number
Extension Period
Extension period of the contract.
Extension period of the contract.
single_select
Extension Period Units
Unit for the extension period of the contract.
Unit for the extension period of the contract.
text
Action Code
Action code for the employment contract.
Action code for the employment contract.
checkbox
Contract Extension Flag
Indicates whether the contract should be extended. Valid values are Yes and No. The default value is null.
Indicates whether the contract should be extended. Valid values are Yes and No. The default value is null.
date
required
Start Date
The start date of the employee
The start date of the employee