Save Calculation

post/calculationrecord.savecalc

Updates Calculation details.

Securitybasic or X-PriceFx-jwt

Request

Request Body schema: application/json

object (CompensationRecordSetCalculation)

The CompensationRecordSetCalculation object. The type code is CORSC.

calculationType

string or null <= 255 characters

typedId

string

lastUpdateDate

string <date-time>

locale

string or null <= 255 characters

object or null

version	integer
typedId	string
targetDate	string or null <date-time>
label	string
locale	string or null
calculationMessages	string or null
numberOfItems	integer
keepManualOverrides	boolean
writeOnlyChangedItems	boolean
userGroupEdit	string or null
userGroupViewDetails	string or null
updatedBy	integer
	(string or null) or (string or null)
Any of: string or null <date-time>
recordSetId	integer
createDate	string
createdBy	integer
lastUpdateDate	string
lastUpdateBy	integer
status	string Possible values: "DRAFT" "PENDING" "SCHEDULED" "PROCESSING" "SCHEDULED_DIRTY" "ERROR" "READY" "CANCELLED"
calculationStartDate	string or null
calculationDate	string or null
id	integer

(string or null) or (string or null)

Any of:

string or null <date-time>

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

additional property	object or string or Array of arrays
Any of: object

isDefault

boolean

(string or null) or (string or null)

Any of:

string or null <date-time>

createdBy

integer

(string or null) or (string or null)

Any of:

string or null <date-time>

object or null

skuField

string or null

targetDateField

string or null

simulationSet

string or null

formulaName

string or null

targetDate

string or null <date-time>

feederFormulaName

string or null

Array of objects

Array

name	string
label	string
lookupTableId	string
url	string
type	string
value	object
valueHint	string
readOnly	boolean
	object
parameterGroup	string
required	boolean
labelTranslations	string
addUnknownValues	boolean
typedId	string
alwaysEditable	boolean
inputs	Array of objects
	object
	object
valueOptions	Array of strings

inputParams

Array of objects

mappingParams

Array of objects

Array

elementName	string
elementLabel	string
formulaName	string
formulaDate	string <date-time>
elementGroups	Array of strings
formatType	string Possible values: "NUMERIC" "NUMERIC_LONG" "MONEY" "PERCENT" "TEXT" "MONEY_EUR" "MONEY_USD" "MONEY_GBP" "MONEY_JPY" "MONEY_CHF" "MONEY_PLN" "DATETIME" "DATE" "INTEGER" "LINK" "COMPLEX" "SPARKLINE"
key	boolean
selected	boolean
displayedInPriceShop	boolean

targetFields

Array of strings or null

lastUpdateBy

integer

status

string <= 255 characters

Possible values: "DRAFT" "PENDING" "SCHEDULED" "PROCESSING" "SCHEDULED_DIRTY" "ERROR" "READY" "CANCELLED"

operationType

string

textMatchStyle

string

oldValues

object or null

Responses

200

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": {"version": 617,
"typedId": "3.CORSC",
"label": "Sales Compensations",
"calculationMessages": "[\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\"]",
"compensationRecordSetId": 1,
"compensationRecordSetLabel": "Sales Compensations",
"dtoFilter": {"_constructor": "AdvancedCriteria",
"criteria": [{"fieldName": "sourceId",
"operator": "equals",
"value": "CO-157"
}
],
"operator": "and"
},
"calculationType": "RECORD",
"calculationConfig": {"formulaName": "SC_Compensation",
"feederInputParams": [ ],
"inputParams": [ ],
"mappingParams": [ ],
"outputElements": [ ]
},
"createDate": "2022-06-09T08:21:13",
"createdBy": 290,
"lastUpdateDate": "2022-06-24T10:44:59",
"lastUpdateBy": 290,
"status": "READY",
"calculationStartDate": "2022-06-24T10:26:20",
"calculationDate": "2022-06-24T10:44:59",
"isDefault": true,
"incremental": false,
"incCalculationDate": "2022-06-24T10:26:20",
"shouldSubmit": false,
"valid": true
},
"operationType": "update",
"textMatchStyle": "exact",
"oldValues": null
}

Response samples

application/json

{"response": {"node": "node1",
"data": [{"version": 617,
"typedId": "3.CORSC",
"targetDate": null,
"label": "Sales Compensations",
"locale": null,
"calculationMessages": "[\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\"]",
"compensationRecordSetId": 1,
"compensationRecordSetLabel": "Sales Compensations",
"compensationRecordSet": {"version": 0,
"typedId": "1.CORS",
"targetDate": null,
"label": "Sales Compensations",
"locale": null,
"calculationMessages": null,
"numberOfItems": 0,
"keepManualOverrides": false,
"writeOnlyChangedItems": false,
"userGroupEdit": null,
"userGroupViewDetails": null,
"updatedBy": 119,
"updateDate": "2022-05-05",
"recordSetId": 1,
"createDate": "2022-05-05T11:36:03",
"createdBy": 119,
"lastUpdateDate": "2022-05-05T11:36:03",
"lastUpdateBy": 119,
"status": "DRAFT",
"calculationStartDate": null,
"calculationDate": null,
"id": 1
},
"dtoFilter": {"_constructor": "AdvancedCriteria",
"criteria": [{"fieldName": "sourceId",
"operator": "equals",
"value": "CO-157"
}
],
"operator": "and"
},
"sortBy": null,
"calculationType": "RECORD",
"adhocCalculation": null,
"calculationConfig": {"skuField": null,
"targetDateField": null,
"simulationSet": null,
"formulaName": "SC_Compensation",
"targetDate": null,
"feederFormulaName": null,
"feederInputParams": [ ],
"inputParams": [ ],
"mappingParams": [ ],
"outputElements": [ ],
"targetFields": null
},
"createDate": "2022-06-09T08:21:13",
"createdBy": 290,
"lastUpdateDate": "2022-06-24T10:59:56",
"lastUpdateBy": 1687,
"status": "READY",
"calculationStartDate": "2022-06-24T10:26:20",
"calculationDate": "2022-06-24T10:44:59",
"isDefault": true,
"incremental": false,
"incCalculationDate": "2022-06-24T10:44:59",
"shouldSubmit": false,
"valid": true
}
],
"status": 0
}
}