Update a Quote/Contract/Rebate Agreement/Compensation Plan

post/clicmanager.update/{typedId}

Updates a Quote, Contract, Rebate Agreement, or Compensation Plan.
attributeExtension can be updated as follows:

{
                "data": {
                    "typedId": "{typedId}",
                    "version": {version},
                    "attributeExtension___AttributeExtensionColumn2": "testValue"
                }
            }

This endpoint is used in the REACT version only. It is not advisable to mix REACT endpoints together with Ember endpoints.

Securitybasic or X-PriceFx-jwt

Request

path Parameters

typedId

required

string

The typedId of the Compensation Plan you want to update.

Request Body schema: application/json

Quote (object) or Compensation (object) or Contract (object) or RebateAgreement (object)

Any of:

The type code is Q.

Array of objects or null

Array

resultName	string
resultLabel	string
result	object
excludeFromExport	boolean
warnings	Array of strings
alertMessage	string
alertType	string Possible values: "CRITICAL" "RED" "YELLOW"
displayOptions	integer
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"
suffix	string
resultType	string
cssProperties	string
userGroup	string
resultGroup	string
overrideValueOptions	Array of any
overrideAllowEmpty	boolean
labelTranslations	string
overridable	boolean
overridden	boolean
resultDescription	string

createdByName

string <= 255 characters

typedId

string

headerText

string

workflowStatus

string <= 255 characters

Possible values: "DRAFT" "SUBMITTED" "DENIED" "APPROVED" "NO_APPROVAL_REQUIRED" "WITHDRAWN" "INVALIDATED"

Array of objects or null

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

lastUpdateDate

string <date-time>

Array of objects or null

Array

key	string
message	string

externalRef

string or null <= 255 characters

deniedByName

string or null

Array of objects

Array

version	integer
typedId	string
clicId	integer
inputs	Array of objects
outputs	Array of objects
dirty	boolean
lineId	string
parentId	string
calculationStatus	integer
editabilityStatus	integer
label	string
containsProductImage	boolean
sku	string
priceRecordId	integer
folder	boolean
treeLabel	string
createDate	string
createdBy	integer
lastUpdateDate	string
lastUpdateBy	integer

userGroupViewDetails

string or null <= 255 characters

approvedByName

string or null

creationWorkflowCurrentStep

integer or null

rootUniqueName

string

originUniqueName

string or null

targetDate

string or null <date>

customerGroup

string or null

object or string

Any of:

object

originDeleted

boolean or null

version

integer

customerName

string or null <= 255 characters

uniqueName

string <= 255 characters

serverMessages

Array of strings or null

creationWorkflowStatus

string <= 255 characters

Possible values: "DRAFT" "INPROGRESS" "FINISHED"

userGroupEdit

string or null <= 255 characters

hasWorkflowHistory

boolean

nodeId

integer

status

string <= 255 characters

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

lastUpdateByName

string <= 255 characters

originClicId

integer or null

object or null

property name*

additional property

object

lostReason

string or null <= 255 characters

object or null

envelopeId	string
status	string Possible values: "sent" "delivered" "signed" "completed" "declined" "voided" "processing" "error" "cancelling"
sentDateTime	string
statusChangedDateTime	string
customerName	string
customerUserOrEmail	string
sender	integer
senderName	string
templateName	string
note	string
voidedReason	string
error	string
history	Array of objects

creationWorkflowStepCount

integer or null

quoteType

string or null

quoteStatus

string <= 255 characters

Possible values: "DRAFT" "OFFER" "DEAL" "REVOKED" "SUPERSEDED" "INVALIDATED" "LOST" "PARTIALDEAL"

lostReasonComment

string or null <= 255 characters

expiryDate

string or null <date>

creationWorkflowStepLabel

string or null <= 255 characters

customerId

string or null <= 255 characters

submittedByName

string or null <= 255 characters

createDate

string <date-time>

dirty

boolean

additionalInfo4

string or null <= 255 characters

additionalInfo3

string or null <= 255 characters

refreshInputs

boolean

additionalInfo2

number or null

additionalInfo1

number or null

numberOfAttachments

integer

originLabel

string or null

label

string <= 255 characters

nextRevUNs

Array of strings

createdBy

integer

approvalRequiredEmailAttachmentsJson

string or null

object or null

gridViewState	string
openFolders	Array of strings
selectedNodes	Array of strings

prevRev

string or null

calculationStatus

integer

supersededBy

string or null

lastUpdateBy

integer

persistedClicId

integer or null

persistedClicVersion

integer

Responses

200

Response Schema: application/json

object

node

string

Array of Quote (object) or Compensation (object) or Contract (object) or RebateAgreement (object)

Array

Any of:

The type code is Q.

	Array of objects or null
createdByName	string <= 255 characters
typedId	string
headerText	string
workflowStatus	string <= 255 characters Possible values: "DRAFT" "SUBMITTED" "DENIED" "APPROVED" "NO_APPROVAL_REQUIRED" "WITHDRAWN" "INVALIDATED"
	Array of objects or null
lastUpdateDate	string <date-time>
	Array of objects or null
externalRef	string or null <= 255 characters
deniedByName	string or null
	Array of objects
userGroupViewDetails	string or null <= 255 characters
approvedByName	string or null
creationWorkflowCurrentStep	integer or null
rootUniqueName	string
originUniqueName	string or null
targetDate	string or null <date>
customerGroup	string or null
	object or string
originDeleted	boolean or null
version	integer
customerName	string or null <= 255 characters
uniqueName	string <= 255 characters
serverMessages	Array of strings or null
creationWorkflowStatus	string <= 255 characters Possible values: "DRAFT" "INPROGRESS" "FINISHED"
userGroupEdit	string or null <= 255 characters
hasWorkflowHistory	boolean
nodeId	integer
status	string <= 255 characters Possible values: "DRAFT" "PENDING" "SCHEDULED" "PROCESSING" "SCHEDULED_DIRTY" "ERROR" "READY" "CANCELLED"
lastUpdateByName	string <= 255 characters
originClicId	integer or null
	object or null
lostReason	string or null <= 255 characters
	object or null
creationWorkflowStepCount	integer or null
quoteType	string or null
quoteStatus	string <= 255 characters Possible values: "DRAFT" "OFFER" "DEAL" "REVOKED" "SUPERSEDED" "INVALIDATED" "LOST" "PARTIALDEAL"
lostReasonComment	string or null <= 255 characters
expiryDate	string or null <date>
creationWorkflowStepLabel	string or null <= 255 characters
customerId	string or null <= 255 characters
submittedByName	string or null <= 255 characters
createDate	string <date-time>
dirty	boolean
additionalInfo4	string or null <= 255 characters
additionalInfo3	string or null <= 255 characters
refreshInputs	boolean
additionalInfo2	number or null
additionalInfo1	number or null
numberOfAttachments	integer
originLabel	string or null
label	string <= 255 characters
nextRevUNs	Array of strings
createdBy	integer
approvalRequiredEmailAttachmentsJson	string or null
	object or null
prevRev	string or null
calculationStatus	integer
supersededBy	string or null
lastUpdateBy	integer
persistedClicId	integer or null
persistedClicVersion	integer

status

integer

Request samples

application/json

{"data": {"version": 10,
"typedId": "8.CO",
"uniqueName": "CO-8",
"label": "New Compensation Plan",
"targetDate": "2022-06-22",
"workflowStatus": "DRAFT",
"inputs": [{"name": "CustomerGroup",
"label": "Customer(s)",
"lookupTableId": null,
"url": null,
"type": "CUSTOMERGROUP",
"value": {"customerFilterCriteria": {"_constructor": "AdvancedCriteria",
"operator": "and",
"criteria": [{"fieldName": "customerId",
"operator": "inSet",
"value": ["001",
"00001"
]
}
]
},
"label": "001,00001"
},
"valueHint": null,
"readOnly": null,
"filter": null,
"parameterGroup": null,
"required": null,
"labelTranslations": null,
"addUnknownValues": null,
"typedId": null,
"alwaysEditable": null,
"inputs": [ ],
"parameterConfig": { },
"formattingOptions": { },
"valueOptions": null
},
{"name": "ProductGroup",
"label": "Product(s)",
"lookupTableId": null,
"url": null,
"type": "PRODUCTGROUP",
"value": null,
"valueHint": null,
"readOnly": null,
"filter": null,
"parameterGroup": null,
"required": null,
"labelTranslations": null,
"addUnknownValues": null,
"typedId": null,
"alwaysEditable": null,
"inputs": [ ],
"parameterConfig": { },
"formattingOptions": { },
"valueOptions": null
}
],
"viewState": {"gridViewState": null,
"openFolders": null,
"selectedNodes": null
},
"outputs": [ ],
"lastUpdateByName": "admin",
"createdByName": "admin",
"submittedByName": null,
"calculationStatus": 0,
"dirty": true,
"refreshInputs": false,
"nodeId": 0,
"userGroupEdit": null,
"userGroupViewDetails": null,
"serverMessages": null,
"additionalInfo1": null,
"additionalInfo2": null,
"additionalInfo3": null,
"additionalInfo4": null,
"numberOfAttachments": 0,
"creationWorkflowStatus": null,
"creationWorkflowCurrentStep": null,
"creationWorkflowStepCount": null,
"creationWorkflowStepLabel": null,
"signature": null,
"sellerGroup": null,
"customerGroup": null,
"startDate": "2022-06-22",
"endDate": "2022-06-22",
"payoutDate": "2022-06-22",
"compensationRecordSetId": null,
"compensationRecordSetLabel": null,
"simulationSet": null,
"simulationType": null,
"status": "DRAFT",
"compensationStatus": "DRAFT",
"readOnlyLineItemClass": "net.pricefx.domain.CompensationReadOnlyLineItem",
"formulaElementGroupReadOnly": "compensationReadOnly",
"successfulCalculationMsg": "COMPENSATION_CALCULATED",
"calculationWithErrorsMsg": "COMPENSATION_CALCULATED_WITHERRORS",
"conditionTypeClass": "net.pricefx.domain.CompensationConditionType",
"formulaElementGroup": "compensation",
"approvalRequiredEmailAttachmentsJson": null,
"renderInfo": null,
"serverMessagesExtended": null,
"approvedByName": null,
"deniedByName": null,
"hasWorkflowHistory": false,
"createDate": "2022-06-22T11:44:40",
"createdBy": 2147490696,
"lastUpdateDate": "2022-06-22T11:55:08",
"lastUpdateBy": 2147490696,
"supersededBy": null,
"prevRev": null,
"rootUniqueName": "CO-8",
"ioMeta": {"inputs": { },
"outputs": { }
},
"compensationHeaderType": null,
"headerText": "<p>testno</p>"
}
}

Response samples

application/json

{"response": {"node": "string",
"data": [{"outputs": [{"resultName": "string",
"resultLabel": "string",
"result": { },
"excludeFromExport": true,
"warnings": ["string"
],
"alertMessage": "string",
"alertType": "CRITICAL",
"displayOptions": 0,
"formatType": "NUMERIC",
"suffix": "string",
"resultType": "string",
"cssProperties": "string",
"userGroup": "string",
"resultGroup": "string",
"overrideValueOptions": [null
],
"overrideAllowEmpty": true,
"labelTranslations": "string",
"overridable": true,
"overridden": true,
"resultDescription": "string"
}
],
"createdByName": "string",
"typedId": "string",
"headerText": "string",
"successfulCalculationMsg": "SUCCESS",
"endDate": null,
"workflowStatus": "DRAFT",
"inputs": [{"name": "string",
"label": "string",
"lookupTableId": "string",
"url": "string",
"type": "string",
"value": { },
"valueHint": "string",
"readOnly": true,
"filter": {"property1": { },
"property2": { }
},
"parameterGroup": "string",
"required": true,
"labelTranslations": "string",
"addUnknownValues": true,
"typedId": "string",
"alwaysEditable": true,
"inputs": [{ }
],
"parameterConfig": {"property1": { },
"property2": { }
},
"formattingOptions": {"property1": { },
"property2": { }
},
"valueOptions": ["string"
]
}
],
"lastUpdateDate": "2019-08-24T14:15:22Z",
"readOnlyLineItemClass": "string",
"compensationHeaderType": "string",
"serverMessagesExtended": [{"key": "string",
"message": "string"
}
],
"compensationRecordSetLabel": "string",
"payoutDate": null,
"deniedByName": "string",
"lineItems": [{"version": 0,
"typedId": "string",
"clicId": 0,
"inputs": [{ }
],
"outputs": [{ }
],
"dirty": true,
"lineId": "string",
"parentId": "string",
"calculationStatus": 0,
"editabilityStatus": 0,
"label": "string",
"containsProductImage": true,
"customerGroup": {"label": "string",
"customerFieldName": "string",
"customerFieldLabel": "string",
"customerFieldValue": "string",
"customerFilterCriteria": {"property1": { },
"property2": { }
}
},
"productGroup": {"label": "string",
"productFieldName": "string",
"productFieldLabel": "string",
"productFieldValue": "string",
"productFilterCriteria": {"property1": { },
"property2": { }
}
},
"startDate": null,
"endDate": null,
"payoutDate": "2019-08-24T14:15:22Z",
"calculationBaseJson": "string",
"calculationBase": {"includedCustomerGroups": [{ }
],
"includedProductGroups": [{ }
],
"includedSellerReferences": [{"sellerId": "string",
"sellerName": "string"
}
],
"excludedCustomerGroups": [{ }
],
"excludedproductGroups": [{ }
],
"excludedSellerReferences": [{ }
],
"includedTimePeriods": [{"timeUnit": "DAY",
"startDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z",
"single": true
}
],
"excludedTimePeriods": [{ }
],
"otherFilters": [0
],
"dateDimFieldName": "string"
},
"simulationType": "string",
"folder": true,
"treeLabel": "string",
"createDate": "string",
"createdBy": 0,
"lastUpdateDate": "string",
"lastUpdateBy": 0,
"compensationConditionType": "string",
"compensationConditionTypeLabel": "string"
}
],
"userGroupViewDetails": "string",
"approvedByName": "string",
"creationWorkflowCurrentStep": 0,
"rootUniqueName": "string",
"targetDate": "2019-08-24T14:15:22Z",
"customerGroup": { },
"ioMeta": "string",
"version": 0,
"uniqueName": "string",
"serverMessages": ["string"
],
"creationWorkflowStatus": "DRAFT",
"userGroupEdit": "string",
"conditionTypeClass": "string",
"hasWorkflowHistory": true,
"nodeId": 0,
"startDate": null,
"status": "DRAFT",
"lastUpdateByName": "string",
"renderInfo": {"property1": { },
"property2": { }
},
"signature": {"envelopeId": "string",
"status": "sent",
"sentDateTime": 0,
"statusChangedDateTime": 0,
"customerName": "string",
"customerUserOrEmail": "string",
"sender": 0,
"senderName": "string",
"templateName": "string",
"note": "string",
"voidedReason": "string",
"error": "string",
"history": [{ }
]
},
"creationWorkflowStepCount": 0,
"sellerGroup": 0,
"compensationRecordSetId": 0,
"creationWorkflowStepLabel": "string",
"formulaElementGroupReadOnly": "string",
"submittedByName": "string",
"formulaElementGroup": "string",
"createDate": "2019-08-24T14:15:22Z",
"dirty": true,
"additionalInfo4": "string",
"additionalInfo3": "string",
"refreshInputs": true,
"additionalInfo2": 0,
"additionalInfo1": 0,
"numberOfAttachments": 0,
"compensationStatus": "DRAFT",
"simulationType": "string",
"label": "string",
"nextRevUNs": ["string"
],
"simulationSet": "string",
"createdBy": 0,
"calculationWithErrorsMsg": "SUCCESS",
"approvalRequiredEmailAttachmentsJson": "string",
"viewState": {"gridViewState": "string",
"openFolders": ["string"
],
"selectedNodes": ["string"
]
},
"prevRev": "string",
"calculationStatus": 0,
"supersededBy": "string",
"lastUpdateBy": 0
}
],
"status": 0
}
}