Upsert a Rebate Agreement

Creates or updates a Rebate Agreement. Assigns new uniqueName when a new Rebate Agreement is created. To update a Rebate Agreement, specify an existing uniqueName.

Securitybasic or X-PriceFx-jwt

Request

Request Body schema: application/json

object

version

any

typedId

any

uniqueName

any

label

string non-empty

targetDate

string non-empty

workflowStatus

string non-empty

headerText

string

Array of objects non-empty unique

Array (non-empty)

name	string non-empty
label	string non-empty
lookupTableId	any
url	any
type	string non-empty
	object
valueHint	string non-empty
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

any

createdByName

any

submittedByName

any

calculationStatus

number

dirty

boolean

refreshInputs

boolean

nodeId

any

userGroupEdit

any

userGroupViewDetails

any

serverMessages

Array of strings

additionalInfo1

any

additionalInfo2

any

additionalInfo3

any

additionalInfo4

any

numberOfAttachments

number

creationWorkflowStatus

any

creationWorkflowCurrentStep

any

creationWorkflowStepCount

any

creationWorkflowStepLabel

any

signature

any

lineItems

Array of objects

seller

any

customerGroup

any

startDate

string non-empty

endDate

string non-empty

payoutDate

string non-empty

rebateRecordSetId

any

rebateRecordSetLabel

any

simulationSet

any

simulationType

any

status

string non-empty

approvedByName

any

deniedByName

any

renderInfo

any

Array of objects non-empty unique

Array (non-empty)

key	any
message	string non-empty

approvalRequiredEmailAttachmentsJson

any

hasWorkflowHistory

boolean

createDate

string non-empty

createdBy

number

lastUpdateDate

string non-empty

lastUpdateBy

number

supersededBy

any

prevRev

any

rootUniqueName

any

headerRebateType

any

sellerName

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
	object
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 strings
additionalInfo1	any
additionalInfo2	any
additionalInfo3	any
additionalInfo4	any
numberOfAttachments	number
creationWorkflowStatus	any
creationWorkflowCurrentStep	any
creationWorkflowStepCount	any
creationWorkflowStepLabel	any
signature	any
lineItems	Array of objects
seller	any
	object
startDate	string non-empty
endDate	string non-empty
payoutDate	string non-empty
rebateRecordSetId	any
rebateRecordSetLabel	any
simulationSet	any
simulationType	any
status	string non-empty
rebateAgreementStatus	string non-empty
approvedByName	any
deniedByName	any
renderInfo	any
	Array of objects non-empty unique
approvalRequiredEmailAttachmentsJson	any
hasWorkflowHistory	boolean
createDate	string non-empty
createdBy	number
lastUpdateDate	string non-empty
lastUpdateBy	number
supersededBy	any
prevRev	any
rootUniqueName	string non-empty
headerRebateType	any
sellerName	any

status

required

number

Request samples

application/json

{"data": {"rebateAgreement": {"version": null,
"typedId": null,
"uniqueName": null,
"label": "RBA001",
"targetDate": "2021-11-26",
"workflowStatus": "DRAFT",
"headerText": "",
"inputs": [{"name": "CustomerGroup",
"label": "Customer(s)",
"lookupTableId": null,
"url": null,
"type": "CUSTOMERGROUP",
"value": {"customerFieldName": "customerId",
"customerFieldValue": "00003",
"customerFieldLabel": "customerId",
"customerHint": "Kate Smith"
},
"valueHint": "Kate Smith",
"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": {"productFilterCriteria": {"_constructor": "AdvancedCriteria",
"operator": "or",
"criteria": [{"_constructor": "AdvancedCriteria",
"operator": "and",
"criteria": [{"fieldName": "sku",
"operator": "iEquals",
"value": "11111"
}
]
},
{"_constructor": "AdvancedCriteria",
"operator": "and",
"criteria": [{"fieldName": "sku",
"operator": "iEquals",
"value": "22222"
}
]
},
{"_constructor": "AdvancedCriteria",
"operator": "and",
"criteria": [{"fieldName": "sku",
"operator": "iEquals",
"value": "33333"
}
]
}
]
},
"label": "SKU equals to 11111 or SKU equals to 22222 or SKU equals to 33333"
},
"valueHint": "SKU equals to 11111 or SKU equals to 22222 or SKU equals to 33333",
"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": null,
"createdByName": null,
"submittedByName": null,
"calculationStatus": 0,
"dirty": false,
"refreshInputs": false,
"nodeId": null,
"userGroupEdit": null,
"userGroupViewDetails": null,
"serverMessages": ["Rebates calculated successfully"
],
"additionalInfo1": null,
"additionalInfo2": null,
"additionalInfo3": null,
"additionalInfo4": null,
"numberOfAttachments": 0,
"creationWorkflowStatus": null,
"creationWorkflowCurrentStep": null,
"creationWorkflowStepCount": null,
"creationWorkflowStepLabel": null,
"signature": null,
"lineItems": [ ],
"seller": null,
"customerGroup": null,
"startDate": "2021-11-26",
"endDate": "2021-11-26",
"payoutDate": "2021-11-26",
"rebateRecordSetId": null,
"rebateRecordSetLabel": null,
"simulationSet": null,
"simulationType": null,
"status": "DRAFT",
"approvedByName": null,
"deniedByName": null,
"renderInfo": null,
"serverMessagesExtended": [{"key": null,
"message": "Rebates calculated successfully"
}
],
"approvalRequiredEmailAttachmentsJson": null,
"hasWorkflowHistory": false,
"createDate": "2021-11-26T13:42:10",
"createdBy": 2147490696,
"lastUpdateDate": "2021-11-26T13:42:10",
"lastUpdateBy": 2147490696,
"supersededBy": null,
"prevRev": null,
"rootUniqueName": null,
"headerRebateType": null,
"sellerName": null
}
}
}

Response samples

application/json

{"response": {"node": "e2e-templates-node",
"data": [{"version": 4,
"typedId": "2147483868.RBA",
"uniqueName": "R-2147483868",
"label": "RBA001",
"targetDate": "2021-11-26",
"workflowStatus": "DRAFT",
"headerText": "",
"inputs": [{"name": "CustomerGroup",
"label": "Customer(s)",
"lookupTableId": null,
"url": null,
"type": "CUSTOMERGROUP",
"value": {"customerFieldName": "customerId",
"customerFieldValue": "00003",
"customerFieldLabel": "customerId"
},
"valueHint": "Kate Smith",
"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": {"productFilterCriteria": {"_constructor": "AdvancedCriteria",
"operator": "or",
"criteria": [{"_constructor": "AdvancedCriteria",
"operator": "and",
"criteria": [{"fieldName": "sku",
"operator": "iEquals",
"value": "11111"
}
]
},
{"_constructor": "AdvancedCriteria",
"operator": "and",
"criteria": [{"fieldName": "sku",
"operator": "iEquals",
"value": "22222"
}
]
},
{"_constructor": "AdvancedCriteria",
"operator": "and",
"criteria": [{"fieldName": "sku",
"operator": "iEquals",
"value": "33333"
}
]
}
]
},
"label": "SKU equals to 11111 or SKU equals to 22222 or SKU equals to 33333"
},
"valueHint": "SKU equals to 11111 or SKU equals to 22222 or SKU equals to 33333",
"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": ["Rebates calculated successfully"
],
"additionalInfo1": null,
"additionalInfo2": null,
"additionalInfo3": null,
"additionalInfo4": null,
"numberOfAttachments": 0,
"creationWorkflowStatus": null,
"creationWorkflowCurrentStep": null,
"creationWorkflowStepCount": null,
"creationWorkflowStepLabel": null,
"signature": null,
"lineItems": [ ],
"seller": null,
"customerGroup": {"label": null,
"customerFieldName": "customerId",
"customerFieldLabel": "customerId",
"customerFieldValue": "00003",
"customerFilterCriteria": null
},
"startDate": "2021-11-26",
"endDate": "2021-11-26",
"payoutDate": "2021-11-26",
"rebateRecordSetId": null,
"rebateRecordSetLabel": null,
"simulationSet": null,
"simulationType": null,
"status": "DRAFT",
"rebateAgreementStatus": "DRAFT",
"approvedByName": null,
"deniedByName": null,
"renderInfo": null,
"serverMessagesExtended": [{"key": null,
"message": "Rebates calculated successfully"
}
],
"approvalRequiredEmailAttachmentsJson": null,
"hasWorkflowHistory": false,
"createDate": "2021-11-26T13:43:47",
"createdBy": 2147490696,
"lastUpdateDate": "2021-11-26T13:43:47",
"lastUpdateBy": 2147490696,
"supersededBy": null,
"prevRev": null,
"rootUniqueName": "R-2147483868",
"headerRebateType": null,
"sellerName": null
}
],
"status": 0
}
}