Delete a Calculation

post/clicmanager.deleteCompensationCalculation

Deletes the specified CompensationRecordSetCalculation object. Returns the deleted object in the response.

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

OK - returns the deleted object's data.

Response Schema: application/json
object
node
string
Array of objects (CompensationRecordSetCalculation)
Array
calculationType
string or null <= 255 characters
typedId
string
lastUpdateDate
string <date-time>
locale
string or null <= 255 characters
object or null
(string or null) or (string or null)
compensationRecordSetLabel
string <= 255 characters
compensationRecordSetId
integer
valid
boolean
sortBy
string or null <= 255 characters
adhocCalculation
object or null
createDate
string <date-time>
calculationMessages
string or null
targetDate
string or null <date-time>
shouldSubmit
boolean
label
string <= 255 characters
incremental
boolean
version
integer
object or null
isDefault
boolean
(string or null) or (string or null)
createdBy
integer
(string or null) or (string or null)
object or null
lastUpdateBy
integer
status
string <= 255 characters
Possible values: "DRAFT" "PENDING" "SCHEDULED" "PROCESSING" "SCHEDULED_DIRTY" "ERROR" "READY" "CANCELLED"
status
integer
Request samples
application/json
{
  • "data": {
    • "typedId": "8.CORSC"
    }
}
Response samples
application/json
{
  • "response": {
    • "node": "node1",
    • "data": [
      • {
        • "version": 10,
        • "typedId": "8.CORSC",
        • "targetDate": null,
        • "label": "SC_records2",
        • "locale": null,
        • "calculationMessages": null,
        • "compensationRecordSetId": 1,
        • "compensationRecordSetLabel": "Sales Compensations",
        • "compensationRecordSet": null,
        • "dtoFilter": null,
        • "sortBy": null,
        • "calculationType": null,
        • "adhocCalculation": null,
        • "calculationConfig": {
          },
        • "createDate": "2022-06-24T09:12:39",
        • "createdBy": 1687,
        • "lastUpdateDate": "2022-06-24T11:30:31",
        • "lastUpdateBy": 1687,
        • "status": "CANCELLED",
        • "calculationStartDate": null,
        • "calculationDate": null,
        • "isDefault": false,
        • "incremental": true,
        • "incCalculationDate": null,
        • "shouldSubmit": false,
        • "valid": true
        }
      ],
    • "status": 0
    }
}