Add a Compensation Type

post/add/COHT

Creates a Compensation Type record in the Compensation Header Types table.

Securitybasic or X-PriceFx-jwt
Request
Request Body schema: application/json
object
uniqueName
required
string

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.

headerFormulaName
string

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.

workflowFormulaName
string

A name of the approval workflow logic, which will build the approval steps for the Compensation Plan document.

configuration
string 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.

scRecordWorkflowFormulaName
string

A name of the approval workflow logic, which will build the approval steps for the compensation records.

scTypeFilterFormulaName
string

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.

operation
required
string
Responses
200

OK

Response Schema: application/json
object (addCompensationTypeResponse)
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)
status
integer
Request samples
application/json
{
  • "data": {
    • "uniqueName": "The Test Compensation Type",
    • "headerFormulaName": "SC_CompensationHeader",
    • "workflowFormulaName": "SC_SalesCompensationAgreement",
    • "configuration": null,
    • "scRecordWorkflowFormulaName": "SC_AgreementRecord"
    },
  • "operation": "add"
}
Response samples
application/json
{
  • "response": {
    • "node": "node",
    • "data": [
      • {
        • "version": 0,
        • "typedId": "53.COHT",
        • "uniqueName": "The Test Compensation Type",
        • "label": null,
        • "userGroupEdit": null,
        • "userGroupViewDetails": null,
        • "headerFormulaName": "SC_CompensationHeader",
        • "workflowFormulaName": "SC_SalesCompensationAgreement",
        • "configuration": null,
        • "scTypeFilterFormulaName": null,
        • "scRecordWorkflowFormulaName": "SC_AgreementRecord",
        • "createDate": "2022-06-16T15:43:16",
        • "createdBy": 1687,
        • "lastUpdateDate": "2022-06-16T15:43:16",
        • "lastUpdateBy": 1687,
        • "attribute1": null,
        • "attribute2": null,
        • "attribute3": null,
        • "attribute4": null,
        • "attribute5": null,
        • "attribute6": null,
        • "attribute7": null,
        • "attribute8": null,
        • "attribute9": null,
        • "attribute10": null,
        • "attribute11": null,
        • "attribute12": null,
        • "attribute13": null,
        • "attribute14": null,
        • "attribute15": null,
        • "attribute16": null,
        • "attribute17": null,
        • "attribute18": null,
        • "attribute19": null,
        • "attribute20": null,
        • "attribute21": null,
        • "attribute22": null,
        • "attribute23": null,
        • "attribute24": null,
        • "attribute25": null,
        • "attribute26": null,
        • "attribute27": null,
        • "attribute28": null,
        • "attribute29": null,
        • "attribute30": null
        }
      ],
    • "status": 0
    }
}