Create a rate component
post
/hcmRestApi/resources/11.13.18.05/salaries/{SalaryId}/child/salaryPayRateComponents
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=
Header Parameters
-
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
PayRateDefinitionId: integer
(int64)
Title:
Component
Unique identifier of the 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. -
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. -
RatePeriodicityCode: string
Title:
Frequency
Maximum Length:30
Code of the rate periodicity, such as ANNUAL, MONTHLY, or HOURLY. -
RateScale: integer
(int64)
Decimal precision of the rate definition.
-
RateType: string
Maximum Length:
30
Type of the rate, such as Primary or Derived. -
SalaryId: integer
(int64)
Unique identifier of the salary.
-
SalaryPayComponentId: integer
(int64)
Unique identifier of the salary rate component.
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.
Root Schema : salaries-salaryPayRateComponents-item-response
Type:
Show Source
object
-
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. -
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. -
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. -
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. -
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.