1. Oracle Global Human Resources Cloud REST APIREST API for Oracle Fusion Cloud HCM
  2. Use Cases
  3. Compensation
  4. View Someone's Salary Information

View Someone's Salary Information

You may maintain the salary information within Oracle HCM Cloud applications but use an on-premise application to show line managers and HR representatives the salary information of their employees. This use case describes the scenarios where you use the salaries REST resource to retrieve the salary information of someone whose salary information you're allowed to see.

Let's discuss these scenarios:

  • View someone's current salary
  • View someone's current salary and analytical information
  • View someone's salary history
  • View someone's salary components
  • View someone's salary standard components
  • View someone's 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 line managers or HR representatives want to see this information for the people they manage, the application makes a REST service call to Oracle HCM Cloud and returns appropriate data.

View Someone's Current Salary

Let's say that Bill is Jen's line manager and he wants to see Jen's current salary information. He has permission to see her salary information, but doesn't have permission to see the associated analytics information, such as compa-ratio and salary range.

To retrieve the salary information maintained in Oracle HCM Cloud:

  1. Perform a GET operation on the employee's assignment using 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?finder=findByAssignmentIdAndDate;AssignmentId={AssignmentId},EffectiveDate={EffectiveDate}&onlyData=true&orderBy=DateFrom:desc

Example Response

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

{
"items": [
 {
  "AssignmentId": 100000017125422,
  "SalaryId": 100000017125425,
  "SalaryBasisId": 100010024999994,
  "SalaryFrequencyCode": null,
  "SalaryBasisType": null,
  "CurrencyCode": null,
  "DateFrom": "2005-04-30",
  "DateTo": "4712-12-31",
  "SalaryAmount": 70000,
  "AdjustmentAmount": null,
  "AdjustmentPercentage": null,
  "AnnualSalary": 70000,
  "AnnualFullTimeSalary": 70000,
  "Quartile": null,
  "Quintile": null,
  "CompaRatio": null,
  "RangePosition": null,
  "SalaryRangeMinimum": null,
  "SalaryRangeMidPoint": null,
  "SalaryRangeMaximum": null,
  "SearchDate": null,
  "FrequencyName": "Annually",
  "AssignmentNumber": "EEEEE100000017125400",
  "DisplayName": "Annual Basis",
  "ActionId": 100010026278066,
  "ActionReasonId": null,
  "ActionCode": "HIRE",
  "ActionReasonCode": null,
  "ActionReason": null,
  "ActionName": "Hire",
  "Code": "Annual_Basis"
  "links": [
     {
     ...}
  ]
}

View Someone's Current Salary and Analytical Information

Let's say that Mark is Jen's HR representative, and he wants to see Jen's current salary and analytical information. He has the permissions to see her salary information and the associated analytics information, such as compa-ratio and salary range.

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

  1. Perform a GET operation on Jen's assignment using 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?finder=findByAssignmentIdAndDate;AssignmentId={AssignmentId},EffectiveDate={EffectiveDate}&onlyData=true&orderBy=DateFrom:desc

Example Response

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

{
"items": [
 {
  "AssignmentId": 100000017125422,
  "SalaryId": 100000017125425,
  "SalaryBasisId": 100010024999994,
  "SalaryFrequencyCode": null,
  "SalaryBasisType": null,
  "CurrencyCode": null,
  "DateFrom": "2005-04-30",
  "DateTo": "4712-12-31",
  "SalaryAmount": 70000,
  "AdjustmentAmount": null,
  "AdjustmentPercentage": null,
  "AnnualSalary": 70000,
  "AnnualFullTimeSalary": 70000,
  "Quartile": "4",
  "Quintile": "5",
  "CompaRatio": 106.06,
  "RangePosition": 83.33,
  "SalaryRangeMinimum": 60000,
  "SalaryRangeMidPoint": 66000,
  "SalaryRangeMaximum": 72000,
  "SearchDate": null,
  "FrequencyName": "Annually",
  "AssignmentNumber": "EEEEE100000017125400",
  "DisplayName": "Annual Basis",
  "ActionId": 100010026278066,
  "ActionReasonId": null,
  "ActionCode": "HIRE",
  "ActionReasonCode": null,
  "ActionReason": null,
  "ActionName": "Hire",
  "Code": "Annual_Basis"
  "links": [
     {
     ...}
  ]
}

View Someone's Salary History

Mark also wants to see Jen's salary history for her current assignment along with the corresponding analytical information.

To retrieve the salary history maintained in Oracle HCM Cloud:

  1. Perform a GET operation on Jen's assignment using 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?finder=findByAssignmentId;AssignmentId={AssignmentId}&onlyData=true&orderBy=DateFrom:desc

Example Response

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

{
    "items": [
        {
            "AssignmentId": 300100093867717,
            "SalaryId": 300100203735932,
            "SalaryBasisId": 300100001799078,
            "SalaryFrequencyCode": "ANNUAL",
            "SalaryBasisType": "U",
            "CurrencyCode": "USD",
            "DateFrom": "2014-01-01",
            "DateTo": "4712-12-31",
            "SalaryAmount": 99000,
            "AdjustmentAmount": 9000,
            "AdjustmentPercentage": 10,
            "AnnualSalary": 99000,
            "AnnualFullTimeSalary": 99000,
            "Quartile": "2",
            "Quintile": "2",
            "CompaRatio": 95.19,
            "RangePosition": 37.98,
            "SalaryRangeMinimum": 83200,
            "SalaryRangeMidPoint": 104000,
            "SalaryRangeMaximum": 124800,
            "SearchDate": null,
            "FrequencyName": "Annually",
            "AssignmentNumber": "E966169008889152",
            "DisplayName": "ZCMP US STD Salary Annually",
            "ActionId": 100010026278849,
            "ActionReasonId": null,
            "ActionCode": "CHANGE_SALARY",
            "ActionReasonCode": null,
            "ActionReason": null,
            "ActionName": "Change Salary",
            "Code": "ZCMP_US_STD_Salary_Annually"
        },
        {
            "AssignmentId": 300100093867717,
            "SalaryId": 300100203735819,
            "SalaryBasisId": 300100001799078,
            "SalaryFrequencyCode": "ANNUAL",
            "SalaryBasisType": "U",
            "CurrencyCode": "USD",
            "DateFrom": "2012-01-01",
            "DateTo": "2013-12-31",
            "SalaryAmount": 90000,
            "AdjustmentAmount": 6800,
            "AdjustmentPercentage": 8.17,
            "AnnualSalary": 90000,
            "AnnualFullTimeSalary": 90000,
            "Quartile": "1",
            "Quintile": "1",
            "CompaRatio": 86.54,
            "RangePosition": 16.35,
            "SalaryRangeMinimum": 83200,
            "SalaryRangeMidPoint": 104000,
            "SalaryRangeMaximum": 124800,
            "SearchDate": null,
            "FrequencyName": "Annually",
            "AssignmentNumber": "E966169008889152",
            "DisplayName": "ZCMP US STD Salary Annually",
            "ActionId": 100010026278849,
            "ActionReasonId": null,
            "ActionCode": "CHANGE_SALARY",
            "ActionReasonCode": null,
            "ActionReason": null,
            "ActionName": "Change Salary",
            "Code": "ZCMP_US_STD_Salary_Annually"
        },
        {
            "AssignmentId": 300100093867717,
            "SalaryId": 300100203719540,
            "SalaryBasisId": 300100001799078,
            "SalaryFrequencyCode": "ANNUAL",
            "SalaryBasisType": "U",
            "CurrencyCode": "USD",
            "DateFrom": "2011-01-01",
            "DateTo": "2011-12-31",
            "SalaryAmount": 83200,
            "AdjustmentAmount": null,
            "AdjustmentPercentage": null,
            "AnnualSalary": 83200,
            "AnnualFullTimeSalary": 83200,
            "Quartile": "1",
            "Quintile": "1",
            "CompaRatio": 80,
            "RangePosition": 0,
            "SalaryRangeMinimum": 83200,
            "SalaryRangeMidPoint": 104000,
            "SalaryRangeMaximum": 124800,
            "SearchDate": null,
            "FrequencyName": "Annually",
            "AssignmentNumber": "E966169008889152",
            "DisplayName": "ZCMP US STD Salary Annually",
            "ActionId": 100010026278849,
            "ActionReasonId": null,
            "ActionCode": "CHANGE_SALARY",
            "ActionReasonCode": null,
            "ActionReason": null,
            "ActionName": "Change Salary",
            "Code": "ZCMP_US_STD_Salary_Annually"
            "links": [
               {
                 ...}
         ]
}

View Someone's Salary Components

Let's say that Bill, Jen's line manager, wants to confirm that her current salary includes her recent cost of living increase and see any adjustments to her salary components.

To retrieve the salary components 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/{SalaryId}/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 Someone's Salary Standard Components

Bill, Jen's line manager, wants to confirm that her current salary includes her recent salary increase and see any adjustments to her standard components.

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": 8000,
      "AnnualAmount": 8000,
      "AnnualFtAmount": 8000,
      "BasedOnComponentCode": null,
      "BasisSimpleComponentId": 300100217826885,
      "ComponentCode": "ORA_HOUSING_ALLOWANCE",
      "CurrencyCode": "USD",
      "DisplaySequence": 20,
      "Percentage": null,
      "SalaryId": 300100218031111,
      "SimpleSalaryCompntId": 300100218031113,
      "ComponentName": "Housing allowance",
      "BasedOnComponentName": null,
      "links": [
         {
           ...}
      ]
    },
    {
      "Amount": 18500,
      "AnnualAmount": 18500,
      "AnnualFtAmount": 18500,
      "BasedOnComponentCode": null,
      "BasisSimpleComponentId": 300100217826888,
      "ComponentCode": "ORA_OVERALL_SALARY",
      "CurrencyCode": "USD",
      "DisplaySequence": 30,
      "Percentage": null,
      "SalaryId": 300100218031111,
      "SimpleSalaryCompntId": 300100218031114,
      "ComponentName": "Overall salary",
      "BasedOnComponentName": null,
      "links": [
         {
           ...}
      ]
    },
    {
      "Amount": 10500,
      "AnnualAmount": 10500,
      "AnnualFtAmount": 10500,
      "BasedOnComponentCode": null,
      "BasisSimpleComponentId": 300100217826883,
      "ComponentCode": "ORA_BASIC",
      "CurrencyCode": "USD",
      "DisplaySequence": 10,
      "Percentage": null,
      "SalaryId": 300100218031111,
      "SimpleSalaryCompntId": 300100218031112,
      "ComponentName": "Basic salary",
      "BasedOnComponentName": null,
      "links": [
         {
           ...}
  ]
}

View Someone's Salary Advanced Components

Note:

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

Bill, Jen's line manager, also wants to confirm that her current salary includes her recent salary increase and see any adjustments to her advanced components.

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/salaries/{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": [
         {
           ...}
  ]
}