Oracle Fusion HCM

Overview

The Oracle Fusion HCM connector enables your Leena AI Agents to integrate with your organization's Oracle Fusion Human Capital Management (HCM) platform, facilitating automated HR operations including absence management, worker lifecycle management, personal information updates, compensation and payroll, payment methods, emergency contacts, goals and performance, journeys and learning, recruiting, benefits enrollment, documents, and approval workflows.

Oracle Fusion HCM is Oracle's comprehensive cloud-based human capital management suite that provides end-to-end HR capabilities including core HR, talent management, workforce management, and payroll. The Oracle Fusion HCM connector allows Leena AI to automate HR workflows, manage worker data, handle absence requests, and interact with HCM processes seamlessly.

API Details

Leena AI integrates with Oracle Fusion HCM via REST APIs.

Documentation link: https://docs.oracle.com/en/cloud/saas/human-resources/24d/farws/Quick_Start.html

Setup

The Oracle Fusion HCM connector supports the following authentication types:

  • Username and Password (Basic authentication over SSL)
  • OAuth 2.0 Client Credentials (via the OCI IAM identity domain linked to your Oracle Fusion instance)

Prerequisites

Before setting up the Oracle Fusion HCM connector, ensure you have:

  • Administrator access to your Oracle Fusion Cloud HCM instance
  • An integration user account with the appropriate security roles and privileges
  • The Oracle Instance URL for your HCM environment (e.g., https://your-company.oraclecloud.com)
  • Access to Oracle Security Console for role and privilege management
  • Access to your Leena AI workspace with connector management permissions
  • For OAuth 2.0 only: Administrator access to the OCI IAM identity domain (IDCS) associated with your Oracle Fusion instance, with permission to create and activate integrated applications

Get credentials

Username and Password

Here is how to set up an integration user in Oracle Fusion HCM:

  1. Log in to Oracle Fusion Cloud as a Security Administrator
  2. Create or identify an Integration User:
    1. Navigate to Tools > Security Console
    2. Go to the Users tab
    3. Create a new user or identify an existing integration user account
    4. Ensure the user has a non-expiring password or a service account configuration
  3. Assign Required Security Roles:
    1. In the Security Console, search for your integration user
    2. Click on the Display Name to access user information
    3. Click Edit and then Add Role
    4. Assign the necessary roles based on the actions you need. Common roles include:
      • Human Capital Management Integration Specialist — for worker and absence data access
      • Use REST Service - Worker as HR — for workers REST API access
      • Benefits Administrator — for benefits enrollment actions
      • Roles with REST access to compensation, payroll, goals and performance, journeys, learning and recruiting — for the actions in those groups
    5. Save and close
  4. Configure Data Security (if required):
    1. Navigate to Setup and Maintenance > Tasks > Manage Data Role and Security Profiles
    2. Create a data role with the appropriate security profiles to control data-level access
    3. Assign the data role to your integration user
  5. Note the following credentials:
    • Oracle Instance URL: Your Oracle Cloud environment URL (e.g., https://your-company.fa.us2.oraclecloud.com)
    • Username: The integration user's username
    • Password: The integration user's password

OAuth 2.0 Client Credentials

Oracle Fusion delegates API authentication to the OCI IAM identity domain paired with your instance. A confidential application registered in that identity domain issues the access tokens Leena AI uses to call Oracle Fusion HCM APIs.

Here is how to set up a confidential application for OAuth 2.0:

  1. Log in to the OCI Console as an Identity Domain Administrator
  2. Open the identity domain linked to your Oracle Fusion instance:
    1. Navigate to Identity & Security > Domains
    2. Select the identity domain associated with your Oracle Fusion environment
  3. Create a Confidential Application:
    1. Go to Integrated applications and click Add application
    2. Select Confidential Application and click Launch workflow
    3. Enter a name (e.g., Leena AI Integration) and an optional description, then click Next
  4. Configure OAuth:
    1. Under Client configuration, select Configure this application as a client now
    2. Under Allowed grant types, select Client credentials
    3. Under Token issuance policy, enable Add resources and click Add scope
    4. Select the Oracle Fusion Applications resource for your instance and add the scope ending in urn:opc:resource:consumer::all
    5. Click Next, then Finish
  5. Activate the application:
    1. Open the newly created application
    2. Click Activate and confirm
  6. Map the application to an Oracle Fusion user:
    1. In Oracle Fusion, navigate to Tools > Security Console > Users
    2. Create a user whose username matches the Client ID of the confidential application (Oracle Fusion runs client credentials requests as this user)
    3. Assign the same security roles and data roles listed in the Username and Password section above (e.g., Human Capital Management Integration Specialist, Use REST Service - Worker as HR, Benefits Administrator)
  7. Note the following credentials:
    • Oracle Instance URL: Your Oracle Fusion API base URL (e.g., https://your-company.fa.ocs.oraclecloud.com)
    • Client ID: Found under OAuth configuration > General Information of the confidential application
    • Client Secret: Click Show secret under General Information to copy it
    • Token Endpoint URL: Your identity domain URL followed by /oauth2/v1/token (e.g., https://idcs-<id>.identity.oraclecloud.com/oauth2/v1/token). The domain URL is available on the identity domain's Overview page
    • Scope: The full scope added to the application (e.g., urn:opc:resource:fa:instanceid=<id>urn:opc:resource:consumer::all)

Note

Access tokens issued via client credentials are short-lived (typically ~1 hour) and no refresh token is issued. Leena AI caches the token and automatically requests a new one shortly before it expires — no manual re-authentication is required. If the client secret is rotated in OCI IAM, update it in the Leena AI connection.

Add connection

Here is how to add a connection on Leena AI:

  1. Log in to your Leena AI workspace
  2. Navigate to Settings > Integrations
  3. Search for "Oracle Fusion HCM" and select it from the list to add its new connector
  4. Select the authentication type and configure the connector:

Username and Password

  1. Select the authentication type: Username and password
  2. Start configuring the connector:
    1. Oracle instance URL: Your Oracle Fusion Cloud instance URL (e.g., https://your-company.oraclecloud.com)
    2. Username: Integration user's username
    3. Password: Integration user's password
  3. Click Test Connection to verify the credentials
  4. Save the connector configuration

OAuth 2.0 Client Credentials

  1. Select the authentication type: OAuth 2.0 client credentials
  2. Start configuring the connector:
    1. Oracle instance URL: Your Oracle Fusion API base URL (e.g., https://your-company.fa.ocs.oraclecloud.com)
    2. Client ID: Client ID of the confidential application registered in the OCI IAM identity domain
    3. Client secret: Client secret issued alongside the Client ID
    4. Token endpoint URL: Identity domain token endpoint (e.g., https://idcs-<id>.identity.oraclecloud.com/oauth2/v1/token)
    5. Scope: Confidential application scope (e.g., urn:opc:resource:fa:instanceid=<id>urn:opc:resource:consumer::all)
  3. Click Test Connection to verify the credentials. Leena AI requests a fresh access token from the token endpoint during the test, so any issue with the Client ID, Client Secret, Token Endpoint URL, or Scope is reported here
  4. Save the connector configuration

Actions

The following actions are supported for the Oracle Fusion HCM connector:

Absence Management

Create Absence

Creates a new absence record for a worker in Oracle Fusion HCM. The Agent can leverage the tool (workflow), which has been designed to create a new absence request, once the user raises a query to do so.

Input Parameters

Here are the input parameters required to set up this action:

Mandatory
NameDescription
Person IDThe person for whom the absence is being created
Absence TypeThe type of absence being requested, from the types available to the selected person
Start DateThe start date of the absence
End DateThe end date of the absence
Legal EntityThe legal entity associated with the worker, loaded automatically for the selected person
Optional
NameDescription
Start TimeThe start time of the absence (partial-day absences)
End TimeThe end time of the absence (partial-day absences)
Start Date DurationDuration type for the start date: Full day or Half day
End Date DurationDuration type for the end date: Full day or Half day
Absence StatusThe status of the absence record: Submitted (default) or Saved/draft
Supporting DocumentsFile attachments for the absence request (file name, file URL, data type code)
CommentsAdditional comments for the absence request

Response

Upon successful creation, the action returns the created absence details including the absence record ID and status.


Update Absence

Updates an existing absence record in Oracle Fusion HCM. The Agent can leverage the tool (workflow), which has been designed to modify an existing absence record, once the user provides the details to be updated.

Input Parameters

Here are the input parameters required to set up this action:

Mandatory
NameDescription
AbsenceThe absence record to update, searchable by absence type or status
Optional
NameDescription
Absence ReasonThe reason for the absence
Absence Update StatusSubmit, or Save/draft
New Start DateThe updated start date
New End DateThe updated end date
Start TimeThe updated start time
End TimeThe updated end time
CommentsUpdated comments for the absence

Response

Upon successful update, the action returns the updated absence record details.


Delete Absence

Deletes an existing absence record from Oracle Fusion HCM. The Agent can leverage the tool (workflow), which has been designed to remove an absence record, once the user specifies the absence to be deleted.

Input Parameters

Here are the input parameters required to set up this action:

Mandatory
NameDescription
AbsenceThe absence record to delete, searchable by absence type or status
Cancellation CommentsReason for the cancellation

Response

Upon successful deletion, the action returns a confirmation of the deletion.


Get All Absences

Retrieves a list of absence records from Oracle Fusion HCM. This action can be leveraged by Leena AI Orchestrator/Agent to list all absences or filter by specific criteria.

Input Parameters

Here are the input parameters required to set up this action:

All parameters are optional for this action.

Optional
NameDescription
PersonFilter absences by person
Start Date (from)Filter by absence start date
End Date (to)Filter by absence end date
Absence StatusFilter by absence status: Submitted, Saved/draft, Scheduled, In progress, Completed, Withdrawn
Approval StatusFilter by approval status: Approved, Pending approval, Rejected, Approval not required
Specific FieldsSpecific fields to include in the response
Expand Child ResourcesChild resources to expand in the response
Records per PageMaximum number of records to return
Page NumberPage number for pagination
Order ByField to order results by
Exclude LinksExclude links and metadata from the response
Include Total CountInclude total result count in the response
Advanced Filter QueryAdvanced query filter, e.g. personNumber='13' AND startDate >= '2024-01-01'

Response

The action returns a list of absence records, each containing absence details, dates, status, and approval information.


Get Absence by ID

Retrieves a specific absence record by its unique identifier.

Input Parameters

Here are the input parameters required to set up this action:

Mandatory
NameDescription
Absence Unique IDThe unique identifier of the absence to retrieve
Optional
NameDescription
Exclude Links from ResponseExclude links and metadata from the response

Response

The action returns the complete absence record details including dates, type, status, and associated metadata.


Get Absence Type Balance

Retrieves the absence type balance for a specific worker, showing remaining leave entitlements.

Input Parameters

Here are the input parameters required to set up this action:

Mandatory
NameDescription
Person NameThe person whose absence balance is to be checked
Effective DateThe date for which the balance is calculated
AssignmentThe assignment of the worker
User ContextContext for the balance calculation, e.g. ADMIN or USER

Response

The action returns the absence type balance details including available balance, used leave, and entitlement information.


Get Applicable Absence Types By User

Retrieves the list of absence types that are applicable for a specific user based on their employment configuration.

Input Parameters

Here are the input parameters required to set up this action:

Mandatory
NameDescription
Person NameThe person whose applicable absence types are to be retrieved
Optional
NameDescription
LimitMaximum number of records to return
OffsetNumber of records to skip

Response

The action returns a list of applicable absence types for the specified user.


Worker Management

Create Worker (Hire)

Creates a new worker (hire) in Oracle Fusion HCM. The Agent can leverage the tool (workflow), which has been designed to initiate a new hire process, once the user provides the worker details.

Input Parameters

Here are the input parameters required to set up this action:

Mandatory
NameDescription
First NameThe first name of the worker
Last NameThe last name of the worker
Legislation CodeThe legislation code for the worker's country
Effective DateThe hire date
Legal Employer NameThe legal employer for the worker
Worker TypeThe type of worker (e.g., Employee, Contingent Worker)
Action CodeThe hire action code: HIRE or REHIRE
Business Unit NameThe business unit for the worker
Phone TypeThe type of phone number
Phone NumberThe worker's phone number
Email TypeThe type of email address
Email AddressThe worker's email address
Address TypeThe type of address
CountryThe country for the worker's address
Optional
NameDescription
Projected Start DateProjected start date (required if creating a Pending Worker)
Proposed User Person TypeProposed person type (required if creating a Pending Worker)
Address Line 1–4Address line fields
Town or CityThe city of the worker's address
Region 1County in a US address
Region 2State in a US address, where Oracle requires it
Region 3Additional region field
Postal CodeThe postal code of the worker's address

Response

Upon successful creation, the action returns the created worker details including the worker ID and person number.


Update Worker

Updates an existing worker's information in Oracle Fusion HCM. The Agent can leverage the tool (workflow), which has been designed to modify worker details, once the user provides the fields to be updated.

Input Parameters

Here are the input parameters required to set up this action:

Mandatory
NameDescription
WorkerThe worker to update, searchable by person number
Effective DateThe effective date for the update
Optional
NameDescription
Update Personal InformationToggle to update personal information
Date of BirthUpdated date of birth (when updating personal information)
Country of BirthUpdated country of birth
Update NameToggle to update name details
Name RecordThe name record to update
First NameUpdated first name
Last NameUpdated last name
Update EmailToggle to update email address
Email RecordThe email record to update
Email AddressUpdated email address
Update AddressToggle to update address
Address RecordThe address record to update
Address Line 1–2Updated address lines
Town or CityUpdated city
Postal CodeUpdated postal code
Update PhoneToggle to update phone number
Phone RecordThe phone record to update
Phone NumberUpdated phone number
Phone TypeUpdated phone type
From DateEffective start date for the phone record

Response

Upon successful update, the action returns the updated worker details.


Get All Workers

Retrieves a list of workers from Oracle Fusion HCM. This action can be leveraged by Leena AI Orchestrator/Agent to list workers with various filtering and expansion options.

Input Parameters

Here are the input parameters required to set up this action:

All parameters are optional for this action.

Optional
NameDescription
Effective DateThe effective date for the query (default: current date)
Expand Child ResourcesChild resources to expand (e.g., names, emails, phones)
Fields to ReturnSpecific fields to include in the response
LimitMaximum number of records to return (max 500)
OffsetNumber of records to skip
Sort ByField to order results by
Sort OrderSort direction (ascending or descending)
Only DataExclude links and metadata from the response

Response

The action returns a list of worker records, each containing worker details, employment information, and any expanded child resources.


Get Worker By Id

Retrieves a specific worker's details by their unique identifier.

Input Parameters

Here are the input parameters required to set up this action:

Mandatory
NameDescription
WorkerThe worker to retrieve, searchable by person number
Optional
NameDescription
Expand Child ResourcesChild resources to expand in the response
Effective DateThe effective date for the query
Specific Fields to ReturnSpecific fields to include in the response
Only DataExclude links and metadata from the response

Response

The action returns the complete worker record including personal information, employment details, and any expanded child resources.


Terminate Worker

Terminates a worker's employment in Oracle Fusion HCM. The Agent can leverage the tool (workflow), which has been designed to process a termination, once the user provides the necessary details.

Input Parameters

Here are the input parameters required to set up this action:

Mandatory
NameDescription
WorkerThe worker to terminate
Period of ServiceThe work relationship to terminate
Action CodeThe termination action code: Resignation (voluntary), Retirement or Death
Termination DateThe effective date of termination
Optional
NameDescription
Date of DeathDate of death (applicable if action code is Death)
Recommended for RehireWhether the worker is recommended for rehire

Response

Upon successful termination, the action returns the termination confirmation and updated worker status.


Get Work Relationships

Retrieves a worker's work relationships, the assignments under a work relationship, or the managers of an assignment. This action can be leveraged by Leena AI Orchestrator/Agent to look up a worker's employment structure before making changes.

Input Parameters

Here are the input parameters required to set up this action:

Mandatory
NameDescription
WorkerThe worker to look up, searchable by person number
Optional
NameDescription
Detail LevelWork relationships, Assignments of a work relationship, or Managers of an assignment
Include AssignmentsInclude assignments in the work relationship list
Work RelationshipRequired for the assignments and managers levels
AssignmentRequired for the managers level
Effective DateThe effective date for the query (default: current date)
Only DataExclude links and metadata from the response
LimitMaximum number of records to return
OffsetNumber of records to skip

Response

The action returns the work relationships, assignments, or managers for the selected level, including their identifiers, dates, and status.


Update Assignment

Applies a promotion, transfer, location, or working-hours change to a worker's assignment. The Agent can leverage the tool (workflow), which has been designed to record assignment changes, once the user provides the new details.

Input Parameters

Here are the input parameters required to set up this action:

Mandatory
NameDescription
WorkerThe worker whose assignment is changing
Work RelationshipThe work relationship the assignment belongs to
AssignmentThe assignment to update
Effective DateMust fall within the date range of the selected assignment row
HR ActionThe HR action the change is recorded as
Optional
NameDescription
Change ModeUpdate (adds a new dated row) or Correction (overwrites the current row)
Action ReasonReason configured for the selected HR action
JobThe new job
GradeThe new grade, filtered by the selected job
DepartmentThe new department
LocationThe new location
PositionThe new position
Business TitleThe worker's business title
Normal HoursWorking hours (requires Hours Frequency)
Hours FrequencyFrequency for the normal hours

Response

Upon successful update, the action returns the updated assignment details.


Change Line Manager

Reassigns a worker to a different line manager. The Agent can leverage the tool (workflow), which has been designed to process a manager change, once the user provides the worker and the new manager.

Input Parameters

Here are the input parameters required to set up this action:

Mandatory
NameDescription
WorkerThe worker whose manager is changing, searchable by person number
Work RelationshipThe worker's work relationship
AssignmentActive or suspended assignment with no pending transaction
New ManagerThe new manager, searchable by name or work email
New Manager AssignmentThe new manager's assignment
HR ActionAction code for the change (ASG_CHANGE is typical)
Effective DateThe date the change takes effect
Optional
NameDescription
Manager TypeThe type of manager relationship
Change ModeUpdate adds a dated row from the effective date; Correction overwrites and requires the effective date to match the current row start date

Response

Upon successful update, the action returns the updated manager details for the assignment.


List Workers by Assignment End Date

Retrieves contingent workers whose assignment ends within a given date window. This action can be leveraged by Leena AI Orchestrator/Agent to flag upcoming contract end dates.

Input Parameters

Here are the input parameters required to set up this action:

Mandatory
NameDescription
Window Start DateStart of the assignment end-date window
Window End DateEnd of the assignment end-date window
Optional
NameDescription
Effective DateDate for which worker data is read (default: current date)
Max Workers ScannedNumber of workers scanned, from 100 to 2000

Response

The action returns the matching workers with their assignment end dates, and whether more workers remain to be scanned.


Personal Information

Update Worker Name

Updates a worker's legal or preferred name. The Agent can leverage the tool (workflow), which has been designed to process a name change, once the user provides the new name.

Input Parameters

Here are the input parameters required to set up this action:

Mandatory
NameDescription
WorkerThe worker whose name is changing, searchable by person number
Name RecordThe name record to update
Effective DateDate from which the name change is effective
Optional
NameDescription
Change ModeUpdate (adds a new dated row) or Correction (overwrites the current row)
Last Name, First Name, Middle Names, Known As, Title, Suffix, Honors, Previous Last NameThe name fields to update (at least one is required)

Response

Upon successful update, the action returns the updated name record.


Manage Worker Address

Creates, updates, or deletes a worker's address. The Agent can leverage the tool (workflow), which has been designed to process address changes, once the user provides the address details.

Input Parameters

Here are the input parameters required to set up this action:

Mandatory
NameDescription
WorkerThe worker, searchable by person number
OperationCreate, update, or delete
Address RecordThe address record (for update and delete)
Effective DateThe date the change takes effect
Address TypeThe type of address (for create)
CountryThe country, which decides the address components Oracle requires
Optional
NameDescription
Change ModeUpdate or Correction (for update)
Delete ModeDELETE_CHANGES end-dates the address; ZAP purges it
Address Line 1–3Address line fields
Town or CityThe city
Region 1County in a US address
Region 2State in a US address
Postal CodeThe postal code
Primary AddressWhether this is the primary address

Response

The action returns the created or updated address record, or a confirmation of the deletion.


Manage Worker Contact

Creates, updates, or deletes a worker's phone numbers and email addresses.

Input Parameters

Here are the input parameters required to set up this action:

Mandatory
NameDescription
WorkerThe worker, searchable by person number
Contact TypePhone or email
OperationCreate, update, or delete (emails of type Work Email cannot be deleted)
Phone Record / Email RecordThe record to update or delete
Phone Type and Phone NumberRequired for phone contacts
Email Type and Email AddressRequired for email contacts
Optional
NameDescription
LegislationRequired when the country code maps to multiple legislations
Country Code NumberThe phone country code
Area CodeThe phone area code
Primary ContactWhether this is the primary phone or email

Response

The action returns the created or updated phone or email record, or a confirmation of the deletion.


Update National ID

Creates, updates, or deletes a worker's national identifiers.

Input Parameters

Here are the input parameters required to set up this action:

Mandatory
NameDescription
WorkerThe worker, searchable by person number
OperationCreate, update, or delete
National ID RecordThe record to update or delete
LegislationCountry the identifier belongs to
Identifier TypeValid types depend on the selected legislation
Identifier NumberThe identifier value
Optional
NameDescription
Issue DateDate the identifier was issued
Expiration DateDate the identifier expires
Place of IssueWhere the identifier was issued
Primary IdentifierOracle requires one primary identifier before non-primary ones can be added

Response

The action returns the created or updated national identifier record, or a confirmation of the deletion.


Update Marital Status

Updates a worker's marital status and legislative information.

Input Parameters

Here are the input parameters required to set up this action:

Mandatory
NameDescription
WorkerThe worker, searchable by person number
Legislative RecordThe legislative information record to update
Effective DateThe date the change takes effect
Optional
NameDescription
Change ModeUpdate or Correction
Marital StatusValid codes depend on the legislation of the selected record
Marital Status Change DateDate the marital status changed
GenderThe worker's gender
Highest Education LevelThe worker's highest education level

Response

Upon successful update, the action returns the updated legislative information record.


Update Ethnicity

Creates, updates, or deletes a worker's ethnicity records.

Input Parameters

Here are the input parameters required to set up this action:

Mandatory
NameDescription
WorkerThe worker, searchable by person number
OperationCreate, update, or delete
Ethnicity RecordThe record to update or delete
LegislationDetermines the valid ethnicity list
EthnicityTenant lookup code, valid for the selected legislation
Optional
NameDescription
Primary EthnicityWhether this is the primary ethnicity

Response

The action returns the created or updated ethnicity record, or a confirmation of the deletion.


Manage Visa and Passport

Retrieves, creates, updates, or deletes a worker's visas and permits, passports, and citizenships.

Input Parameters

Here are the input parameters required to set up this action:

Mandatory
NameDescription
WorkerThe worker, searchable by person number
Record TypeVisas and permits, Passports, or Citizenships
OperationGet records, Create record, Update record, or Delete record
Effective DateRequired for visa updates and deletes (visas are date-effective)
Issuing CountryRequired for visas and passports
Visa or Permit TypeRequired for visas; valid types depend on the issuing country
Citizenship Country and Citizenship StatusRequired for citizenships (status is a tenant lookup code, e.g. 'A' for active)
Optional
NameDescription
Delete ModeEnd date the record, or purge it
Visa or Permit NumberThe visa or permit number
Passport TypeValid types depend on the issuing country
Passport NumberThe passport number
Issue DateDate the document was issued
Expiration DateDate the document expires

Response

The action returns the requested records, the created or updated record, or a confirmation of the deletion.


Compensation & Payroll

Get Salary

Retrieves a worker's current salary and salary history from Oracle Fusion HCM. This action can be leveraged by Leena AI Orchestrator/Agent to answer salary queries for authorised users.

Input Parameters

Here are the input parameters required to set up this action:

Mandatory
NameDescription
WorkerThe worker whose salary is to be retrieved
AssignmentThe assignment the salary is held against
Optional
NameDescription
Lookup ModeCurrent salary (default), As of a date, Over a date range, or Full salary history
Effective DateUsed by the As of a date and Full salary history modes
From DateUsed by the Over a date range mode
To DateUsed by the Over a date range mode
Include Salary ComponentsInclude the component breakdown behind the salary amount

Response

The action returns the salary records for the assignment, including salary ID, amount, currency, salary basis, effective dates, and any requested salary components.


Create or Update Salary

Creates or updates a salary record for a worker in Oracle Fusion HCM. The Agent can leverage the tool (workflow), which has been designed to process a salary change, once the user provides the new salary details.

Input Parameters

Here are the input parameters required to set up this action:

Mandatory
NameDescription
WorkerThe worker whose salary is changing
AssignmentThe worker's assignment
Salary BasisDetermines the pay frequency the amount is expressed in
Salary AmountThe new salary amount
Effective FromThe date the change applies from (a future date is recommended, as the change has no approval step)
ActionThe reason the salary changed
Optional
NameDescription
Salary IDLeave blank to create a new salary record; provide a Salary ID from Get Salary to update an existing one
Currency CodeISO currency code (e.g., USD)
Effective ToEnd date of the salary record (default: open-ended)
Action ReasonAdditional detail behind the action

Response

Upon successful execution, the action returns the created or updated salary record.


Get Eligible Compensation Plans

Retrieves the individual compensation plans and plan options a worker is eligible for. This action is read-only.

Input Parameters

Here are the input parameters required to set up this action:

Mandatory
NameDescription
WorkerThe worker whose eligibility is to be checked
AssignmentThe worker's assignment
Effective DateThe date eligibility is evaluated as of
Optional
NameDescription
ReadEligible plans (default) or Eligible options
Search TermsFilter by plan name

Response

The action returns the eligible compensation plans or plan options for the worker.


Get Payslips

Retrieves a worker's payslips, newest first, with the identifiers needed to download the PDF.

Input Parameters

Here are the input parameters required to set up this action:

Mandatory
NameDescription
WorkerThe worker whose payslips are to be retrieved (only workers on a payroll have payslips)
Optional
NameDescription
Number of PayslipsNumber of payslips to return (default: 12)
Include Document DetailsInclude attachment details (file name and size), required to download the PDF

Response

The action returns a list of payslips with payment date, amount, and document record ID.


Download Payslip PDF

Downloads a payslip PDF from Oracle Fusion HCM and returns it as a file URL. The Agent can leverage the tool (workflow), which has been designed to share a payslip, once the user requests it.

Input Parameters

Here are the input parameters required to set up this action:

Mandatory
NameDescription
PayslipThe payslip to download, labelled by payment date and amount
Optional
NameDescription
WorkerThe worker whose payslips are listed

Response

The action returns a file URL for the payslip PDF.


Get Pay Element Entries

Retrieves payroll element entries, such as allowances and deductions, for a worker.

Input Parameters

Here are the input parameters required to set up this action:

Mandatory
NameDescription
WorkerThe worker, searchable by name or work email
Optional
NameDescription
Only DataExclude links and metadata from the response
LimitMaximum number of records to return
OffsetNumber of records to skip

Response

The action returns the worker's element entries with element name, values, and effective dates.


Payment Methods

Get Personal Payment Methods

Retrieves how a worker's pay is split across bank accounts and payment methods.

Input Parameters

Here are the input parameters required to set up this action:

Mandatory
NameDescription
WorkerThe worker, selected by person number
Assignment NumberThe assignment number (e.g., E300000003102543), available from Get Work Relationships
Optional
NameDescription
As of DateThe date for which payment methods are retrieved (default: today)

Response

The action returns the worker's payment methods, including payment type, bank account, split, and priority.


Create Personal Payment Method

Adds a payment method for a worker. The Agent can leverage the tool (workflow), which has been designed to set up a new pay deposit, once the user provides the payment details.

Input Parameters

Here are the input parameters required to set up this action:

Mandatory
NameDescription
Organization Payment MethodThe payment type and currency
Payroll RelationshipThe worker's payroll relationship
Effective FromThe date the payment method starts
Optional
NameDescription
WorkerUsed to look up the payroll relationship
Assignment NumberUsed to look up the payroll relationship
Bank Account IDRequired for EFT / direct deposit (see Manage External Bank Accounts)
Effective ToEnd date of the payment method (default: open-ended)
NameLabel shown to the employee (e.g., "Primary EFT")
Split TypePercentage or Monetary amount
PercentageUsed when split type is Percentage
AmountUsed when split type is Monetary amount
PriorityProcessing order (lower numbers are paid first)

Response

Upon successful creation, the action returns the created payment method details.


Update Personal Payment Method

Updates the split, priority, or bank account of an existing payment method.

Input Parameters

Here are the input parameters required to set up this action:

Mandatory
NameDescription
Payment MethodThe payment method to update
Change Effective FromThe date the change takes effect
Optional
NameDescription
WorkerUsed to list the worker's payment methods
Assignment NumberUsed to list the worker's payment methods
Change TypeUpdate (keep history) or Correction (overwrite)
PercentageUpdated percentage
AmountUpdated amount
PriorityUpdated priority
Bank Account IDUpdated bank account
NameUpdated label

Response

Upon successful update, the action returns the updated payment method details.


Delete Personal Payment Method

Ends or permanently removes a worker's payment method.

Input Parameters

Here are the input parameters required to set up this action:

Mandatory
NameDescription
Payment MethodThe payment method to remove
Effective FromThe date the payment method ends
Optional
NameDescription
WorkerUsed to list the worker's payment methods
Assignment NumberUsed to list the worker's payment methods
Removal TypeEnd-date the payment method (recommended) or Purge permanently (cannot be undone)

Response

Upon successful execution, the action returns a confirmation of the removal.


Manage External Bank Accounts

Lists, creates, or updates a worker's external bank account, used for payment methods.

Input Parameters

Here are the input parameters required to set up this action:

Mandatory
NameDescription
OperationList / search accounts, Create account, or Update account
Account Owner Party IDThe worker's Party ID (differs from Person ID; available from an existing payment method)
Optional
NameDescription
Bank Account IDRequired for update
Account NumberThe bank account number
Routing / Sort CodeThe branch routing or sort code
Country CodeTwo-character ISO code (e.g., US)
Currency CodeThe account currency
Account TypeChecking or Savings
IntentEmployee, Person, Supplier, or Customer
Account NameThe account name
IBANThe account IBAN

Response

The action returns the matching bank accounts, or the created or updated account including its bank account ID.


Emergency Contacts

Get Emergency Contacts

Retrieves a worker's contacts and emergency contacts.

Input Parameters

Here are the input parameters required to set up this action:

Mandatory
NameDescription
WorkerThe worker, searchable by name or work email
Optional
NameDescription
Emergency Contacts OnlyReturn only emergency contacts
Expand Child ResourcesChild resources to expand in the response
Only DataExclude links and metadata from the response
LimitMaximum number of records to return
OffsetNumber of records to skip

Response

The action returns the worker's contacts with relationship type, emergency and primary flags, and contact details.


Create Emergency Contact

Adds a new emergency or home contact for a worker. The Agent can leverage the tool (workflow), which has been designed to add a contact, once the user provides the contact details.

Input Parameters

Here are the input parameters required to set up this action:

Mandatory
NameDescription
WorkerThe worker the contact belongs to
Relationship TypeTenant relationship code (e.g., 'S' spouse, 'C' child, 'P' parent)
Last NameThe contact's last name
LegislationCountry code for the contact's name record
Optional
NameDescription
First NameThe contact's first name
Emergency ContactWhether the contact is an emergency contact
Primary ContactWhether the contact is the primary contact
Add a Phone NumberToggle to add a phone type and phone number for the contact

Response

Upon successful creation, the action returns the created contact and relationship details.


Update Emergency Contact

Updates a contact's personal details or their relationship to the worker. The Agent can leverage the tool (workflow), which has been designed to modify contact details, once the user provides the fields to be updated.

Input Parameters

Here are the input parameters required to set up this action:

Mandatory
NameDescription
WorkerThe worker the contact belongs to
ContactThe contact to update
What to UpdateRelationship attributes or Person details
Relationship RecordThe relationship record (when updating relationship attributes)
Effective DateThe date the change takes effect
Optional
NameDescription
Change ModeUpdate or Correction
Relationship TypeTenant relationship code (e.g., 'S' spouse)
Emergency ContactWhether the contact is an emergency contact
Primary ContactWhether the contact is the primary contact
Date of BirthThe contact's date of birth
Country of BirthThe contact's country of birth

Response

Upon successful update, the action returns the updated contact or relationship details.


Delete Emergency Contact

Ends a contact's relationship with a worker. Only the relationship is removed; the contact person record remains.

Input Parameters

Here are the input parameters required to set up this action:

Mandatory
NameDescription
WorkerThe worker the contact belongs to
ContactThe contact to remove
Relationship RecordThe relationship to end
Effective DateThe date the relationship ends
Optional
NameDescription
Delete ModeDELETE_CHANGES end-dates the relationship; ZAP purges it

Response

Upon successful deletion, the action returns a confirmation of the deletion.


Goals & Performance

Get Goals

Retrieves a worker's performance goals with their status and progress.

Input Parameters

Here are the input parameters required to set up this action:

Mandatory
NameDescription
WorkerThe worker whose goals are to be retrieved
Optional
NameDescription
Status FilterFilter by goal status code (e.g., IN_PROGRESS; codes vary by instance)
Review PeriodFilter by performance cycle
Maximum GoalsMaximum number of goals to return (default: 50)

Response

The action returns the worker's goals with goal name, goal plan, status, percent complete, and target dates.


Create Goal

Creates a performance goal for a worker or a direct report. The Agent can leverage the tool (workflow), which has been designed to set a new goal, once the user provides the goal details.

Input Parameters

Here are the input parameters required to set up this action:

Mandatory
NameDescription
Goal PlanThe goal plan the goal belongs to
Goal OwnerThe worker the goal is for
AssignmentThe goal owner's assignment (required by Oracle)
Goal NameThe name of the goal
Start DateThe start date of the goal
Optional
NameDescription
Assigned ByThe manager or HRBP assigning the goal
DescriptionThe goal description
Success CriteriaHow success is measured
Target Completion DateThe target completion date
Status CodeThe goal status (default: NOT_STARTED)
WeightingRelative weight of the goal within the plan
Review PeriodThe performance cycle the goal belongs to
Private GoalPrivate goals are visible only to the owner

Response

Upon successful creation, the action returns the created goal details including the goal ID.


Update Goal

Updates the progress, status, target date, or weighting of an existing goal. The Agent can leverage the tool (workflow), which has been designed to update goal progress, once the user provides the details to be updated.

Input Parameters

Here are the input parameters required to set up this action:

Mandatory
NameDescription
Goal PlanThe goal plan the goal belongs to
GoalThe goal to update
Optional
NameDescription
WorkerUsed to list the worker's goals
Percent CompleteUpdated progress
Status CodeUpdated status (e.g., IN_PROGRESS, COMPLETED)
Target Completion DateUpdated target completion date
Actual Completion DateDate the goal was completed
Goal NameUpdated goal name
DescriptionUpdated description
WeightingUpdated weighting
Priority CodeUpdated priority
CommentsComments on the update

Response

Upon successful update, the action returns the updated goal details.


Get Performance Documents

Retrieves a worker's performance documents, including performance improvement plans. This action is read-only.

Input Parameters

Here are the input parameters required to set up this action:

Mandatory
NameDescription
WorkerThe worker whose performance documents are to be retrieved
Optional
NameDescription
Evaluation StatusFilter by evaluation status
Review PeriodFilter by performance cycle
Maximum DocumentsMaximum number of documents to return (default: 25)

Response

The action returns the worker's performance documents with review period, evaluation status, and dates.


Create or Update Check-in Document

Creates or updates a manager–employee check-in document used for performance coaching. The Agent can leverage the tool (workflow), which has been designed to record a check-in, once the user provides the check-in details.

Input Parameters

Here are the input parameters required to set up this action:

Mandatory
NameDescription
OperationCreate check-in or Update check-in
Check-in TemplateThe template the check-in is created from
Optional
NameDescription
Check-in Document IDRequired for update
Document NameThe title of the check-in (e.g., "Check-Ins Apr-June 2026")
WorkerThe employee the check-in is about
ManagerThe manager holding the check-in
Assignment IDThe worker's assignment
Check-in DateThe date of the check-in
Check-in Template NameOverride for the template name (leave blank to use the selected template)
Review PeriodMust match the period the check-in template belongs to

Response

Upon successful execution, the action returns the created or updated check-in document details.


Journeys & Learning

Get Worker Journeys

Retrieves the journeys assigned to a worker, such as onboarding or offboarding, and their tasks.

Input Parameters

Here are the input parameters required to set up this action:

Mandatory
NameDescription
WorkerThe worker, searchable by name or work email
Optional
NameDescription
JourneyLeave empty to list all assigned journeys, or select one to retrieve its tasks
Include Tasks in Journey ListInclude tasks for each journey
Only DataExclude links and metadata from the response
LimitMaximum number of records to return
OffsetNumber of records to skip

Response

The action returns the worker's journeys with status and dates, and their tasks if requested.


Assign Journey

Assigns a journey template to a worker. The Agent can leverage the tool (workflow), which has been designed to start a journey such as onboarding, once the user provides the worker and the journey.

Input Parameters

Here are the input parameters required to set up this action:

Mandatory
NameDescription
WorkerThe worker to assign the journey to
Journey TemplateThe journey template to assign
Optional
NameDescription
Allocation DateThe date the journey is assigned
CommentsComments for the assignment

Response

Upon successful execution, the action returns the assigned journey details.


Get Journey Tasks

Retrieves the tasks within one of a worker's journeys.

Input Parameters

Here are the input parameters required to set up this action:

Mandatory
NameDescription
WorkerThe worker, searchable by name or work email
JourneyThe journey whose tasks are to be retrieved
Optional
NameDescription
Task Status FilterFilter by task status code (e.g., 'INI' for outstanding)
Only DataExclude links and metadata from the response
LimitMaximum number of records to return
OffsetNumber of records to skip

Response

The action returns the journey's tasks with task name, status, owner, and due dates.


Search Learning Catalog

Searches learning courses by title and status.

Input Parameters

Here are the input parameters required to set up this action:

All parameters are optional for this action.

Optional
NameDescription
Course Title ContainsFilter by course title
Course StatusFilter by course status (active courses use ORA_ACTIVE)
Only DataExclude links and metadata from the response
LimitMaximum number of records to return
OffsetNumber of records to skip

Response

The action returns the matching learning courses with title, status, and identifiers.


Get Learner Records

Retrieves a worker's learning assignments and learning history.

Input Parameters

Here are the input parameters required to set up this action:

Mandatory
NameDescription
Query ModeBy worker, or Connection user context (my learnings)
WorkerThe worker (By worker mode)
Learning ViewRequired learnings, Current learnings, Completed learnings, or Learning history (my learnings mode)
Optional
NameDescription
Assignment StatusActive, Completed, or Withdrawn
Include Completion DetailsInclude completion details in the response
Only DataExclude links and metadata from the response
LimitMaximum number of records to return
OffsetNumber of records to skip

Response

The action returns learning assignment records with course, status, due dates, and completion details.


Recruiting

Get Job Requisitions

Retrieves recruiting job requisitions from Oracle Fusion HCM. This action can be leveraged by Leena AI Orchestrator/Agent to list requisitions or filter by specific criteria.

Input Parameters

Here are the input parameters required to set up this action:

All parameters are optional for this action.

Optional
NameDescription
Title ContainsFilter by requisition title
Requisition NumberFilter by exact requisition number (e.g., 1006)
Hiring ManagerFilter by hiring manager
RecruiterFilter by recruiter
Business UnitFilter by business unit
Maximum RequisitionsMaximum number of requisitions to return (default: 25)

Response

The action returns the matching requisitions with requisition number, title, hiring manager, recruiter, location, and status.


Create Job Requisition

Creates a new recruiting job requisition in Oracle Fusion HCM. The Agent can leverage the tool (workflow), which has been designed to open a new position, once the user provides the requisition details.

Input Parameters

Here are the input parameters required to set up this action:

Mandatory
NameDescription
TitleThe requisition title
Hiring ManagerThe hiring manager
RecruiterThe recruiter
Primary LocationWhere the role is based
Phase IDInstance-specific value (copy it from an existing requisition)
State IDInstance-specific value (copy it from an existing requisition)
Recruiting TypeThe recruiting type (e.g., PERMANENT or ORA_HOURLY)
Unlimited OpeningsNo (specify a number) or Yes (unlimited)
Optional
NameDescription
Number of OpeningsRequired when Unlimited Openings is No
Business UnitThe business unit for the requisition
DepartmentThe hiring department
JobThe job profile for the requisition
External DescriptionDescription shown to external candidates
Internal DescriptionDescription shown to internal candidates

Response

Upon successful creation, the action returns the created requisition details including the requisition number.


Benefits

Get Enrollment Opportunities

Retrieves benefit enrollment opportunities available for workers in Oracle Fusion HCM.

Input Parameters

Here are the input parameters required to set up this action:

All parameters are optional for this action.

Optional
NameDescription
Person NameFilter by a specific worker
FieldsSpecific fields to include in the response
ExpandChild resources to expand ("all" or a comma-separated list)
LimitMaximum number of records to return
OffsetNumber of records to skip
Effective DateThe effective date for the query (default: current date)
Only DataExclude links and metadata from the response

Response

The action returns a list of enrollment opportunities including plan types, coverage options, and eligibility information.


Get Benefit Enrollments

Retrieves benefit enrollment records from Oracle Fusion HCM.

Input Parameters

Here are the input parameters required to set up this action:

All parameters are optional for this action.

Optional
NameDescription
WorkerFilter by a specific worker
Plan TypeFilter by a specific benefit plan type
LimitMaximum number of records to return
OffsetNumber of records to skip
ExpandInclude costs, dependents, and providers in the response

Response

The action returns benefit enrollment records including plan details, coverage levels, and enrollment status.


Get Enrollment by ID

Retrieves a specific benefit enrollment record by person.

Input Parameters

Here are the input parameters required to set up this action:

Mandatory
NameDescription
WorkerThe person whose enrollment record is to be retrieved
Optional
NameDescription
Plan TypeFilter by a specific benefit plan type
Enrollment Result IDFilter by a specific enrollment result
ExpandInclude costs, dependents, and providers in the response

Response

The action returns the enrollment record details including plan information, coverage, and enrollment status.


Documents & Letters

Get Document Records

Retrieves a worker's document records, such as employment and visa verification letters.

Input Parameters

Here are the input parameters required to set up this action:

Mandatory
NameDescription
WorkerThe worker whose document records are to be retrieved
Optional
NameDescription
Document TypeFilter by document type (e.g., "Employment Verification")
Include AttachmentsInclude the attached files for each document record
Maximum RecordsMaximum number of records to return (default: 25)

Response

The action returns the worker's document records with document type, name, dates, and attachments if requested.


Generate Verification Letter

Generates an employment or visa verification letter draft for a worker. The Agent can leverage the tool (workflow), which has been designed to produce a verification letter, once the user requests one.

Input Parameters

Here are the input parameters required to set up this action:

Mandatory
NameDescription
WorkerThe worker the letter is for
Optional
NameDescription
Document TypeThe letter template to generate from
Additional AttributesAdditional key/value pairs for the letter template, in JSON format

Response

The action returns the generated letter text (not a rendered PDF).


Notifications & Tasks

Get Pending Approvals

Retrieves workflow tasks awaiting action in the Oracle Fusion BPM worklist for the connected user. This action can be leveraged by Leena AI Orchestrator/Agent to show a user the tasks waiting for their approval.

Input Parameters

Here are the input parameters required to set up this action:

All parameters are optional for this action.

Optional
NameDescription
Whose TasksWhose tasks to list (e.g., MY, GROUP, MY_AND_GROUP, REPORTEES); defaults to the connected user and their groups
StatusFilter by task status (default: ASSIGNED)
KeywordFilter by task title
Maximum TasksMaximum number of tasks to return, 1–100 (default: 25)

Response

The action returns the pending tasks with task ID, title, requester, status, and dates.


Get Notification Content

Retrieves the content of a business process notification (approval task) from Oracle Fusion HCM. This action enables the Agent to fetch pending notification details for display or processing.

Input Parameters

Here are the input parameters required to set up this action:

Mandatory
NameDescription
Task IDThe unique identifier of the notification/task

Response

The action returns the notification content including task details, requester information, and approval context.


Perform Task Action

Performs an approval action on a pending business process task in Oracle Fusion HCM. The Agent can leverage this action to approve, reject, or take other actions on pending workflow tasks.

Input Parameters

Here are the input parameters required to set up this action:

Mandatory
NameDescription
Task IDThe pending task to perform the action on
Approval ActionThe action to perform. Options: Approve, Reject, Request Information, Withdraw, Push Back
Optional
NameDescription
CommentsNotes or comments for the audit trail

Response

Upon successful execution, the action returns the task action result including updated task status and confirmation.


Reference Data

Get LOV Values

Retrieves list of values (LOV) data from Oracle Fusion HCM, such as lookup codes, countries, jobs, departments, and locations. This action can be leveraged by Leena AI Orchestrator/Agent to fetch valid values before calling other actions.

Input Parameters

Here are the input parameters required to set up this action:

Mandatory
NameDescription
LOV ResourceThe list of values to retrieve (e.g., commonLookupsLOV, hcmCountriesLov, jobsLov, gradesLov, departmentsLov, locationsLov, positionsLov, legalEmployersLov)
Lookup TypeRequired for common lookups (e.g., PHONE_TYPE, MAR_STATUS, PER_ETHNICITY)
Optional
NameDescription
LegislationFilter legislation-dependent lookups
Search TermsFilter by search text
JobReturn grades valid for the selected job
Only DataExclude links and metadata from the response
LimitMaximum number of records to return
OffsetNumber of records to skip

Response

The action returns the list of values for the selected resource, each with its code and display name.


Get Finance Business Partner

Retrieves the people responsible for an area, such as finance business partner, HR representative, or payroll representative, for a cost centre or department.

Input Parameters

Here are the input parameters required to set up this action:

Mandatory
NameDescription
Responsibility TypeThe area-of-responsibility code (e.g., HR_REP, PAY_REP)
Optional
NameDescription
Cost CentreFilter by cost centre
Department NameFilter by department
Only DataExclude links and metadata from the response
LimitMaximum number of records to return
OffsetNumber of records to skip

Response

The action returns the responsibility holders with their name, person number, and scope.


Did this page help you?