Jump to

• Request
• Response

Get a salary for a worker's assignment

get

/hcmRestApi/resources/11.13.18.05/salaries/{SalaryId}

Request

Path Parameters

• SalaryId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

Header Parameters

• Metadata-Context: string
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version: string
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : salaries-item-response

Type: object

Show Source

• ActionCode: string
  Title: Action Code

  Read Only: true

  Maximum Length: 30

  Code of the action.
• ActionId: integer (int64)
  Title: Action

  Unique identifier of the action.
• ActionName: string
  Title: Action

  Read Only: true

  Maximum Length: 80

  Action being done on this assignment, such as, Hire, Add Pending Worker, Manager Change and so on. Valid values are defined in the actionsLOV.
• ActionOccurrenceId: integer (int64)
  Unique identifier of the action occurrence.
• ActionReason: string
  Title: Action Reason

  Read Only: true

  Maximum Length: 80

  Reason for the action being done on the record. Valid values are defined in the actionReasonsLOV.
• ActionReasonCode: string
  Title: Action Reason Code

  Read Only: true

  Maximum Length: 30

  Code of the action reason.
• ActionReasonId: integer (int64)
  Title: Action Reason

  Unique identifier of the action reason.
• AdjustedAnnualFtSalary: number
  Annual value of the worker's salary, when working full time per adjusted full-time equivalent.
• AdjustedAnnualSalary: number
  Annual value of the worker's salary, when working per adjusted full-time equivalent.
• AdjustedFTEUsage: string
  Title: Adjusted FTE

  Maximum Length: 30

  Indicates that adjusted FTE is used.
• AdjustedFTEValue: number
  Factor that represents the proportion of adjusted full-time hours a person works.
• AdjustmentAmount: number
  Title: Adjustment Amount

  Calculated adjustment amount based on the previous salary.
• AdjustmentPercentage: number
  Title: Adjustment Percentage

  Calculated adjustment percentage based on the previous salary .
• AmountDecimalPrecision: number
  Read Only: true

  Decimal precision of the salary amount, configured in salary basis.
• AmountRoundingCode: string
  Read Only: true

  Maximum Length: 30

  Code for the salary amount rounding rule.
• AnnualFullTimeSalary: number
  Title: Annualized Full-Time Salary

  Annual value of the worker's salary, if working full time.
• AnnualRoundingCode: string
  Read Only: true

  Maximum Length: 30

  Code for the annualized salary amount rounding rule.
• AnnualSalary: number
  Title: Annual Salary

  Annual value of the worker's salary.
• AssignmentId: integer (int64)
  Unique identifier for the assignment.
• AssignmentNumber: string
  Read Only: true

  Maximum Length: 50

  Assignment number for the given assignment.
• AssignmentType: string
  Maximum Length: 30

  Type of assignment, such as an employee, contingent worker, nonworker, or pending worker.
• BusinessTitle: string
  Read Only: true

  Maximum Length: 80

  Business title for the given assignment.
• Code: string
  Read Only: true

  Maximum Length: 80

  Code for the salary basis.
• CompaRatio: number
  Title: Compa-Ratio

  Salary as a percentage of the grade range midpoint. Salary at the midpoint is 100.
• ComponentUsage: string
  Read Only: true

  Maximum Length: 30

  Property used to specify whether the incremental components type is SELECTED_COMPONENTS or USER_DECIDES_USAGE.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  Identifies the user who created the row.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Identifies the date and time that the row was created.
• CurrencyCode: string
  Title: Currency

  Maximum Length: 30

  Currency code that the salary amount is stored in, such as USD.
• DateFrom: string (date)
  Title: Start Date

  Start date of the salary.
• DateTo: string (date)
  Title: End Date

  End date of the salary.
• DisplayName: string
  Title: Salary Basis

  Read Only: true

  Maximum Length: 80

  Unique name for the set of details linked to a worker's base pay. These details include the payroll characteristics used to pay base earnings, the duration of the quoted base pay, and the factor used to annualize base pay. The details also include any components used to connect base pay adjustments to different reasons and any associated grade rate for salary validation.
• FrequencyName: string
  Title: Frequency

  Read Only: true

  Frequency of the salary basis, such as Annually, Monthly, Weekly, or Hourly.
• FTEValue: number
  Title: FTE

  Factor that represents the proportion of full-time hours a person works.
• GeographyName: string
  Title: Compensation Zone

  Read Only: true

  Maximum Length: 255

  Geographical zone used in compensation to calculate salary ranges.
• GeographyTypeName: string
  Title: Compensation Zone Type

  Read Only: true

  Maximum Length: 255

  Geographical zone type used in compensation to calculate salary ranges.
• GradeCode: string
  Title: Grade Code

  Read Only: true

  Maximum Length: 255

  Code for the current grade.
• GradeId: integer (int64)
  Title: Grade

  Unique identifier for the assignment grade.
• GradeLadderName: string
  Title: Grade Ladder

  Read Only: true

  Maximum Length: 255

  Name of the grade ladder associated with the person's assignment.
• GradeName: string
  Title: Grade

  Read Only: true

  Maximum Length: 255

  Name of the step associated with the person's assignment.
• GradeStepName: string
  Title: Grade Step

  Read Only: true

  Maximum Length: 255

  Name of the grade associated with the person's assignment.
• hasFutureSalary: string
  Read Only: true

  Maximum Length: 255

  Indicates whether a future salary exists.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  Identifies the date and time that the row was most recently updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  Identifies the user who most recently updated the row.
• LegalEmployerName: string
  Title: Legal Employer

  Read Only: true

  Maximum Length: 255

  Legal employer for the person's assignment.
• LegislativeDataGroupId: integer (int64)
  Read Only: true

  Unique identifier for the legislative data group.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MultipleComponents: string
  Title: Use salary components

  Maximum Length: 30

  Indicates whether the given salary record has any child records that are either Components, Simple Components, or Rates.
• NextSalReviewDate: string (date)
  Title: Next Salary Review Date

  Date to review a person's assignment salary.
• PayrollFactor: number
  Payroll multiplier used to convert the salary amount to an annual salary amount, when the frequency is chosen as payroll period.
• PayrollFrequencyCode: string
  Title: Frequency

  Maximum Length: 40

  Code for the payroll frequency when the frequency is chosen as payroll period.
• PendingTransactionExists: string
  Maximum Length: 255

  Indicates if a salary change for the person assignment is pending approval.
• PersonDisplayName: string
  Read Only: true

  Maximum Length: 255

  Display name of the person.
• PersonId: integer (int64)
  Person identifier for the worker.
• PersonNumber: string
  Read Only: true

  Maximum Length: 255

  Number of the person.
• Quartile: string
  Title: Quartile

  Maximum Length: 30

  Quartile containing the worker's salary. The salary range for the worker's grade is divided into four equal parts called quartiles.
• QuartileMeaning: string
  Title: Quartile

  Maximum Length: 255

  Lookup code meaning of the quartile containing the worker's salary.
• Quintile: string
  Title: Quintile

  Maximum Length: 30

  Quintile containing the worker's salary. The salary range for the worker's grade is divided into five equal parts called quintiles.
• QuintileMeaning: string
  Title: Quintile

  Maximum Length: 255

  Lookup code meaning of the quintile containing the worker's salary.
• RangeErrorWarning: string
  Read Only: true

  Maximum Length: 30

  Indicates the salary range violation behavior for the salary basis, such as error, warning, or none.
• RangePosition: number
  Title: Range Position

  Position of the worker's salary within the assignment grade salary range, expressed as a percentage of 100.
• RangeRoundingCode: string
  Read Only: true

  Maximum Length: 30

  Code for the salary range rounding rule.
• SalaryAmount: number
  Title: Salary Amount

  Salary amount on the salary record for the worker assignment.
• SalaryAmountScale: integer (int32)
  Decimal precision of the salary amount, configured in salary basis.
• SalaryBasisId: integer (int64)
  Unique identifier for the salary basis.
• SalaryBasisName: string
  Read Only: true

  Maximum Length: 80

  Name of the salary basis.
• SalaryBasisType: string
  Maximum Length: 30

  Type of the salary basis, such as Salary amount determined by the user or Components.
• salaryComponents: array Salary Components
  Title: Salary Components

  The salaryComponents resource is the child of the salaries resource and includes all the components that itemize salary adjustments for a given salary record, such as Adjustment, Location, and Merit.
• SalaryFactor: number
  Title: Salary Annualization Factor

  Multiplier that converts the salary amount to an annual salary amount. For example, if a worker's base pay is quoted hourly, the annualization factor is 2080 (40 hours per week x 52 weeks).
• SalaryFrequencyCode: string
  Title: Frequency

  Maximum Length: 30

  Code of the salary basis frequency, such as ANNUAL, MONTHLY, HOURLY.
• SalaryId: integer (int64)
  Unique identifier for a salary record generated by the application.
• salaryPayRateComponents: array Salary Rate Components
  Title: Salary Rate Components

  The salaryRateComponents resource is the child of the salaries resource and includes all of the rate components for a given salary record. This resource is currently under controlled availability.
• SalaryRangeDefaultValue: number
  Value based on the worker assignment grade and grade rate attached with the salary basis.
• SalaryRangeMaximum: number
  Title: Salary Range Maximum

  Salary range maximum based on the worker assignment grade.
• SalaryRangeMidPoint: number
  Title: Salary Range Midpoint

  Salary range midpoint based on the worker assignment grade.
• SalaryRangeMinimum: number
  Title: Salary Range Minimum

  Salary range minimum based on the worker assignment grade.
• salarySimpleComponents: array Salary Simple Components
  Title: Salary Simple Components

  The salarySimpleComponents resource is the child of the salaries resource and includes all of the simple components for a given salary record, such as Base Salary, Location Allowance, and Special Allowance.
• SalaryTransactionStatus: string
  Maximum Length: 20

  Indicate whether the salary in cache is new or a correction. The approver scenario in the salary history action uses this information during edits.
• SearchDate: string
  Read Only: true

  Date used to find the applicable salary for the day.
• WorkAtHome: string
  Read Only: true

  Maximum Length: 255

  Indicates whether the worker is working from home or not.

{
    "type":"object",
    "properties":{
        "ActionCode":{
            "title":"Action Code",
            "maxLength":30,
            "type":"string",
            "description":"Code of the action.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ActionId":{
            "title":"Action",
            "type":"integer",
            "description":"Unique identifier of the action.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ActionName":{
            "title":"Action",
            "maxLength":80,
            "type":"string",
            "description":"Action being done on this assignment, such as, Hire, Add Pending Worker, Manager Change and so on. Valid values are defined in the actionsLOV.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ActionOccurrenceId":{
            "type":"integer",
            "description":"Unique identifier of the action occurrence.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ActionReason":{
            "title":"Action Reason",
            "maxLength":80,
            "type":"string",
            "description":"Reason for the action being done on the record. Valid values are defined in the actionReasonsLOV.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ActionReasonCode":{
            "title":"Action Reason Code",
            "maxLength":30,
            "type":"string",
            "description":"Code of the action reason.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ActionReasonId":{
            "title":"Action Reason",
            "type":"integer",
            "description":"Unique identifier of the action reason.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AdjustedAnnualFtSalary":{
            "type":"number",
            "description":"Annual value of the worker's salary, when working full time per adjusted full-time equivalent.",
            "nullable":true,
            "x-queryable":true
        },
        "AdjustedAnnualSalary":{
            "type":"number",
            "description":"Annual value of the worker's salary, when working per adjusted full-time equivalent.",
            "nullable":true,
            "x-queryable":true
        },
        "AdjustedFTEUsage":{
            "title":"Adjusted FTE",
            "maxLength":30,
            "type":"string",
            "description":"Indicates that adjusted FTE is used.",
            "nullable":true,
            "x-queryable":true
        },
        "AdjustedFTEValue":{
            "type":"number",
            "description":"Factor that represents the proportion of adjusted full-time hours a person works.",
            "nullable":true,
            "x-queryable":true
        },
        "AdjustmentAmount":{
            "title":"Adjustment Amount",
            "type":"number",
            "description":"Calculated adjustment amount based on the previous salary.",
            "nullable":true,
            "x-queryable":true
        },
        "AdjustmentPercentage":{
            "title":"Adjustment Percentage",
            "type":"number",
            "description":"Calculated adjustment percentage based on the previous salary .",
            "nullable":true,
            "x-queryable":true
        },
        "AmountDecimalPrecision":{
            "type":"number",
            "description":"Decimal precision of the salary amount, configured in salary basis.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AmountRoundingCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code for the salary amount rounding rule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AnnualFullTimeSalary":{
            "title":"Annualized Full-Time Salary",
            "type":"number",
            "description":"Annual value of the worker's salary, if working full time.",
            "nullable":true,
            "x-queryable":true
        },
        "AnnualRoundingCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code for the annualized salary amount rounding rule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AnnualSalary":{
            "title":"Annual Salary",
            "type":"number",
            "description":"Annual value of the worker's salary.",
            "nullable":true,
            "x-queryable":true
        },
        "AssignmentId":{
            "type":"integer",
            "description":"Unique identifier for the assignment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AssignmentNumber":{
            "maxLength":50,
            "type":"string",
            "description":"Assignment number for the given assignment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignmentType":{
            "maxLength":30,
            "type":"string",
            "description":"Type of assignment, such as an employee, contingent worker, nonworker, or pending worker.",
            "nullable":true,
            "x-queryable":true
        },
        "BusinessTitle":{
            "maxLength":80,
            "type":"string",
            "description":"Business title for the given assignment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Code":{
            "maxLength":80,
            "type":"string",
            "description":"Code for the salary basis.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CompaRatio":{
            "title":"Compa-Ratio",
            "type":"number",
            "description":"Salary as a percentage of the grade range midpoint. Salary at the midpoint is 100.",
            "nullable":true,
            "x-queryable":true
        },
        "ComponentUsage":{
            "maxLength":30,
            "type":"string",
            "description":"Property used to specify whether the incremental components type is SELECTED_COMPONENTS or USER_DECIDES_USAGE.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"Identifies the user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Identifies the date and time that the row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":30,
            "type":"string",
            "description":"Currency code that the salary amount is stored in, such as USD.",
            "nullable":true,
            "x-queryable":true
        },
        "DateFrom":{
            "title":"Start Date",
            "type":"string",
            "description":"Start date of the salary.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "DateTo":{
            "title":"End Date",
            "type":"string",
            "description":"End date of the salary.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "DisplayName":{
            "title":"Salary Basis",
            "maxLength":80,
            "type":"string",
            "description":"Unique name for the set of details linked to a worker's base pay. These details include the payroll characteristics used to pay base earnings, the duration of the quoted base pay, and the factor used to annualize base pay. The details also include any components used to connect base pay adjustments to different reasons and any associated grade rate for salary validation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FTEValue":{
            "title":"FTE",
            "type":"number",
            "description":"Factor that represents the proportion of full-time hours a person works.",
            "nullable":true,
            "x-queryable":true
        },
        "FrequencyName":{
            "title":"Frequency",
            "type":"string",
            "description":"Frequency of the salary basis, such as Annually, Monthly, Weekly, or Hourly.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GeographyName":{
            "title":"Compensation Zone",
            "maxLength":255,
            "type":"string",
            "description":"Geographical zone used in compensation to calculate salary ranges.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GeographyTypeName":{
            "title":"Compensation Zone Type",
            "maxLength":255,
            "type":"string",
            "description":"Geographical zone type used in compensation to calculate salary ranges.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GradeCode":{
            "title":"Grade Code",
            "maxLength":255,
            "type":"string",
            "description":"Code for the current grade.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GradeId":{
            "title":"Grade",
            "type":"integer",
            "description":"Unique identifier for the assignment grade.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "GradeLadderName":{
            "title":"Grade Ladder",
            "maxLength":255,
            "type":"string",
            "description":"Name of the grade ladder associated with the person's assignment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GradeName":{
            "title":"Grade",
            "maxLength":255,
            "type":"string",
            "description":"Name of the step associated with the person's assignment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GradeStepName":{
            "title":"Grade Step",
            "maxLength":255,
            "type":"string",
            "description":"Name of the grade associated with the person's assignment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"Identifies the date and time that the row was most recently updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"Identifies the user who most recently updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LegalEmployerName":{
            "title":"Legal Employer",
            "maxLength":255,
            "type":"string",
            "description":"Legal employer for the person's assignment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LegislativeDataGroupId":{
            "type":"integer",
            "description":"Unique identifier for the legislative data group.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "MultipleComponents":{
            "title":"Use salary components",
            "maxLength":30,
            "type":"string",
            "description":"Indicates whether the given salary record has any child records that are either Components, Simple Components, or Rates.",
            "nullable":false,
            "x-queryable":true
        },
        "NextSalReviewDate":{
            "title":"Next Salary Review Date",
            "type":"string",
            "description":"Date to review a person's assignment salary.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "PayrollFactor":{
            "type":"number",
            "description":"Payroll multiplier used to convert the salary amount to an annual salary amount, when the frequency is chosen as payroll period.",
            "nullable":true,
            "x-queryable":true
        },
        "PayrollFrequencyCode":{
            "title":"Frequency",
            "maxLength":40,
            "type":"string",
            "description":"Code for the payroll frequency when the frequency is chosen as payroll period.",
            "nullable":true,
            "x-queryable":true
        },
        "PendingTransactionExists":{
            "maxLength":255,
            "type":"string",
            "description":"Indicates if a salary change for the person assignment is pending approval.",
            "nullable":true,
            "x-queryable":true
        },
        "PersonDisplayName":{
            "maxLength":255,
            "type":"string",
            "description":"Display name of the person.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonId":{
            "type":"integer",
            "description":"Person identifier for the worker.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PersonNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Number of the person.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Quartile":{
            "title":"Quartile",
            "maxLength":30,
            "type":"string",
            "description":"Quartile containing the worker's salary. The salary range for the worker's grade is divided into four equal parts called quartiles.",
            "nullable":true,
            "x-queryable":true
        },
        "QuartileMeaning":{
            "title":"Quartile",
            "maxLength":255,
            "type":"string",
            "description":"Lookup code meaning of the quartile containing the worker's salary.",
            "nullable":true,
            "x-queryable":true
        },
        "Quintile":{
            "title":"Quintile",
            "maxLength":30,
            "type":"string",
            "description":"Quintile containing the worker's salary. The salary range for the worker's grade is divided into five equal parts called quintiles.",
            "nullable":true,
            "x-queryable":true
        },
        "QuintileMeaning":{
            "title":"Quintile",
            "maxLength":255,
            "type":"string",
            "description":"Lookup code meaning of the quintile containing the worker's salary.",
            "nullable":true,
            "x-queryable":true
        },
        "RangeErrorWarning":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates the salary range violation behavior for the salary basis, such as error, warning, or none.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RangePosition":{
            "title":"Range Position",
            "type":"number",
            "description":"Position of the worker's salary within the assignment grade salary range, expressed as a percentage of 100.",
            "nullable":true,
            "x-queryable":true
        },
        "RangeRoundingCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code for the salary range rounding rule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SalaryAmount":{
            "title":"Salary Amount",
            "type":"number",
            "description":"Salary amount on the salary record for the worker assignment.",
            "nullable":false,
            "x-queryable":true
        },
        "SalaryAmountScale":{
            "type":"integer",
            "description":"Decimal precision of the salary amount, configured in salary basis.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":3
            },
            "x-queryable":true
        },
        "SalaryBasisId":{
            "type":"integer",
            "description":"Unique identifier for the salary basis.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SalaryBasisName":{
            "maxLength":80,
            "type":"string",
            "description":"Name of the salary basis.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SalaryBasisType":{
            "maxLength":30,
            "type":"string",
            "description":"Type of the salary basis, such as Salary amount determined by the user or Components.",
            "nullable":true,
            "x-queryable":true
        },
        "SalaryFactor":{
            "title":"Salary Annualization Factor",
            "type":"number",
            "description":"Multiplier that converts the salary amount to an annual salary amount. For example, if a worker's base pay is quoted hourly, the annualization factor is 2080 (40 hours per week x 52 weeks).",
            "nullable":true,
            "x-queryable":true
        },
        "SalaryFrequencyCode":{
            "title":"Frequency",
            "maxLength":30,
            "type":"string",
            "description":"Code of the salary basis frequency, such as ANNUAL, MONTHLY, HOURLY.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SalaryId":{
            "type":"integer",
            "description":"Unique identifier for a salary record generated by the application.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SalaryRangeDefaultValue":{
            "type":"number",
            "description":"Value based on the worker assignment grade and grade rate attached with the salary basis.",
            "nullable":true,
            "x-queryable":true
        },
        "SalaryRangeMaximum":{
            "title":"Salary Range Maximum",
            "type":"number",
            "description":"Salary range maximum based on the worker assignment grade.",
            "nullable":true,
            "x-queryable":true
        },
        "SalaryRangeMidPoint":{
            "title":"Salary Range Midpoint",
            "type":"number",
            "description":"Salary range midpoint based on the worker assignment grade.",
            "nullable":true,
            "x-queryable":true
        },
        "SalaryRangeMinimum":{
            "title":"Salary Range Minimum",
            "type":"number",
            "description":"Salary range minimum based on the worker assignment grade.",
            "nullable":true,
            "x-queryable":true
        },
        "SalaryTransactionStatus":{
            "maxLength":20,
            "type":"string",
            "description":"Indicate whether the salary in cache is new or a correction. The approver scenario in the salary history action uses this information during edits.",
            "nullable":true,
            "x-queryable":true
        },
        "SearchDate":{
            "type":"string",
            "description":"Date used to find the applicable salary for the day.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkAtHome":{
            "maxLength":255,
            "type":"string",
            "description":"Indicates whether the worker is working from home or not.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "hasFutureSalary":{
            "maxLength":255,
            "type":"string",
            "description":"Indicates whether a future salary exists.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "salaryComponents":{
            "title":"Salary Components",
            "type":"array",
            "description":"The salaryComponents resource is the child of the salaries resource and includes all the components that itemize salary adjustments for a given salary record, such as Adjustment, Location, and Merit.",
            "items":{
                "$ref":"#/components/schemas/salaries-salaryComponents-item-response"
            }
        },
        "salaryPayRateComponents":{
            "title":"Salary Rate Components",
            "type":"array",
            "description":"The salaryRateComponents resource is the child of the salaries resource and includes all of the rate components for a given salary record. This resource is currently under controlled availability.",
            "items":{
                "$ref":"#/components/schemas/salaries-salaryPayRateComponents-item-response"
            }
        },
        "salarySimpleComponents":{
            "title":"Salary Simple Components",
            "type":"array",
            "description":"The salarySimpleComponents resource is the child of the salaries resource and includes all of the simple components for a given salary record, such as Base Salary, Location Allowance, and Special Allowance.",
            "items":{
                "$ref":"#/components/schemas/salaries-salarySimpleComponents-item-response"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : Salary Components

Type: array

Title: Salary Components

The salaryComponents resource is the child of the salaries resource and includes all the components that itemize salary adjustments for a given salary record, such as Adjustment, Location, and Merit.

Show Source

• Array of: object salaries-salaryComponents-item-response

{
    "title":"Salary Components",
    "type":"array",
    "description":"The salaryComponents resource is the child of the salaries resource and includes all the components that itemize salary adjustments for a given salary record, such as Adjustment, Location, and Merit.",
    "items":{
        "$ref":"#/components/schemas/salaries-salaryComponents-item-response"
    }
}

Nested Schema : Salary Rate Components

Type: array

Title: Salary Rate Components

The salaryRateComponents resource is the child of the salaries resource and includes all of the rate components for a given salary record. This resource is currently under controlled availability.

Show Source

• Array of: object salaries-salaryPayRateComponents-item-response

{
    "title":"Salary Rate Components",
    "type":"array",
    "description":"The salaryRateComponents resource is the child of the salaries resource and includes all of the rate components for a given salary record. This resource is currently under controlled availability.",
    "items":{
        "$ref":"#/components/schemas/salaries-salaryPayRateComponents-item-response"
    }
}

Nested Schema : Salary Simple Components

Type: array

Title: Salary Simple Components

The salarySimpleComponents resource is the child of the salaries resource and includes all of the simple components for a given salary record, such as Base Salary, Location Allowance, and Special Allowance.

Show Source

• Array of: object salaries-salarySimpleComponents-item-response

{
    "title":"Salary Simple Components",
    "type":"array",
    "description":"The salarySimpleComponents resource is the child of the salaries resource and includes all of the simple components for a given salary record, such as Base Salary, Location Allowance, and Special Allowance.",
    "items":{
        "$ref":"#/components/schemas/salaries-salarySimpleComponents-item-response"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : salaries-salaryComponents-item-response

Type: object

Show Source

• AdjustmentAmount: number
  Title: Adjustment Amount

  Change amount for a component used to itemize salary into different reasons.
• AdjustmentPercentage: number
  Title: Adjustment Percentage

  Change percentage for a component used to itemize salary into different reasons.
• ChangeAmountScale: integer (int32)
  Decimal precision of the salary amount, configured in salary basis.
• ComponentName: string
  Title: Component

  Read Only: true

  Maximum Length: 80

  Incremental component that itemizes salary adjustments by reasons, such as merit, location, and cost of living.
• ComponentReasonCode: string
  Title: Component

  Maximum Length: 30

  Incremental component code for salary adjustments itemized by reasons, such as merit, location, and cost of living.
• DisplaySequence: integer (int64)
  Title: Display Sequence

  Read Only: true

  Sequence for the rate definition defined in the salary basis.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• SalaryComponentId: integer (int64)
  Unique identifier of the salary component.
• SalaryId: integer (int64)
  Unique identifier of the salary.

{
    "type":"object",
    "properties":{
        "AdjustmentAmount":{
            "title":"Adjustment Amount",
            "type":"number",
            "description":"Change amount for a component used to itemize salary into different reasons.",
            "nullable":true,
            "x-queryable":true
        },
        "AdjustmentPercentage":{
            "title":"Adjustment Percentage",
            "type":"number",
            "description":"Change percentage for a component used to itemize salary into different reasons.",
            "nullable":true,
            "x-queryable":true
        },
        "ChangeAmountScale":{
            "type":"integer",
            "description":"Decimal precision of the salary amount, configured in salary basis.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":3
            },
            "x-queryable":true
        },
        "ComponentName":{
            "title":"Component",
            "maxLength":80,
            "type":"string",
            "description":"Incremental component that itemizes salary adjustments by reasons, such as merit, location, and cost of living.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ComponentReasonCode":{
            "title":"Component",
            "maxLength":30,
            "type":"string",
            "description":"Incremental component code for salary adjustments itemized by reasons, such as merit, location, and cost of living.",
            "nullable":false,
            "x-queryable":true
        },
        "DisplaySequence":{
            "title":"Display Sequence",
            "type":"integer",
            "description":"Sequence for the rate definition defined in the salary basis.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SalaryComponentId":{
            "type":"integer",
            "description":"Unique identifier of the salary component.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SalaryId":{
            "type":"integer",
            "description":"Unique identifier of the salary.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : salaries-salaryPayRateComponents-item-response

Type: object

Show Source

• AmountEnterable: string
  Title: User Enterable

  Read Only: true

  Maximum Length: 30

  Indicates whether the rate amount is enterable.
• FactorEnterable: string
  Read Only: true

  Maximum Length: 30

  Indicates whether the rate factor is enterable.
• FTEFlag: boolean
  Title: FTE

  Read Only: true

  Maximum Length: 30

  Indicates whether the rate is prorated for full time equivalent. Valid values are Yes and No, and the default value is No.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Name: string
  Title: Rate Name

  Read Only: true

  Maximum Length: 256

  Name of the salary rate component, which can be configured to capture an amount, factor, or derived.
• PayRateDefinitionId: integer (int64)
  Title: Component

  Unique identifier of the rate definition.
• RateAdjustmentAmount: number
  Title: Adjustment Amount

  Change amount for a rate definition.
• RateAdjustmentPercent: number
  Title: Adjustment Percentage

  Change percentage for a rate definition.
• RateAmount: number
  Title: Amount

  Amount on the rate component of the person's salary.
• RateAnnualAmount: number
  Title: Annual Amount

  Annual value of the rate amount.
• RateAnnualFtAmount: number
  Title: Annualized Full-Time Amount

  Annual value of the rate amount, if the worker was working full time.
• RateComponentRange: string
  Read Only: true

  Maximum Length: 255

  Range the rate component value should be between.
• RateCurrencyCode: string
  Title: Currency

  Maximum Length: 30

  Currency code that the rate is stored in, such as USD.
• RateDisplaySequence: integer (int32)
  Title: Display Sequence

  Display sequence of the rate component.
• RateFactor: number
  Title: Percentage

  Percentage on the rate component of the person's salary.
• RateFrequencyName: string
  Title: Frequency

  Read Only: true

  Maximum Length: 255

  Frequency of the rate definition, such as Annually, Monthly, Weekly, or Hourly.
• RateMaximumAmount: number
  Maximum value allowed for the rate component.
• RateMinimumAmount: number
  Minimum value required for the rate component.
• RateOverallSalaryFlag: boolean
  Read Only: true

  Maximum Length: 30

  Indicates whether the rate is an overall salary type. Valid values are Yes and No, and the default value is No.
• RatePeriodicityCode: string
  Title: Frequency

  Maximum Length: 30

  Code of the rate periodicity, such as ANNUAL, MONTHLY, or HOURLY.
• RatePreviousAmount: number
  Previous rate definition amount.
• RateScale: integer (int64)
  Decimal precision of the rate definition.
• RateType: string
  Maximum Length: 30

  Type of the rate, such as Primary or Derived.
• ReturnPrecision: integer (int64)
  Read Only: true

  Decimal precision of the returned rate value.
• SalaryId: integer (int64)
  Unique identifier of the salary.
• SalaryPayComponentId: integer (int64)
  Unique identifier of the salary rate component.
• ShortName: string
  Title: Short Name

  Read Only: true

  Maximum Length: 30

  Short name of the salary rate component.

{
    "type":"object",
    "properties":{
        "AmountEnterable":{
            "title":"User Enterable",
            "maxLength":30,
            "type":"string",
            "description":"Indicates whether the rate amount is enterable.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FTEFlag":{
            "title":"FTE",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates whether the rate is prorated for full time equivalent. Valid values are Yes and No, and the default value is No.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FactorEnterable":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates whether the rate factor is enterable.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Name":{
            "title":"Rate Name",
            "maxLength":256,
            "type":"string",
            "description":"Name of the salary rate component, which can be configured to capture an amount, factor, or derived.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PayRateDefinitionId":{
            "title":"Component",
            "type":"integer",
            "description":"Unique identifier of the rate definition.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RateAdjustmentAmount":{
            "title":"Adjustment Amount",
            "type":"number",
            "description":"Change amount for a rate definition.",
            "nullable":true,
            "x-queryable":true
        },
        "RateAdjustmentPercent":{
            "title":"Adjustment Percentage",
            "type":"number",
            "description":"Change percentage for a rate definition.",
            "nullable":true,
            "x-queryable":true
        },
        "RateAmount":{
            "title":"Amount",
            "type":"number",
            "description":"Amount on the rate component of the person's salary.",
            "nullable":true,
            "x-queryable":true
        },
        "RateAnnualAmount":{
            "title":"Annual Amount",
            "type":"number",
            "description":"Annual value of the rate amount.",
            "nullable":true,
            "x-queryable":true
        },
        "RateAnnualFtAmount":{
            "title":"Annualized Full-Time Amount",
            "type":"number",
            "description":"Annual value of the rate amount, if the worker was working full time.",
            "nullable":true,
            "x-queryable":true
        },
        "RateComponentRange":{
            "maxLength":255,
            "type":"string",
            "description":"Range the rate component value should be between.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RateCurrencyCode":{
            "title":"Currency",
            "maxLength":30,
            "type":"string",
            "description":"Currency code that the rate is stored in, such as USD.",
            "nullable":true,
            "x-queryable":true
        },
        "RateDisplaySequence":{
            "title":"Display Sequence",
            "type":"integer",
            "description":"Display sequence of the rate component.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":3
            },
            "x-queryable":true
        },
        "RateFactor":{
            "title":"Percentage",
            "type":"number",
            "description":"Percentage on the rate component of the person's salary.",
            "nullable":true,
            "x-queryable":true
        },
        "RateFrequencyName":{
            "title":"Frequency",
            "maxLength":255,
            "type":"string",
            "description":"Frequency of the rate definition, such as Annually, Monthly, Weekly, or Hourly.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RateMaximumAmount":{
            "type":"number",
            "description":"Maximum value allowed for the rate component.",
            "nullable":true,
            "x-queryable":true
        },
        "RateMinimumAmount":{
            "type":"number",
            "description":"Minimum value required for the rate component.",
            "nullable":true,
            "x-queryable":true
        },
        "RateOverallSalaryFlag":{
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates whether the rate is an overall salary type. Valid values are Yes and No, and the default value is No.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RatePeriodicityCode":{
            "title":"Frequency",
            "maxLength":30,
            "type":"string",
            "description":"Code of the rate periodicity, such as ANNUAL, MONTHLY, or HOURLY.",
            "nullable":true,
            "x-queryable":true
        },
        "RatePreviousAmount":{
            "type":"number",
            "description":"Previous rate definition amount.",
            "nullable":true,
            "x-queryable":true
        },
        "RateScale":{
            "type":"integer",
            "description":"Decimal precision of the rate definition.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RateType":{
            "maxLength":30,
            "type":"string",
            "description":"Type of the rate, such as Primary or Derived.",
            "nullable":true,
            "x-queryable":true
        },
        "ReturnPrecision":{
            "type":"integer",
            "description":"Decimal precision of the returned rate value.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SalaryId":{
            "type":"integer",
            "description":"Unique identifier of the salary.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SalaryPayComponentId":{
            "type":"integer",
            "description":"Unique identifier of the salary rate component.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ShortName":{
            "title":"Short Name",
            "maxLength":30,
            "type":"string",
            "description":"Short name of the salary rate component.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : salaries-salarySimpleComponents-item-response

Type: object

Show Source

• AdjustmentAmount: number
  Title: Adjustment Amount

  Change amount for a simple component.
• AdjustmentPercent: number
  Title: Adjustment Percentage

  Change percentage for a simple component.
• Amount: number
  Title: Amount

  Amount of the person's salary entered on the simple component
• AnnualAmount: number
  Title: Annual Amount

  Annual value of the simple component amount.
• AnnualFtAmount: number
  Title: Annualized Full-Time Amount

  Annual value of the simple component amount, if the person worked full time.
• BasedOnComponentCode: string
  Maximum Length: 30

  Code of the simple component that the percentage applies to.
• BasedOnComponentName: string
  Name of the simple component that the percentage applies to.
• BasisSimpleComponentId: integer (int64)
  Unique identifier of the simple component that the percentage applies to.
• ComponentCode: string
  Title: Salary Component Code

  Maximum Length: 30

  Code of the salary simple component, such as ORA_BASIC.
• ComponentName: string
  Title: Component

  Name of the simple component, which can be configured to accept an amount or percentage.
• ComponentType: string
  Title: Type

  Maximum Length: 30

  Code for the simple component type.
• CurrencyCode: string
  Title: Currency

  Maximum Length: 30

  Currency code that the simple component value is stored in, such as USD.
• DisplaySequence: integer (int32)
  Title: Display Sequence

  Display sequence of the simple component.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OverallSalaryAffect: string
  Title: Overall Salary

  Maximum Length: 30

  Code for the effect of overall salary.
• OverrideGspRate: string
  Maximum Length: 30

  Indicates whether a user can override the value defaulted from the progression ladder.
• Percentage: number
  Title: Percentage

  Percentage entered for the simple component. This percentage is applied to the specified based on simple component, to calculate the component amount. For example, apply 5% to the Base Salary simplified component.
• PreviousAmount: number
  Title: Previous Rate Amount

  Previous simple component amount.
• SalaryId: integer (int64)
  Unique identifier of the salary.
• Scale: integer (int32)
  Decimal precision of the salary amount, configured in salary basis.
• SimpleSalaryCompntId: integer (int64)
  Unique identifier of the salary simple component.
• UserSelectedComponent: string
  Maximum Length: 30

  Property used to specify whether the incremental components type is SELECTED_COMPONENTS or USER_DECIDES_USAGE.

{
    "type":"object",
    "properties":{
        "AdjustmentAmount":{
            "title":"Adjustment Amount",
            "type":"number",
            "description":"Change amount for a simple component.",
            "nullable":true,
            "x-queryable":true
        },
        "AdjustmentPercent":{
            "title":"Adjustment Percentage",
            "type":"number",
            "description":"Change percentage for a simple component.",
            "nullable":true,
            "x-queryable":true
        },
        "Amount":{
            "title":"Amount",
            "type":"number",
            "description":"Amount of the person's salary entered on the simple component",
            "nullable":false,
            "x-queryable":true
        },
        "AnnualAmount":{
            "title":"Annual Amount",
            "type":"number",
            "description":"Annual value of the simple component amount.",
            "nullable":true,
            "x-queryable":true
        },
        "AnnualFtAmount":{
            "title":"Annualized Full-Time Amount",
            "type":"number",
            "description":"Annual value of the simple component amount, if the person worked full time.",
            "nullable":true,
            "x-queryable":true
        },
        "BasedOnComponentCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code of the simple component that the percentage applies to.",
            "nullable":true,
            "x-queryable":true
        },
        "BasedOnComponentName":{
            "type":"string",
            "description":"Name of the simple component that the percentage applies to.",
            "nullable":true,
            "x-queryable":true
        },
        "BasisSimpleComponentId":{
            "type":"integer",
            "description":"Unique identifier of the simple component that the percentage applies to.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ComponentCode":{
            "title":"Salary Component Code",
            "maxLength":30,
            "type":"string",
            "description":"Code of the salary simple component, such as ORA_BASIC.",
            "nullable":true,
            "x-queryable":true
        },
        "ComponentName":{
            "title":"Component",
            "type":"string",
            "description":"Name of the simple component, which can be configured to accept an amount or percentage.",
            "nullable":true,
            "x-queryable":true
        },
        "ComponentType":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"Code for the simple component type.",
            "nullable":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":30,
            "type":"string",
            "description":"Currency code that the simple component value is stored in, such as USD.",
            "nullable":true,
            "x-queryable":true
        },
        "DisplaySequence":{
            "title":"Display Sequence",
            "type":"integer",
            "description":"Display sequence of the simple component.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":3
            },
            "x-queryable":true
        },
        "OverallSalaryAffect":{
            "title":"Overall Salary",
            "maxLength":30,
            "type":"string",
            "description":"Code for the effect of overall salary.",
            "nullable":true,
            "x-queryable":true
        },
        "OverrideGspRate":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates whether a user can override the value defaulted from the progression ladder.",
            "nullable":true,
            "x-queryable":true
        },
        "Percentage":{
            "title":"Percentage",
            "type":"number",
            "description":"Percentage entered for the simple component. This percentage is applied to the specified based on simple component, to calculate the component amount. For example, apply 5% to the Base Salary simplified component.",
            "nullable":true,
            "x-queryable":true
        },
        "PreviousAmount":{
            "title":"Previous Rate Amount",
            "type":"number",
            "description":"Previous simple component amount.",
            "nullable":true,
            "x-queryable":true
        },
        "SalaryId":{
            "type":"integer",
            "description":"Unique identifier of the salary.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Scale":{
            "type":"integer",
            "description":"Decimal precision of the salary amount, configured in salary basis.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":3
            },
            "x-queryable":true
        },
        "SimpleSalaryCompntId":{
            "type":"integer",
            "description":"Unique identifier of the salary simple component.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "UserSelectedComponent":{
            "maxLength":30,
            "type":"string",
            "description":"Property used to specify whether the incremental components type is SELECTED_COMPONENTS or USER_DECIDES_USAGE.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Links

salaryComponents

Operation: /hcmRestApi/resources/11.13.18.05/salaries/{SalaryId}/child/salaryComponents

Parameters:

• SalaryId: $request.path.SalaryId

The salaryComponents resource is the child of the salaries resource and includes all the components that itemize salary adjustments for a given salary record, such as Adjustment, Location, and Merit.

salaryPayRateComponents

Operation: /hcmRestApi/resources/11.13.18.05/salaries/{SalaryId}/child/salaryPayRateComponents

Parameters:

• SalaryId: $request.path.SalaryId

The salaryRateComponents resource is the child of the salaries resource and includes all of the rate components for a given salary record. This resource is currently under controlled availability.

salarySimpleComponents

Operation: /hcmRestApi/resources/11.13.18.05/salaries/{SalaryId}/child/salarySimpleComponents

Parameters:

• SalaryId: $request.path.SalaryId

The salarySimpleComponents resource is the child of the salaries resource and includes all of the simple components for a given salary record, such as Base Salary, Location Allowance, and Special Allowance.

Back to Top