View My Salary Information

You may maintain salary information in Oracle HCM Cloud applications but use an on-premise application for employees to view their salary information. You can use the salaries REST service to retrieve the salary information. This use case describes the scenarios where you use the salaries REST service to show an employee their current salary information.

Let's discuss these scenarios:

  • View my salary
  • View my salary components
  • View my salary standard components
  • View my salary advanced components

Here's a typical application processing flow for the scenarios:

  1. You configure a salary basis according to your organizational requirements.
  2. You maintain employees' salaries using the salary basis in Oracle HCM Cloud.
  3. When an employee wants to see their salary information, the application makes a REST service call to Oracle HCM Cloud and returns appropriate data.

View My Salary

Let's say that Jen is applying for a loan and wants to confirm her current salary, which is maintained in Oracle HCM Cloud.

To retrieve the salary information maintained in Oracle HCM Cloud::

  1. Perform a GET operation on the URL for the salaries resource.
  2. Verify the details returned in the response.

Example URL

Use this resource URL format.

GET

/hcmRestApi/resources/11.13.18.05/salaries

Example Response

Here's an example of the response body in JSON format.

{
"items": [
{
  "AssignmentId": 100000017107233,
  "SalaryId": 100000017369524,
  "SalaryBasisId": 100010024999994,
  "SalaryFrequencyCode": null,
  "SalaryBasisType": null,
  "CurrencyCode": null,
  "DateFrom": "2009-06-01",
  "DateTo": "4712-12-31",
  "SalaryAmount": 67500,
  "AdjustmentAmount": null,
  "AdjustmentPercentage": null,
  "AnnualSalary": 67500,
  "AnnualFullTimeSalary": 67500,
  "Quartile": null,
  "Quintile": null,
  "CompaRatio": null,
  "RangePosition": null,
  "SalaryRangeMinimum": null,
  "SalaryRangeMidPoint": null,
  "SalaryRangeMaximum": null,
  "SearchDate": null,
  "FrequencyName": "Annually",
  "AssignmentNumber": "EEEEE100000017107211",
  "DisplayName": "Annual Basis",
  "ActionId": 100010026278062,
  "ActionReasonId": null,
  "ActionCode": "CHANGE_SALARY",
  "ActionReasonCode": null,
  "ActionReason": null,
  "ActionName": "Change Salary",
  "Code": "Annual_Basis",
  "links": [
     {
       ...}
  ]
}

View My Salary Components

Let's say that Jen recently got a cost of living increase to her salary. She wants to see the amount of increase, and if any other salary components have changed.

To retrieve the salary component information maintained in Oracle HCM Cloud:

  1. Perform a GET operation on the salaryComponents child resource.
  2. Verify the details returned in the response.

Example URL

Use this resource URL format.

GET

/hcmRestApi/resources/11.13.18.05/salaries/300100189653153/child/salaryComponents

Example Response

Here's an example of the response body in JSON format.

{
"items": [
 {
  "SalaryComponentId": 300100189653156,
  "SalaryId": 300100189653153,
  "ComponentReasonCode": "COST_OF_LIVING",
  "AdjustmentAmount": 700,
  "AdjustmentPercentage": 0,
  "links": [
     {
       ...}
  ]
}

View My Salary Standard Components

Jen recently received a salary change. She wants to see the amount of increase, and if any other standard components have changed.

To retrieve the salary standard component information maintained in Oracle HCM Cloud:

  1. Perform a GET operation on the salarySimpleComponents child resource.
  2. Verify the details returned in the response.

Example URL

Use this resource URL format.

GET
/hcmRestApi/resources/11.13.18.05/salaries/{SalaryId}/child/salarySimpleComponents

Example Response

Here's an example of the response body in JSON format.

{
  "items": [
    {
      "Amount": 7500,
      "AnnualAmount": 7500,
      "AnnualFtAmount": 7500,
      "BasedOnComponentCode": null,
      "BasisSimpleComponentId": 300100217826885,
      "ComponentCode": "ORA_HOUSING_ALLOWANCE",
      "CurrencyCode": "USD",
      "DisplaySequence": 20,
      "Percentage": null,
      "SalaryId": 300100217827041,
      "SimpleSalaryCompntId": 300100217827043,
      "ComponentName": "Housing allowance",
      "BasedOnComponentName": null,
      "links": [
         {
           ...}
      ]
    },
    {
      "Amount": 17500,
      "AnnualAmount": 17500,
      "AnnualFtAmount": 17500,
      "BasedOnComponentCode": null,
      "BasisSimpleComponentId": 300100217826888,
      "ComponentCode": "ORA_OVERALL_SALARY",
      "CurrencyCode": "USD",
      "DisplaySequence": 30,
      "Percentage": null,
      "SalaryId": 300100217827041,
      "SimpleSalaryCompntId": 300100217827044,
      "ComponentName": "Overall salary",
      "BasedOnComponentName": null,
      "links": [
         {
           ...}
      ]
    },
    {
      "Amount": 10000,
      "AnnualAmount": 10000,
      "AnnualFtAmount": 10000,
      "BasedOnComponentCode": null,
      "BasisSimpleComponentId": 300100217826883,
      "ComponentCode": "ORA_BASIC",
      "CurrencyCode": "USD",
      "DisplaySequence": 10,
      "Percentage": null,
      "SalaryId": 300100217827041,
      "SimpleSalaryCompntId": 300100217827042,
      "ComponentName": "Basic salary",
      "BasedOnComponentName": null,
      "links": [
         {
           ...}
  ]
}

View My Salary Advanced Components

Note:

Salary basis type in the salary is determined by rates, which is a controlled available functionality.

With her recent salary change, Jen also wants to see if any other advanced components have changed.

To retrieve the salary advanced component information maintained in Oracle HCM Cloud:

  1. Perform a GET operation on the salaryPayRateComponents child resource.
  2. Verify the details returned in the response.

Example URL

Use this resource URL format.

GET
/hcmRestApi/resources/11.13.18.05/{SalaryId}/child/salaryPayRateComponents

Example Response

Here's an example of the response body in JSON format.

{
  "items": [
    {
      "SalaryId": 300100216841830,
      "SalaryPayComponentId": 300100216841833,
      "PayRateDefinitionId": 300100090346289,
      "RateDisplaySequence": 30,
      "RateType": "ET",
      "RateAmount": 1500,
      "RateFactor": null,
      "RatePeriodicityCode": "Calendar Month",
      "RateCurrencyCode": "USD",
      "RateAnnualAmount": 18000,
      "RateAnnualFtAmount": 18000,
      "Name": "RJS1_Rate_Incentive",
      "FTEFlag": false,
      "RateOverallSalaryFlag": null,
      "ShortName": "RJS1_RATE_INCENTIVE",
      "links": [
         {
           ...}
      ]
    },
    {
      "SalaryId": 300100216841830,
      "SalaryPayComponentId": 300100216841832,
      "PayRateDefinitionId": 300100090458059,
      "RateDisplaySequence": 20,
      "RateType": "ET",
      "RateAmount": 25000,
      "RateFactor": null,
      "RatePeriodicityCode": "Year",
      "RateCurrencyCode": "USD",
      "RateAnnualAmount": 25000,
      "RateAnnualFtAmount": 25000,
      "Name": "RJS1_Rate_Allowance_1",
      "FTEFlag": false,
      "RateOverallSalaryFlag": null,
      "ShortName": "RJS1_RATE_ALLOWANCE_1",
      "links": [
         {
           ...}
      ]
    },
    {
      "SalaryId": 300100216841830,
      "SalaryPayComponentId": 300100216841831,
      "PayRateDefinitionId": 300100090338534,
      "RateDisplaySequence": 10,
      "RateType": "ET",
      "RateAmount": 50000,
      "RateFactor": null,
      "RatePeriodicityCode": "Year",
      "RateCurrencyCode": "USD",
      "RateAnnualAmount": 50000,
      "RateAnnualFtAmount": 50000,
      "Name": "RJS1_Rate_Annual_Base",
      "FTEFlag": false,
      "RateOverallSalaryFlag": null,
      "ShortName": "RJS1_RATE_ANNUAL_BASE",
      "links": [
         {
           ...}
      ]
    },
    {
      "SalaryId": 300100216841830,
      "SalaryPayComponentId": 300100216841834,
      "PayRateDefinitionId": 300100090458558,
      "RateDisplaySequence": 40,
      "RateType": "DRT",
      "RateAmount": 93000,
      "RateFactor": null,
      "RatePeriodicityCode": "Year",
      "RateCurrencyCode": "USD",
      "RateAnnualAmount": 93000,
      "RateAnnualFtAmount": 93000,
      "Name": "RJS1_Rate_Overall_Salary",
      "FTEFlag": false,
      "RateOverallSalaryFlag": true,
      "ShortName": "RJS1_RATE_OVERALL_SALARY",
      "links": [
         {
           ...}
  ]
}