Updates a Compensation Type in the Compensation Header Types table. The version property must be provided within the oldValues.
Securitybasic or X-PriceFx-jwt
Request
Request Body schema: application/json
required
object
typedId
required
string
headerFormulaName
string
object
version
required
integer
typedId
string
uniqueName
string
headerFormulaName
string
workflowFormulaName
string
configuration
object
scRecordWorkflowFormulaName
string
createDate
string
createdBy
integer
lastUpdateDate
string
lastUpdateBy
integer
operationType
required
string
textMatchStyle
string
Responses
200
OK
Response Schema: application/json
object (updateCompensationTypeResponse)
node
string
Array of objects (CompensationHeaderType)
Array
object or null
A configuration (as JSON string) of the detail page. You can configure e.g., the additional tabs on Compensation Plan detail page, which will show information in form of a dashboard. See Detail Page Layout and Dynamic Tabs for more details.
createDate
string <date-time>
createdBy
integer
headerFormulaName
string <= 255 characters
A name of the logic used for building inputs and calculating results for the Compensation Plan header, but can also manipulate the items and folders.
label
string or null <= 255 characters
lastUpdateBy
integer
lastUpdateDate
string <date-time>
scRecordWorkflowFormulaName
string <= 255 characters
A name of the approval workflow logic, which will build the approval steps for the compensation records.
scTypeFilterFormulaName
string or null <= 255 characters
A name of the logic which will be used to filter the available Compensation Condition Types, while the user is adding a new item to the Compensation Plan document.
typedId
string
uniqueName
string <= 255 characters
A unique identification of this type. This name will be used in the Compensation Plan document as a foreign key, to identify the compensation header type used.
userGroupEdit
string or null <= 255 characters
userGroupViewDetails
string or null <= 255 characters
version
integer
workflowFormulaName
string or null <= 255 characters
A name of the approval workflow logic, which will build the approval steps for the Compensation Plan document.
(integer or null) or (string or null) or (number or null) or (string or null) or (string or null) or (string or null)
(integer or null) or (string or null) or (number or null) or (string or null) or (string or null) or (string or null)
(integer or null) or (string or null) or (number or null) or (string or null) or (string or null) or (string or null)
(integer or null) or (string or null) or (number or null) or (string or null) or (string or null) or (string or null)
(integer or null) or (string or null) or (number or null) or (string or null) or (string or null) or (string or null)
(integer or null) or (string or null) or (number or null) or (string or null) or (string or null) or (string or null)
(integer or null) or (string or null) or (number or null) or (string or null) or (string or null) or (string or null)
(integer or null) or (string or null) or (number or null) or (string or null) or (string or null) or (string or null)
(integer or null) or (string or null) or (number or null) or (string or null) or (string or null) or (string or null)
(integer or null) or (string or null) or (number or null) or (string or null) or (string or null) or (string or null)
(integer or null) or (string or null) or (number or null) or (string or null) or (string or null) or (string or null)
(integer or null) or (string or null) or (number or null) or (string or null) or (string or null) or (string or null)
(integer or null) or (string or null) or (number or null) or (string or null) or (string or null) or (string or null)
(integer or null) or (string or null) or (number or null) or (string or null) or (string or null) or (string or null)
(integer or null) or (string or null) or (number or null) or (string or null) or (string or null) or (string or null)
(integer or null) or (string or null) or (number or null) or (string or null) or (string or null) or (string or null)
(integer or null) or (string or null) or (number or null) or (string or null) or (string or null) or (string or null)
(integer or null) or (string or null) or (number or null) or (string or null) or (string or null) or (string or null)
(integer or null) or (string or null) or (number or null) or (string or null) or (string or null) or (string or null)
(integer or null) or (string or null) or (number or null) or (string or null) or (string or null) or (string or null)
(integer or null) or (string or null) or (number or null) or (string or null) or (string or null) or (string or null)
(integer or null) or (string or null) or (number or null) or (string or null) or (string or null) or (string or null)
(integer or null) or (string or null) or (number or null) or (string or null) or (string or null) or (string or null)
(integer or null) or (string or null) or (number or null) or (string or null) or (string or null) or (string or null)
(integer or null) or (string or null) or (number or null) or (string or null) or (string or null) or (string or null)
(integer or null) or (string or null) or (number or null) or (string or null) or (string or null) or (string or null)
(integer or null) or (string or null) or (number or null) or (string or null) or (string or null) or (string or null)
(integer or null) or (string or null) or (number or null) or (string or null) or (string or null) or (string or null)
(integer or null) or (string or null) or (number or null) or (string or null) or (string or null) or (string or null)
(integer or null) or (string or null) or (number or null) or (string or null) or (string or null) or (string or null)