Submit 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
required	any
labelTranslations	any
addUnknownValues	any
typedId	any
alwaysEditable	any
inputs	Array of objects
parameterConfig	object
formattingOptions	object
valueOptions	any

object

gridViewState	any
openFolders	any
selectedNodes	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

any

additionalInfo1

any

additionalInfo2

any

additionalInfo3

any

additionalInfo4

any

numberOfAttachments

number

creationWorkflowStatus

any

creationWorkflowCurrentStep

any

creationWorkflowStepCount

any

creationWorkflowStepLabel

any

signature

any

lineItems

Array of objects

customerGroup

any

productGroup

any

externalRef

any

contractStatus

string non-empty

startDate

string non-empty

endDate

string non-empty

status

string non-empty

approvedByName

any

deniedByName

any

renderInfo

any

serverMessagesExtended

any

approvalRequiredEmailAttachmentsJson

any

hasWorkflowHistory

boolean

createDate

string non-empty

createdBy

number

lastUpdateDate

string non-empty

lastUpdateBy

number

supersededBy

any

prevRev

any

rootUniqueName

string non-empty

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": 3,
"typedId": "170.CT",
"uniqueName": "C-170",
"label": "New Agreement & Promotion",
"targetDate": "2021-11-18",
"workflowStatus": "DRAFT",
"headerText": "",
"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": 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": false,
"refreshInputs": false,
"nodeId": null,
"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,
"lineItems": [ ],
"customerGroup": null,
"productGroup": null,
"externalRef": null,
"contractStatus": "DRAFT",
"startDate": "2021-11-18",
"endDate": "2021-11-18",
"status": "DRAFT",
"approvedByName": null,
"deniedByName": null,
"renderInfo": null,
"serverMessagesExtended": null,
"approvalRequiredEmailAttachmentsJson": null,
"hasWorkflowHistory": false,
"createDate": "2021-11-18T15:48:25",
"createdBy": 2147490696,
"lastUpdateDate": "2021-11-18T15:48:25",
"lastUpdateBy": 2147490696,
"supersededBy": null,
"prevRev": null,
"rootUniqueName": "C-170"
}
}
}

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
}
}