Jump to

• Request
• Response

Update a rate component

patch

/hcmRestApi/resources/11.13.18.05/salaries/{SalaryId}/child/salaryPayRateComponents/{SalaryPayComponentId}

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=
• SalaryPayComponentId(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: 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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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.
• 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.
• RateMaximumAmount: number
  Maximum value allowed for the rate component.
• RateMinimumAmount: number
  Minimum value required for the rate component.
• 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.
• SalaryId: integer (int64)
  Unique identifier of the salary.

{
    "type":"object",
    "properties":{
        "PayRateDefinitionId":{
            "title":"Component",
            "type":"integer",
            "description":"Unique identifier of the rate definition.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "RateAdjustmentAmount":{
            "title":"Adjustment Amount",
            "type":"number",
            "description":"Change amount for a rate definition.",
            "nullable":true
        },
        "RateAdjustmentPercent":{
            "title":"Adjustment Percentage",
            "type":"number",
            "description":"Change percentage for a rate definition.",
            "nullable":true
        },
        "RateAmount":{
            "title":"Amount",
            "type":"number",
            "description":"Amount on the rate component of the person's salary.",
            "nullable":true
        },
        "RateAnnualAmount":{
            "title":"Annual Amount",
            "type":"number",
            "description":"Annual value of the rate amount.",
            "nullable":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
        },
        "RateCurrencyCode":{
            "title":"Currency",
            "maxLength":30,
            "type":"string",
            "description":"Currency code that the rate is stored in, such as USD.",
            "nullable":true
        },
        "RateDisplaySequence":{
            "title":"Display Sequence",
            "type":"integer",
            "description":"Display sequence of the rate component.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":3
            }
        },
        "RateFactor":{
            "title":"Percentage",
            "type":"number",
            "description":"Percentage on the rate component of the person's salary.",
            "nullable":true
        },
        "RateMaximumAmount":{
            "type":"number",
            "description":"Maximum value allowed for the rate component.",
            "nullable":true
        },
        "RateMinimumAmount":{
            "type":"number",
            "description":"Minimum value required for the rate component.",
            "nullable":true
        },
        "RatePeriodicityCode":{
            "title":"Frequency",
            "maxLength":30,
            "type":"string",
            "description":"Code of the rate periodicity, such as ANNUAL, MONTHLY, or HOURLY.",
            "nullable":true
        },
        "RatePreviousAmount":{
            "type":"number",
            "description":"Previous rate definition amount.",
            "nullable":true
        },
        "RateScale":{
            "type":"integer",
            "description":"Decimal precision of the rate definition.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "RateType":{
            "maxLength":30,
            "type":"string",
            "description":"Type of the rate, such as Primary or Derived.",
            "nullable":true
        },
        "SalaryId":{
            "type":"integer",
            "description":"Unique identifier of the salary.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        }
    }
}

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-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 : 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."
        }
    }
}

Back to Top