Upsert a Contract

name	string non-empty
label	string non-empty
lookupTableId	any
url	any
type	string non-empty
value	any
valueHint	any
readOnly	any
filter	any
parameterGroup	any
labelTranslations	any
addUnknownValues	any
typedId	any
alwaysEditable	any
inputs	Array of objects
parameterConfig	object
formattingOptions	object
valueOptions	any

required

object

openFolders	Array of objects
gridViewState	string non-empty
selectedNodes	Array of objects

outputs

required

Array of objects

lastUpdateByName

any

createdByName

any

submittedByName

any

calculationStatus

required

number

dirty

required

boolean

refreshInputs

required

boolean

nodeId

required

number

userGroupEdit

any

userGroupViewDetails

any

serverMessages

required

Array of objects

additionalInfo1

any

additionalInfo2

any

additionalInfo3

any

additionalInfo4

any

numberOfAttachments

required

number

creationWorkflowStatus

any

creationWorkflowCurrentStep

any

creationWorkflowStepCount

any

creationWorkflowStepLabel

any

signature

any

required

Array of objects non-empty unique

Array (non-empty)

version	any
typedId	any
clicId	any
	Array of objects non-empty unique
outputs	Array of objects
dirty	boolean
lineId	string non-empty
parentId	any
calculationStatus	number
editabilityStatus	number
label	string non-empty
startDate	any
endDate	any
priceRecordId	any
customerGroup	any
	object
calculationBaseJson	string non-empty
	object
folder	boolean
treeLabel	string non-empty
createDate	string non-empty
createdBy	number
lastUpdateDate	string non-empty
lastUpdateBy	number
contractTermType	string non-empty

customerGroup

any

required

object

label	any
productFieldName required	string non-empty
productFieldLabel required	string non-empty
productFieldValue required	string non-empty
productFilterCriteria	any

externalRef

any

contractStatus

required

string non-empty

startDate

required

string non-empty

endDate

required

string non-empty

status

required

string non-empty

required

Array of objects non-empty unique

Array (non-empty)

key	any
message required	string non-empty

hasWorkflowHistory

required

boolean

renderInfo

any

approvedByName

any

deniedByName

any

approvalRequiredEmailAttachmentsJson

any

createDate

required

string non-empty

createdBy

required

number

lastUpdateDate

required

string non-empty

lastUpdateBy

required

number

supersededBy

any

prevRev

any

rootUniqueName

any

Responses

200

Example response

Response Schema: application/json

object

node

string non-empty

Array of objects non-empty unique

Array (non-empty)

version	number
typedId	string non-empty
uniqueName	string non-empty
label	string non-empty
targetDate	string non-empty
workflowStatus	string non-empty
headerText	string
	Array of objects non-empty unique
viewState	any
outputs	Array of objects
lastUpdateByName	string non-empty
createdByName	string non-empty
submittedByName	any
calculationStatus	number
dirty	boolean
refreshInputs	boolean
nodeId	any
userGroupEdit	any
userGroupViewDetails	any
serverMessages	Array of objects
additionalInfo1	any
additionalInfo2	any
additionalInfo3	any
additionalInfo4	any
numberOfAttachments	number
creationWorkflowStatus	any
creationWorkflowCurrentStep	any
creationWorkflowStepCount	any
creationWorkflowStepLabel	any
signature	any
	Array of objects non-empty unique
customerGroup	any
	object
externalRef	any
contractStatus	string non-empty
startDate	string non-empty
endDate	string non-empty
status	string non-empty
approvedByName	any
deniedByName	any
approvalRequiredEmailAttachmentsJson	any
hasWorkflowHistory	boolean
renderInfo	any
	Array of objects non-empty unique
createDate	string non-empty
createdBy	number
lastUpdateDate	string non-empty
lastUpdateBy	number
supersededBy	any
prevRev	any
rootUniqueName	string non-empty

status

required

number

Request samples

application/json

{"data": {"contract": {"version": null,
"typedId": null,
"uniqueName": null,
"label": "New Agreement & Promotion",
"targetDate": "2022-01-04",
"workflowStatus": "DRAFT",
"headerText": "header text",
"inputs": [{"name": "CustomerGroup",
"label": "Customer(s)",
"lookupTableId": null,
"url": null,
"type": "CUSTOMERGROUP",
"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
},
{"name": "ProductGroup",
"label": "Product(s)",
"lookupTableId": null,
"url": null,
"type": "PRODUCTGROUP",
"value": {"productFieldName": "sku",
"productFieldLabel": "ProductID",
"productFieldValue": "B-0002"
},
"valueHint": "B-0002 (ProductID)",
"readOnly": null,
"filter": null,
"parameterGroup": null,
"required": null,
"labelTranslations": null,
"addUnknownValues": null,
"typedId": null,
"alwaysEditable": null,
"inputs": [ ],
"parameterConfig": { },
"formattingOptions": { },
"valueOptions": null
}
],
"viewState": {"openFolders": ["ROOT"
],
"gridViewState": "({field:[{name:\"CLITN_Status\",frozen:true,width:25},{name:\"CLITN_Status1\",frozen:true,width:25},{name:\"dirtyField\",frozen:true,width:25},{name:\"CLITN_Desc\",frozen:true},{name:\"label\"},{name:\"customerGroup\",visible:false},{name:\"productGroup\",visible:false},{name:\"INPUT_Discount__\",visible:false},{name:\"OUTPUT_CustomerGroup\",visible:false},{name:\"OUTPUT_ProductGroup\",visible:false},{name:\"OUTPUT_StandardDiscount\",visible:false}]})",
"selectedNodes": ["1OVM0Hxdn1zeLjN"
]
},
"outputs": [ ],
"lastUpdateByName": null,
"createdByName": null,
"submittedByName": null,
"calculationStatus": 2,
"dirty": false,
"refreshInputs": false,
"nodeId": 0,
"userGroupEdit": null,
"userGroupViewDetails": null,
"serverMessages": ["Agreements & Promotions calculated successfully"
],
"additionalInfo1": null,
"additionalInfo2": null,
"additionalInfo3": null,
"additionalInfo4": null,
"numberOfAttachments": 0,
"creationWorkflowStatus": null,
"creationWorkflowCurrentStep": null,
"creationWorkflowStepCount": null,
"creationWorkflowStepLabel": null,
"signature": null,
"lineItems": [{"version": null,
"typedId": null,
"clicId": null,
"inputs": [{"name": "Discount %",
"label": "Discount %",
"lookupTableId": null,
"url": null,
"type": "USERENTRY",
"value": null,
"valueHint": null,
"readOnly": null,
"filter": null,
"parameterGroup": null,
"required": null,
"labelTranslations": null,
"addUnknownValues": null,
"typedId": null,
"alwaysEditable": null,
"inputs": [ ],
"parameterConfig": {"dataType": "float"
},
"formattingOptions": { },
"valueOptions": null,
"inheritedValue": null
},
{"name": "CustomerGroup",
"label": "Customer(s)",
"lookupTableId": null,
"url": null,
"type": "CUSTOMERGROUP",
"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,
"inheritedValue": 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,
"inheritedValue": null
}
],
"outputs": [ ],
"dirty": false,
"lineId": "1OVM0Hxdn1zeLjN",
"parentId": null,
"calculationStatus": 2,
"editabilityStatus": 0,
"label": "Promotion Discount",
"startDate": null,
"endDate": null,
"priceRecordId": null,
"customerGroup": null,
"productGroup": {"label": null,
"productFieldName": "sku",
"productFieldLabel": "ProductID",
"productFieldValue": "B-0002",
"productFilterCriteria": null
},
"calculationBaseJson": "{\"includedCustomerGroups\":[],\"includedProductGroups\":[{\"productFieldName\":\"sku\",\"productFieldLabel\":\"ProductID\",\"productFieldValue\":\"B-0002\"}],\"includedSellerReferences\":[],\"excludedCustomerGroups\":[],\"excludedproductGroups\":[],\"excludedSellerReferences\":[],\"includedTimePeriods\":[{\"timeUnit\":\"DAY\",\"startDate\":\"2022-01-04\",\"endDate\":\"2022-01-04\",\"single\":false}],\"excludedTimePeriods\":[],\"otherFilters\":[],\"dateDimFieldName\":\"<timeField>\"}",
"calculationBase": {"includedCustomerGroups": [ ],
"includedProductGroups": [{"label": null,
"productFieldName": "sku",
"productFieldLabel": "ProductID",
"productFieldValue": "B-0002",
"productFilterCriteria": null
}
],
"includedSellerReferences": [ ],
"excludedCustomerGroups": [ ],
"excludedproductGroups": [ ],
"excludedSellerReferences": [ ],
"includedTimePeriods": [{"timeUnit": "DAY",
"startDate": "2022-01-04",
"endDate": "2022-01-04",
"single": false
}
],
"excludedTimePeriods": [ ],
"otherFilters": [ ],
"dateDimFieldName": "<timeField>"
},
"folder": false,
"treeLabel": "Promotion Discount",
"createDate": "2022-01-04T15:00:47",
"createdBy": 2147490187,
"lastUpdateDate": "2022-01-04T15:00:47",
"lastUpdateBy": 2147490187,
"contractTermType": "test"
}
],
"customerGroup": null,
"productGroup": {"label": null,
"productFieldName": "sku",
"productFieldLabel": "ProductID",
"productFieldValue": "B-0002",
"productFilterCriteria": null
},
"externalRef": null,
"contractStatus": "DRAFT",
"startDate": "2022-01-04",
"endDate": "2022-01-04",
"status": "DRAFT",
"serverMessagesExtended": [{"key": null,
"message": "Agreements & Promotions calculated successfully"
}
],
"hasWorkflowHistory": false,
"renderInfo": null,
"approvedByName": null,
"deniedByName": null,
"approvalRequiredEmailAttachmentsJson": null,
"createDate": "2022-01-04T15:00:47",
"createdBy": 2147490187,
"lastUpdateDate": "2022-01-04T15:00:47",
"lastUpdateBy": 2147490187,
"supersededBy": null,
"prevRev": null,
"rootUniqueName": null
}
}
}

Response samples

application/json

{"response": {"node": "string",
"data": [{"version": 0,
"typedId": "string",
"uniqueName": "string",
"label": "string",
"targetDate": "string",
"workflowStatus": "string",
"headerText": "string",
"inputs": [{"name": "string",
"label": "string",
"lookupTableId": null,
"url": null,
"type": "string",
"value": null,
"valueHint": null,
"readOnly": null,
"filter": null,
"parameterGroup": null,
"required": null,
"labelTranslations": null,
"addUnknownValues": null,
"typedId": "string",
"alwaysEditable": null,
"inputs": [{ }
],
"parameterConfig": { },
"formattingOptions": { },
"valueOptions": null
}
],
"viewState": null,
"outputs": [{ }
],
"lastUpdateByName": "string",
"createdByName": "string",
"submittedByName": null,
"calculationStatus": 0,
"dirty": true,
"refreshInputs": true,
"nodeId": null,
"userGroupEdit": null,
"userGroupViewDetails": null,
"serverMessages": [{ }
],
"additionalInfo1": null,
"additionalInfo2": null,
"additionalInfo3": null,
"additionalInfo4": null,
"numberOfAttachments": 0,
"creationWorkflowStatus": null,
"creationWorkflowCurrentStep": null,
"creationWorkflowStepCount": null,
"creationWorkflowStepLabel": null,
"signature": null,
"lineItems": [{"version": null,
"typedId": null,
"clicId": null,
"inputs": [{"name": null,
"label": null,
"lookupTableId": null,
"url": null,
"type": null,
"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
}
],
"outputs": [{"resultName": null,
"resultLabel": null,
"result": null,
"excludeFromExport": null,
"warnings": [ ],
"alertMessage": null,
"alertType": null,
"displayOptions": null,
"formatType": null,
"suffix": null,
"resultType": null,
"cssProperties": null,
"userGroup": null,
"resultGroup": null,
"overrideValueOptions": null,
"overrideAllowEmpty": null,
"labelTranslations": null,
"overridable": null,
"overridden": null,
"resultDescription": null
}
],
"dirty": true,
"lineId": "string",
"parentId": null,
"calculationStatus": 0,
"editabilityStatus": 0,
"label": "string",
"startDate": null,
"endDate": null,
"priceRecordId": null,
"customerGroup": null,
"productGroup": {"label": "string",
"productFieldName": null,
"productFieldLabel": null,
"productFieldValue": null,
"productFilterCriteria": {"_constructor": null,
"operator": null,
"criteria": [ ]
}
},
"calculationBaseJson": "string",
"calculationBase": {"includedCustomerGroups": [{ }
],
"includedProductGroups": [{ }
],
"includedSellerReferences": [{ }
],
"excludedCustomerGroups": [{ }
],
"excludedproductGroups": [{ }
],
"excludedSellerReferences": [{ }
],
"includedTimePeriods": [{ }
],
"excludedTimePeriods": [{ }
],
"otherFilters": [{ }
],
"dateDimFieldName": "string"
},
"folder": true,
"treeLabel": "string",
"createDate": "string",
"createdBy": 0,
"lastUpdateDate": "string",
"lastUpdateBy": 0,
"contractTermType": "string"
}
],
"customerGroup": null,
"productGroup": {"label": "string",
"productFieldName": null,
"productFieldLabel": null,
"productFieldValue": null,
"productFilterCriteria": {"_constructor": "string",
"operator": "string",
"criteria": [{"_constructor": null,
"operator": null,
"criteria": [ ]
}
]
}
},
"externalRef": null,
"contractStatus": "string",
"startDate": "string",
"endDate": "string",
"status": "string",
"approvedByName": null,
"deniedByName": null,
"approvalRequiredEmailAttachmentsJson": null,
"hasWorkflowHistory": true,
"renderInfo": null,
"serverMessagesExtended": [{"key": null,
"message": "string"
}
],
"createDate": "string",
"createdBy": 0,
"lastUpdateDate": "string",
"lastUpdateBy": 0,
"supersededBy": null,
"prevRev": null,
"rootUniqueName": "string"
}
],
"status": 0
}
}