Add a Condition Type

post/add/COCT

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

Securitybasic or X-PriceFx-jwt
Request
Request Body schema: application/json
object (CompensationConditionType)

The CompensationConditionType object. The type code is COCT.

Defines which logic will be used to calculate particular Compensation Condition Type and what parameters (in attributeX fields) will be available to the logic when it executes.

Whether you use a different logic for various Compensation Condition Types or the same logic, depends on how much different the processes behind the various Compensation Condition Types are.

uniqueName
string <= 255 characters

A unique identifier name, given by an implementation engineer.

typedId
string
label
string <= 255 characters

A name of the Compensation Condition Type, visible to business users when selecting a type of new line on a Compensation Plan.

formulaName
string or null <= 255 characters

A compensation condition logic. This logic is used to calculate all following:

  • COLI – compensation line item – for draft / editable document

  • COLI – compensation line item – for approved/read-only document

  • COR – Compensation Record

waterfallElement
string or null <= 255 characters

Stands for a name of a waterfall element which will contain the compensation money amount calculated by this compensation condition type.

The actual usage of this setting is up to the implementation engineer who has to use this value then in another logic (e.g. in the Quote Line Item logic).

createDate
string <date-time>
createdBy
integer
lastUpdateDate
string <date-time>
lastUpdateBy
integer
userGroupEdit
string or null <= 255 characters
userGroupViewDetails
string or null <= 255 characters
version
integer
(integer or null) or (string or null) or (number or null) or (string or null) or (string or null) or (string or null)
Any of:
integer 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)
Any of:
integer 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)
Any of:
integer 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)
Any of:
integer 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)
Any of:
integer 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)
Any of:
integer 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)
Any of:
integer 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)
Any of:
integer 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)
Any of:
integer 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)
Any of:
integer 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)
Any of:
integer 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)
Any of:
integer 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)
Any of:
integer 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)
Any of:
integer 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)
Any of:
integer 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)
Any of:
integer 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)
Any of:
integer 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)
Any of:
integer 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)
Any of:
integer 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)
Any of:
integer 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)
Any of:
integer 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)
Any of:
integer 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)
Any of:
integer 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)
Any of:
integer 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)
Any of:
integer 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)
Any of:
integer 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)
Any of:
integer 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)
Any of:
integer 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)
Any of:
integer 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)
Any of:
integer or null
operationType
string
Responses
200

OK

Response Schema: application/json
object (addConditionTypeResponse)
node
string
Array of objects (CompensationConditionType)
Array
uniqueName
string <= 255 characters

A unique identifier name, given by an implementation engineer.

typedId
string
label
string <= 255 characters

A name of the Compensation Condition Type, visible to business users when selecting a type of new line on a Compensation Plan.

formulaName
string or null <= 255 characters

A compensation condition logic. This logic is used to calculate all following:

  • COLI – compensation line item – for draft / editable document

  • COLI – compensation line item – for approved/read-only document

  • COR – Compensation Record

waterfallElement
string or null <= 255 characters

Stands for a name of a waterfall element which will contain the compensation money amount calculated by this compensation condition type.

The actual usage of this setting is up to the implementation engineer who has to use this value then in another logic (e.g. in the Quote Line Item logic).

createDate
string <date-time>
createdBy
integer
lastUpdateDate
string <date-time>
lastUpdateBy
integer
userGroupEdit
string or null <= 255 characters
userGroupViewDetails
string or null <= 255 characters
version
integer
(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": "SingleTargetAmount",
    • "label": "Single Target Amount",
    • "formulaName": "SC_Compensation",
    • "attribute1": "Header Level",
    • "attribute3": "Annually",
    • "attribute4": "Fixed Amount",
    • "attribute5": 2,
    • "attribute9": "Annual",
    • "attribute11": "Non-Cumulative"
    },
  • "operationType": "add"
}
Response samples
application/json
{
  • "response": {
    • "node": "node1",
    • "data": [
      • {
        • "version": 0,
        • "typedId": "47.COCT",
        • "uniqueName": "SingleTargetAmount",
        • "label": "Single Target Amount",
        • "userGroupEdit": null,
        • "userGroupViewDetails": null,
        • "formulaName": "SC_Compensation",
        • "waterfallElement": null,
        • "createDate": "2022-06-17T14:24:28",
        • "createdBy": 1687,
        • "lastUpdateDate": "2022-06-17T14:24:28",
        • "lastUpdateBy": 1687,
        • "attribute1": "Header Level",
        • "attribute2": null,
        • "attribute3": "Annually",
        • "attribute4": "Fixed Amount",
        • "attribute5": 2,
        • "attribute6": null,
        • "attribute7": null,
        • "attribute8": null,
        • "attribute9": "Annual",
        • "attribute10": null,
        • "attribute11": "Non-Cumulative",
        • "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
    }
}