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:
- Log in to Oracle Fusion Cloud as a Security Administrator
- Create or identify an Integration User:
- Navigate to Tools > Security Console
- Go to the Users tab
- Create a new user or identify an existing integration user account
- Ensure the user has a non-expiring password or a service account configuration
- Assign Required Security Roles:
- In the Security Console, search for your integration user
- Click on the Display Name to access user information
- Click Edit and then Add Role
- 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
- Save and close
- Configure Data Security (if required):
- Navigate to Setup and Maintenance > Tasks > Manage Data Role and Security Profiles
- Create a data role with the appropriate security profiles to control data-level access
- Assign the data role to your integration user
- 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
- Oracle Instance URL: Your Oracle Cloud environment URL (e.g.,
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:
- Log in to the OCI Console as an Identity Domain Administrator
- Open the identity domain linked to your Oracle Fusion instance:
- Navigate to Identity & Security > Domains
- Select the identity domain associated with your Oracle Fusion environment
- Create a Confidential Application:
- Go to Integrated applications and click Add application
- Select Confidential Application and click Launch workflow
- Enter a name (e.g.,
Leena AI Integration) and an optional description, then click Next
- Configure OAuth:
- Under Client configuration, select Configure this application as a client now
- Under Allowed grant types, select Client credentials
- Under Token issuance policy, enable Add resources and click Add scope
- Select the Oracle Fusion Applications resource for your instance and add the scope ending in
urn:opc:resource:consumer::all - Click Next, then Finish
- Activate the application:
- Open the newly created application
- Click Activate and confirm
- Map the application to an Oracle Fusion user:
- In Oracle Fusion, navigate to Tools > Security Console > Users
- Create a user whose username matches the Client ID of the confidential application (Oracle Fusion runs client credentials requests as this user)
- 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)
- 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)
- Oracle Instance URL: Your Oracle Fusion API base URL (e.g.,
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:
- Log in to your Leena AI workspace
- Navigate to Settings > Integrations
- Search for "Oracle Fusion HCM" and select it from the list to add its new connector
- Select the authentication type and configure the connector:
Username and Password
- Select the authentication type: Username and password
- Start configuring the connector:
- Oracle instance URL: Your Oracle Fusion Cloud instance URL (e.g.,
https://your-company.oraclecloud.com) - Username: Integration user's username
- Password: Integration user's password
- Oracle instance URL: Your Oracle Fusion Cloud instance URL (e.g.,
- Click Test Connection to verify the credentials
- Save the connector configuration
OAuth 2.0 Client Credentials
- Select the authentication type: OAuth 2.0 client credentials
- Start configuring the connector:
- Oracle instance URL: Your Oracle Fusion API base URL (e.g.,
https://your-company.fa.ocs.oraclecloud.com) - Client ID: Client ID of the confidential application registered in the OCI IAM identity domain
- Client secret: Client secret issued alongside the Client ID
- Token endpoint URL: Identity domain token endpoint (e.g.,
https://idcs-<id>.identity.oraclecloud.com/oauth2/v1/token) - Scope: Confidential application scope (e.g.,
urn:opc:resource:fa:instanceid=<id>urn:opc:resource:consumer::all)
- Oracle instance URL: Your Oracle Fusion API base URL (e.g.,
- 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
- 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
| Name | Description |
|---|---|
| Person ID | The person for whom the absence is being created |
| Absence Type | The type of absence being requested, from the types available to the selected person |
| Start Date | The start date of the absence |
| End Date | The end date of the absence |
| Legal Entity | The legal entity associated with the worker, loaded automatically for the selected person |
Optional
| Name | Description |
|---|---|
| Start Time | The start time of the absence (partial-day absences) |
| End Time | The end time of the absence (partial-day absences) |
| Start Date Duration | Duration type for the start date: Full day or Half day |
| End Date Duration | Duration type for the end date: Full day or Half day |
| Absence Status | The status of the absence record: Submitted (default) or Saved/draft |
| Supporting Documents | File attachments for the absence request (file name, file URL, data type code) |
| Comments | Additional 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
| Name | Description |
|---|---|
| Absence | The absence record to update, searchable by absence type or status |
Optional
| Name | Description |
|---|---|
| Absence Reason | The reason for the absence |
| Absence Update Status | Submit, or Save/draft |
| New Start Date | The updated start date |
| New End Date | The updated end date |
| Start Time | The updated start time |
| End Time | The updated end time |
| Comments | Updated 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
| Name | Description |
|---|---|
| Absence | The absence record to delete, searchable by absence type or status |
| Cancellation Comments | Reason 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
| Name | Description |
|---|---|
| Person | Filter absences by person |
| Start Date (from) | Filter by absence start date |
| End Date (to) | Filter by absence end date |
| Absence Status | Filter by absence status: Submitted, Saved/draft, Scheduled, In progress, Completed, Withdrawn |
| Approval Status | Filter by approval status: Approved, Pending approval, Rejected, Approval not required |
| Specific Fields | Specific fields to include in the response |
| Expand Child Resources | Child resources to expand in the response |
| Records per Page | Maximum number of records to return |
| Page Number | Page number for pagination |
| Order By | Field to order results by |
| Exclude Links | Exclude links and metadata from the response |
| Include Total Count | Include total result count in the response |
| Advanced Filter Query | Advanced 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
| Name | Description |
|---|---|
| Absence Unique ID | The unique identifier of the absence to retrieve |
Optional
| Name | Description |
|---|---|
| Exclude Links from Response | Exclude 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
| Name | Description |
|---|---|
| Person Name | The person whose absence balance is to be checked |
| Effective Date | The date for which the balance is calculated |
| Assignment | The assignment of the worker |
| User Context | Context 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
| Name | Description |
|---|---|
| Person Name | The person whose applicable absence types are to be retrieved |
Optional
| Name | Description |
|---|---|
| Limit | Maximum number of records to return |
| Offset | Number 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
| Name | Description |
|---|---|
| First Name | The first name of the worker |
| Last Name | The last name of the worker |
| Legislation Code | The legislation code for the worker's country |
| Effective Date | The hire date |
| Legal Employer Name | The legal employer for the worker |
| Worker Type | The type of worker (e.g., Employee, Contingent Worker) |
| Action Code | The hire action code: HIRE or REHIRE |
| Business Unit Name | The business unit for the worker |
| Phone Type | The type of phone number |
| Phone Number | The worker's phone number |
| Email Type | The type of email address |
| Email Address | The worker's email address |
| Address Type | The type of address |
| Country | The country for the worker's address |
Optional
| Name | Description |
|---|---|
| Projected Start Date | Projected start date (required if creating a Pending Worker) |
| Proposed User Person Type | Proposed person type (required if creating a Pending Worker) |
| Address Line 1–4 | Address line fields |
| Town or City | The city of the worker's address |
| Region 1 | County in a US address |
| Region 2 | State in a US address, where Oracle requires it |
| Region 3 | Additional region field |
| Postal Code | The 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
| Name | Description |
|---|---|
| Worker | The worker to update, searchable by person number |
| Effective Date | The effective date for the update |
Optional
| Name | Description |
|---|---|
| Update Personal Information | Toggle to update personal information |
| Date of Birth | Updated date of birth (when updating personal information) |
| Country of Birth | Updated country of birth |
| Update Name | Toggle to update name details |
| Name Record | The name record to update |
| First Name | Updated first name |
| Last Name | Updated last name |
| Update Email | Toggle to update email address |
| Email Record | The email record to update |
| Email Address | Updated email address |
| Update Address | Toggle to update address |
| Address Record | The address record to update |
| Address Line 1–2 | Updated address lines |
| Town or City | Updated city |
| Postal Code | Updated postal code |
| Update Phone | Toggle to update phone number |
| Phone Record | The phone record to update |
| Phone Number | Updated phone number |
| Phone Type | Updated phone type |
| From Date | Effective 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
| Name | Description |
|---|---|
| Effective Date | The effective date for the query (default: current date) |
| Expand Child Resources | Child resources to expand (e.g., names, emails, phones) |
| Fields to Return | Specific fields to include in the response |
| Limit | Maximum number of records to return (max 500) |
| Offset | Number of records to skip |
| Sort By | Field to order results by |
| Sort Order | Sort direction (ascending or descending) |
| Only Data | Exclude 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
| Name | Description |
|---|---|
| Worker | The worker to retrieve, searchable by person number |
Optional
| Name | Description |
|---|---|
| Expand Child Resources | Child resources to expand in the response |
| Effective Date | The effective date for the query |
| Specific Fields to Return | Specific fields to include in the response |
| Only Data | Exclude 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
| Name | Description |
|---|---|
| Worker | The worker to terminate |
| Period of Service | The work relationship to terminate |
| Action Code | The termination action code: Resignation (voluntary), Retirement or Death |
| Termination Date | The effective date of termination |
Optional
| Name | Description |
|---|---|
| Date of Death | Date of death (applicable if action code is Death) |
| Recommended for Rehire | Whether 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
| Name | Description |
|---|---|
| Worker | The worker to look up, searchable by person number |
Optional
| Name | Description |
|---|---|
| Detail Level | Work relationships, Assignments of a work relationship, or Managers of an assignment |
| Include Assignments | Include assignments in the work relationship list |
| Work Relationship | Required for the assignments and managers levels |
| Assignment | Required for the managers level |
| Effective Date | The effective date for the query (default: current date) |
| Only Data | Exclude links and metadata from the response |
| Limit | Maximum number of records to return |
| Offset | Number 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
| Name | Description |
|---|---|
| Worker | The worker whose assignment is changing |
| Work Relationship | The work relationship the assignment belongs to |
| Assignment | The assignment to update |
| Effective Date | Must fall within the date range of the selected assignment row |
| HR Action | The HR action the change is recorded as |
Optional
| Name | Description |
|---|---|
| Change Mode | Update (adds a new dated row) or Correction (overwrites the current row) |
| Action Reason | Reason configured for the selected HR action |
| Job | The new job |
| Grade | The new grade, filtered by the selected job |
| Department | The new department |
| Location | The new location |
| Position | The new position |
| Business Title | The worker's business title |
| Normal Hours | Working hours (requires Hours Frequency) |
| Hours Frequency | Frequency 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
| Name | Description |
|---|---|
| Worker | The worker whose manager is changing, searchable by person number |
| Work Relationship | The worker's work relationship |
| Assignment | Active or suspended assignment with no pending transaction |
| New Manager | The new manager, searchable by name or work email |
| New Manager Assignment | The new manager's assignment |
| HR Action | Action code for the change (ASG_CHANGE is typical) |
| Effective Date | The date the change takes effect |
Optional
| Name | Description |
|---|---|
| Manager Type | The type of manager relationship |
| Change Mode | Update 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
| Name | Description |
|---|---|
| Window Start Date | Start of the assignment end-date window |
| Window End Date | End of the assignment end-date window |
Optional
| Name | Description |
|---|---|
| Effective Date | Date for which worker data is read (default: current date) |
| Max Workers Scanned | Number 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
| Name | Description |
|---|---|
| Worker | The worker whose name is changing, searchable by person number |
| Name Record | The name record to update |
| Effective Date | Date from which the name change is effective |
Optional
| Name | Description |
|---|---|
| Change Mode | Update (adds a new dated row) or Correction (overwrites the current row) |
| Last Name, First Name, Middle Names, Known As, Title, Suffix, Honors, Previous Last Name | The 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
| Name | Description |
|---|---|
| Worker | The worker, searchable by person number |
| Operation | Create, update, or delete |
| Address Record | The address record (for update and delete) |
| Effective Date | The date the change takes effect |
| Address Type | The type of address (for create) |
| Country | The country, which decides the address components Oracle requires |
Optional
| Name | Description |
|---|---|
| Change Mode | Update or Correction (for update) |
| Delete Mode | DELETE_CHANGES end-dates the address; ZAP purges it |
| Address Line 1–3 | Address line fields |
| Town or City | The city |
| Region 1 | County in a US address |
| Region 2 | State in a US address |
| Postal Code | The postal code |
| Primary Address | Whether 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
| Name | Description |
|---|---|
| Worker | The worker, searchable by person number |
| Contact Type | Phone or email |
| Operation | Create, update, or delete (emails of type Work Email cannot be deleted) |
| Phone Record / Email Record | The record to update or delete |
| Phone Type and Phone Number | Required for phone contacts |
| Email Type and Email Address | Required for email contacts |
Optional
| Name | Description |
|---|---|
| Legislation | Required when the country code maps to multiple legislations |
| Country Code Number | The phone country code |
| Area Code | The phone area code |
| Primary Contact | Whether 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
| Name | Description |
|---|---|
| Worker | The worker, searchable by person number |
| Operation | Create, update, or delete |
| National ID Record | The record to update or delete |
| Legislation | Country the identifier belongs to |
| Identifier Type | Valid types depend on the selected legislation |
| Identifier Number | The identifier value |
Optional
| Name | Description |
|---|---|
| Issue Date | Date the identifier was issued |
| Expiration Date | Date the identifier expires |
| Place of Issue | Where the identifier was issued |
| Primary Identifier | Oracle 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
| Name | Description |
|---|---|
| Worker | The worker, searchable by person number |
| Legislative Record | The legislative information record to update |
| Effective Date | The date the change takes effect |
Optional
| Name | Description |
|---|---|
| Change Mode | Update or Correction |
| Marital Status | Valid codes depend on the legislation of the selected record |
| Marital Status Change Date | Date the marital status changed |
| Gender | The worker's gender |
| Highest Education Level | The 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
| Name | Description |
|---|---|
| Worker | The worker, searchable by person number |
| Operation | Create, update, or delete |
| Ethnicity Record | The record to update or delete |
| Legislation | Determines the valid ethnicity list |
| Ethnicity | Tenant lookup code, valid for the selected legislation |
Optional
| Name | Description |
|---|---|
| Primary Ethnicity | Whether 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
| Name | Description |
|---|---|
| Worker | The worker, searchable by person number |
| Record Type | Visas and permits, Passports, or Citizenships |
| Operation | Get records, Create record, Update record, or Delete record |
| Effective Date | Required for visa updates and deletes (visas are date-effective) |
| Issuing Country | Required for visas and passports |
| Visa or Permit Type | Required for visas; valid types depend on the issuing country |
| Citizenship Country and Citizenship Status | Required for citizenships (status is a tenant lookup code, e.g. 'A' for active) |
Optional
| Name | Description |
|---|---|
| Delete Mode | End date the record, or purge it |
| Visa or Permit Number | The visa or permit number |
| Passport Type | Valid types depend on the issuing country |
| Passport Number | The passport number |
| Issue Date | Date the document was issued |
| Expiration Date | Date 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
| Name | Description |
|---|---|
| Worker | The worker whose salary is to be retrieved |
| Assignment | The assignment the salary is held against |
Optional
| Name | Description |
|---|---|
| Lookup Mode | Current salary (default), As of a date, Over a date range, or Full salary history |
| Effective Date | Used by the As of a date and Full salary history modes |
| From Date | Used by the Over a date range mode |
| To Date | Used by the Over a date range mode |
| Include Salary Components | Include 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
| Name | Description |
|---|---|
| Worker | The worker whose salary is changing |
| Assignment | The worker's assignment |
| Salary Basis | Determines the pay frequency the amount is expressed in |
| Salary Amount | The new salary amount |
| Effective From | The date the change applies from (a future date is recommended, as the change has no approval step) |
| Action | The reason the salary changed |
Optional
| Name | Description |
|---|---|
| Salary ID | Leave blank to create a new salary record; provide a Salary ID from Get Salary to update an existing one |
| Currency Code | ISO currency code (e.g., USD) |
| Effective To | End date of the salary record (default: open-ended) |
| Action Reason | Additional 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
| Name | Description |
|---|---|
| Worker | The worker whose eligibility is to be checked |
| Assignment | The worker's assignment |
| Effective Date | The date eligibility is evaluated as of |
Optional
| Name | Description |
|---|---|
| Read | Eligible plans (default) or Eligible options |
| Search Terms | Filter 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
| Name | Description |
|---|---|
| Worker | The worker whose payslips are to be retrieved (only workers on a payroll have payslips) |
Optional
| Name | Description |
|---|---|
| Number of Payslips | Number of payslips to return (default: 12) |
| Include Document Details | Include 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
| Name | Description |
|---|---|
| Payslip | The payslip to download, labelled by payment date and amount |
Optional
| Name | Description |
|---|---|
| Worker | The 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
| Name | Description |
|---|---|
| Worker | The worker, searchable by name or work email |
Optional
| Name | Description |
|---|---|
| Only Data | Exclude links and metadata from the response |
| Limit | Maximum number of records to return |
| Offset | Number 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
| Name | Description |
|---|---|
| Worker | The worker, selected by person number |
| Assignment Number | The assignment number (e.g., E300000003102543), available from Get Work Relationships |
Optional
| Name | Description |
|---|---|
| As of Date | The 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
| Name | Description |
|---|---|
| Organization Payment Method | The payment type and currency |
| Payroll Relationship | The worker's payroll relationship |
| Effective From | The date the payment method starts |
Optional
| Name | Description |
|---|---|
| Worker | Used to look up the payroll relationship |
| Assignment Number | Used to look up the payroll relationship |
| Bank Account ID | Required for EFT / direct deposit (see Manage External Bank Accounts) |
| Effective To | End date of the payment method (default: open-ended) |
| Name | Label shown to the employee (e.g., "Primary EFT") |
| Split Type | Percentage or Monetary amount |
| Percentage | Used when split type is Percentage |
| Amount | Used when split type is Monetary amount |
| Priority | Processing 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
| Name | Description |
|---|---|
| Payment Method | The payment method to update |
| Change Effective From | The date the change takes effect |
Optional
| Name | Description |
|---|---|
| Worker | Used to list the worker's payment methods |
| Assignment Number | Used to list the worker's payment methods |
| Change Type | Update (keep history) or Correction (overwrite) |
| Percentage | Updated percentage |
| Amount | Updated amount |
| Priority | Updated priority |
| Bank Account ID | Updated bank account |
| Name | Updated 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
| Name | Description |
|---|---|
| Payment Method | The payment method to remove |
| Effective From | The date the payment method ends |
Optional
| Name | Description |
|---|---|
| Worker | Used to list the worker's payment methods |
| Assignment Number | Used to list the worker's payment methods |
| Removal Type | End-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
| Name | Description |
|---|---|
| Operation | List / search accounts, Create account, or Update account |
| Account Owner Party ID | The worker's Party ID (differs from Person ID; available from an existing payment method) |
Optional
| Name | Description |
|---|---|
| Bank Account ID | Required for update |
| Account Number | The bank account number |
| Routing / Sort Code | The branch routing or sort code |
| Country Code | Two-character ISO code (e.g., US) |
| Currency Code | The account currency |
| Account Type | Checking or Savings |
| Intent | Employee, Person, Supplier, or Customer |
| Account Name | The account name |
| IBAN | The 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
| Name | Description |
|---|---|
| Worker | The worker, searchable by name or work email |
Optional
| Name | Description |
|---|---|
| Emergency Contacts Only | Return only emergency contacts |
| Expand Child Resources | Child resources to expand in the response |
| Only Data | Exclude links and metadata from the response |
| Limit | Maximum number of records to return |
| Offset | Number 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
| Name | Description |
|---|---|
| Worker | The worker the contact belongs to |
| Relationship Type | Tenant relationship code (e.g., 'S' spouse, 'C' child, 'P' parent) |
| Last Name | The contact's last name |
| Legislation | Country code for the contact's name record |
Optional
| Name | Description |
|---|---|
| First Name | The contact's first name |
| Emergency Contact | Whether the contact is an emergency contact |
| Primary Contact | Whether the contact is the primary contact |
| Add a Phone Number | Toggle 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
| Name | Description |
|---|---|
| Worker | The worker the contact belongs to |
| Contact | The contact to update |
| What to Update | Relationship attributes or Person details |
| Relationship Record | The relationship record (when updating relationship attributes) |
| Effective Date | The date the change takes effect |
Optional
| Name | Description |
|---|---|
| Change Mode | Update or Correction |
| Relationship Type | Tenant relationship code (e.g., 'S' spouse) |
| Emergency Contact | Whether the contact is an emergency contact |
| Primary Contact | Whether the contact is the primary contact |
| Date of Birth | The contact's date of birth |
| Country of Birth | The 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
| Name | Description |
|---|---|
| Worker | The worker the contact belongs to |
| Contact | The contact to remove |
| Relationship Record | The relationship to end |
| Effective Date | The date the relationship ends |
Optional
| Name | Description |
|---|---|
| Delete Mode | DELETE_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
| Name | Description |
|---|---|
| Worker | The worker whose goals are to be retrieved |
Optional
| Name | Description |
|---|---|
| Status Filter | Filter by goal status code (e.g., IN_PROGRESS; codes vary by instance) |
| Review Period | Filter by performance cycle |
| Maximum Goals | Maximum 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
| Name | Description |
|---|---|
| Goal Plan | The goal plan the goal belongs to |
| Goal Owner | The worker the goal is for |
| Assignment | The goal owner's assignment (required by Oracle) |
| Goal Name | The name of the goal |
| Start Date | The start date of the goal |
Optional
| Name | Description |
|---|---|
| Assigned By | The manager or HRBP assigning the goal |
| Description | The goal description |
| Success Criteria | How success is measured |
| Target Completion Date | The target completion date |
| Status Code | The goal status (default: NOT_STARTED) |
| Weighting | Relative weight of the goal within the plan |
| Review Period | The performance cycle the goal belongs to |
| Private Goal | Private 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
| Name | Description |
|---|---|
| Goal Plan | The goal plan the goal belongs to |
| Goal | The goal to update |
Optional
| Name | Description |
|---|---|
| Worker | Used to list the worker's goals |
| Percent Complete | Updated progress |
| Status Code | Updated status (e.g., IN_PROGRESS, COMPLETED) |
| Target Completion Date | Updated target completion date |
| Actual Completion Date | Date the goal was completed |
| Goal Name | Updated goal name |
| Description | Updated description |
| Weighting | Updated weighting |
| Priority Code | Updated priority |
| Comments | Comments 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
| Name | Description |
|---|---|
| Worker | The worker whose performance documents are to be retrieved |
Optional
| Name | Description |
|---|---|
| Evaluation Status | Filter by evaluation status |
| Review Period | Filter by performance cycle |
| Maximum Documents | Maximum 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
| Name | Description |
|---|---|
| Operation | Create check-in or Update check-in |
| Check-in Template | The template the check-in is created from |
Optional
| Name | Description |
|---|---|
| Check-in Document ID | Required for update |
| Document Name | The title of the check-in (e.g., "Check-Ins Apr-June 2026") |
| Worker | The employee the check-in is about |
| Manager | The manager holding the check-in |
| Assignment ID | The worker's assignment |
| Check-in Date | The date of the check-in |
| Check-in Template Name | Override for the template name (leave blank to use the selected template) |
| Review Period | Must 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
| Name | Description |
|---|---|
| Worker | The worker, searchable by name or work email |
Optional
| Name | Description |
|---|---|
| Journey | Leave empty to list all assigned journeys, or select one to retrieve its tasks |
| Include Tasks in Journey List | Include tasks for each journey |
| Only Data | Exclude links and metadata from the response |
| Limit | Maximum number of records to return |
| Offset | Number 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
| Name | Description |
|---|---|
| Worker | The worker to assign the journey to |
| Journey Template | The journey template to assign |
Optional
| Name | Description |
|---|---|
| Allocation Date | The date the journey is assigned |
| Comments | Comments 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
| Name | Description |
|---|---|
| Worker | The worker, searchable by name or work email |
| Journey | The journey whose tasks are to be retrieved |
Optional
| Name | Description |
|---|---|
| Task Status Filter | Filter by task status code (e.g., 'INI' for outstanding) |
| Only Data | Exclude links and metadata from the response |
| Limit | Maximum number of records to return |
| Offset | Number 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
| Name | Description |
|---|---|
| Course Title Contains | Filter by course title |
| Course Status | Filter by course status (active courses use ORA_ACTIVE) |
| Only Data | Exclude links and metadata from the response |
| Limit | Maximum number of records to return |
| Offset | Number 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
| Name | Description |
|---|---|
| Query Mode | By worker, or Connection user context (my learnings) |
| Worker | The worker (By worker mode) |
| Learning View | Required learnings, Current learnings, Completed learnings, or Learning history (my learnings mode) |
Optional
| Name | Description |
|---|---|
| Assignment Status | Active, Completed, or Withdrawn |
| Include Completion Details | Include completion details in the response |
| Only Data | Exclude links and metadata from the response |
| Limit | Maximum number of records to return |
| Offset | Number 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
| Name | Description |
|---|---|
| Title Contains | Filter by requisition title |
| Requisition Number | Filter by exact requisition number (e.g., 1006) |
| Hiring Manager | Filter by hiring manager |
| Recruiter | Filter by recruiter |
| Business Unit | Filter by business unit |
| Maximum Requisitions | Maximum 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
| Name | Description |
|---|---|
| Title | The requisition title |
| Hiring Manager | The hiring manager |
| Recruiter | The recruiter |
| Primary Location | Where the role is based |
| Phase ID | Instance-specific value (copy it from an existing requisition) |
| State ID | Instance-specific value (copy it from an existing requisition) |
| Recruiting Type | The recruiting type (e.g., PERMANENT or ORA_HOURLY) |
| Unlimited Openings | No (specify a number) or Yes (unlimited) |
Optional
| Name | Description |
|---|---|
| Number of Openings | Required when Unlimited Openings is No |
| Business Unit | The business unit for the requisition |
| Department | The hiring department |
| Job | The job profile for the requisition |
| External Description | Description shown to external candidates |
| Internal Description | Description 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
| Name | Description |
|---|---|
| Person Name | Filter by a specific worker |
| Fields | Specific fields to include in the response |
| Expand | Child resources to expand ("all" or a comma-separated list) |
| Limit | Maximum number of records to return |
| Offset | Number of records to skip |
| Effective Date | The effective date for the query (default: current date) |
| Only Data | Exclude 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
| Name | Description |
|---|---|
| Worker | Filter by a specific worker |
| Plan Type | Filter by a specific benefit plan type |
| Limit | Maximum number of records to return |
| Offset | Number of records to skip |
| Expand | Include 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
| Name | Description |
|---|---|
| Worker | The person whose enrollment record is to be retrieved |
Optional
| Name | Description |
|---|---|
| Plan Type | Filter by a specific benefit plan type |
| Enrollment Result ID | Filter by a specific enrollment result |
| Expand | Include 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
| Name | Description |
|---|---|
| Worker | The worker whose document records are to be retrieved |
Optional
| Name | Description |
|---|---|
| Document Type | Filter by document type (e.g., "Employment Verification") |
| Include Attachments | Include the attached files for each document record |
| Maximum Records | Maximum 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
| Name | Description |
|---|---|
| Worker | The worker the letter is for |
Optional
| Name | Description |
|---|---|
| Document Type | The letter template to generate from |
| Additional Attributes | Additional 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
| Name | Description |
|---|---|
| Whose Tasks | Whose tasks to list (e.g., MY, GROUP, MY_AND_GROUP, REPORTEES); defaults to the connected user and their groups |
| Status | Filter by task status (default: ASSIGNED) |
| Keyword | Filter by task title |
| Maximum Tasks | Maximum 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
| Name | Description |
|---|---|
| Task ID | The 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
| Name | Description |
|---|---|
| Task ID | The pending task to perform the action on |
| Approval Action | The action to perform. Options: Approve, Reject, Request Information, Withdraw, Push Back |
Optional
| Name | Description |
|---|---|
| Comments | Notes 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
| Name | Description |
|---|---|
| LOV Resource | The list of values to retrieve (e.g., commonLookupsLOV, hcmCountriesLov, jobsLov, gradesLov, departmentsLov, locationsLov, positionsLov, legalEmployersLov) |
| Lookup Type | Required for common lookups (e.g., PHONE_TYPE, MAR_STATUS, PER_ETHNICITY) |
Optional
| Name | Description |
|---|---|
| Legislation | Filter legislation-dependent lookups |
| Search Terms | Filter by search text |
| Job | Return grades valid for the selected job |
| Only Data | Exclude links and metadata from the response |
| Limit | Maximum number of records to return |
| Offset | Number 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
| Name | Description |
|---|---|
| Responsibility Type | The area-of-responsibility code (e.g., HR_REP, PAY_REP) |
Optional
| Name | Description |
|---|---|
| Cost Centre | Filter by cost centre |
| Department Name | Filter by department |
| Only Data | Exclude links and metadata from the response |
| Limit | Maximum number of records to return |
| Offset | Number of records to skip |
Response
The action returns the responsibility holders with their name, person number, and scope.
Updated about 13 hours ago
