Add Rebate Agreement Items

post/rebateagreement.additems

Adds items to the specified Rebate Agreement.

Securitybasic or X-PriceFx-jwt
Request
Request Body schema: application/json
object
object
version
number
typedId
required
string non-empty
uniqueName
required
string non-empty
label
string non-empty
targetDate
required
string non-empty
workflowStatus
required
string non-empty
headerText
any
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
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
number
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
required
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
rebateAgreementStatus
string non-empty
renderInfo
any
serverMessagesExtended
any
approvedByName
any
deniedByName
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
headerRebateType
any
sellerName
any
parent
any
rebateTypes
Array of strings
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": 6,
      • "typedId": "2147483857.RBA",
      • "uniqueName": "R-2147483857",
      • "label": "New Rebate Agreement",
      • "targetDate": "2021-10-19",
      • "workflowStatus": "DRAFT",
      • "headerText": null,
      • "inputs": [
        • {
          },
        • {
          }
        ],
      • "viewState": {
        • "gridViewState": null,
        • "openFolders": null,
        • "selectedNodes": null
        },
      • "outputs": [ ],
      • "lastUpdateByName": "ondrej.tesar",
      • "createdByName": "ondrej.tesar",
      • "submittedByName": null,
      • "calculationStatus": 0,
      • "dirty": false,
      • "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,
      • "lineItems": [ ],
      • "seller": null,
      • "customerGroup": null,
      • "startDate": "2021-10-19",
      • "endDate": "2021-10-19",
      • "payoutDate": "2021-10-19",
      • "rebateRecordSetId": null,
      • "rebateRecordSetLabel": null,
      • "simulationSet": null,
      • "simulationType": null,
      • "status": "DRAFT",
      • "rebateAgreementStatus": "DRAFT",
      • "renderInfo": null,
      • "serverMessagesExtended": null,
      • "approvedByName": null,
      • "deniedByName": null,
      • "approvalRequiredEmailAttachmentsJson": null,
      • "hasWorkflowHistory": false,
      • "createDate": "2021-10-19T11:27:13",
      • "createdBy": 2147483751,
      • "lastUpdateDate": "2021-10-19T11:27:13",
      • "lastUpdateBy": 2147483751,
      • "supersededBy": null,
      • "prevRev": null,
      • "rootUniqueName": "R-2147483857",
      • "headerRebateType": null,
      • "sellerName": null
      },
    • "parent": null,
    • "rebateTypes": [
      • "Rebates"
      ]
    }
}
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": [
          ],
        • "viewState": {
          },
        • "outputs": [ ],
        • "lastUpdateByName": "admin",
        • "createdByName": "admin",
        • "submittedByName": null,
        • "calculationStatus": 0,
        • "dirty": false,
        • "refreshInputs": false,
        • "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": [ ],
        • "seller": null,
        • "customerGroup": {
          },
        • "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": [
          ],
        • "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
    }
}