RebateAgreement

The type code is RBA.

Array of objects
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
seller
object
createdByName
string <= 255 characters
typedId
string
headerText
string
successfulCalculationMsg
string
Possible values: "SUCCESS" "COMMAND_GENERAL_ERROR" "COMMAND_GENERAL_ERROR_WITH_MSG" "COMMAND_GENERAL_ERROR_CONFLICT" "COMMAND_GENERAL_ERROR_CONFLICT_FIELD" "COMMAND_NOT_FOUND" "COMMAND_CONFIG_ERROR" "COMMAND_CONTEXT_PATH_NOTFOUND" "COMMAND_NOT_AUTHORIZED" "COMMAND_INVALID_PARAMETERS" "COMMAND_FORBIDDEN_IN_K8S" "COMMAND_FORBIDDEN_IN_READONLYMODE" "COMMAND_FORM_TOO_LARGE" "OBJECT_NOT_FOUND" "LOGIN_FAILURE" "LOGIN_FAILURE_BANNED" "LOGIN_FAILURE_TFA" "LOGIN_FAILURE_INACTIVE_OR_EXPIRED" "PARTITION_UNKNOWN" "COPY_OF_PREFIX" … 403 more
endDate
string <date-time>
workflowStatus
string <= 255 characters
Possible values: "DRAFT" "SUBMITTED" "DENIED" "APPROVED" "NO_APPROVAL_REQUIRED" "WITHDRAWN" "INVALIDATED"
Array of objects
Array
name
string
label
string
lookupTableId
string
url
string
type
string
value
object
valueHint
string
readOnly
boolean
object
property name*
additional property
object
parameterGroup
string
required
boolean
labelTranslations
string
addUnknownValues
boolean
typedId
string
alwaysEditable
boolean
inputs
Array of objects
object
property name*
additional property
object
object
property name*
additional property
object
valueOptions
Array of strings
lastUpdateDate
string <date-time>
readOnlyLineItemClass
string
Array of objects
Array
key
string
message
string
externalRef
string <= 255 characters
payoutDate
string <date-time>
deniedByName
string
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
object
label
string
customerFieldName
string
customerFieldLabel
string
customerFieldValue
string
object
object
label
string
productFieldName
string
productFieldLabel
string
productFieldValue
string
object
startDate
string <date-time>
endDate
string <date-time>
payoutDate
string <date-time>
calculationBaseJson
string
object
includedCustomerGroups
Array of objects
includedProductGroups
Array of objects
Array of objects
excludedCustomerGroups
Array of objects
excludedproductGroups
Array of objects
excludedSellerReferences
Array of objects
Array of objects
excludedTimePeriods
Array of objects
otherFilters
Array of objects
dateDimFieldName
string
simulationType
string
folder
boolean
treeLabel
string
createDate
string
createdBy
integer
lastUpdateDate
string
lastUpdateBy
integer
rebateType
string
rebateTypeLabel
string
userGroupViewDetails
string <= 255 characters
approvedByName
string
creationWorkflowCurrentStep
integer
rootUniqueName
string
originUniqueName
string
targetDate
string <date-time>
customerGroup
object
ioMeta
string
originDeleted
boolean
version
integer
uniqueName
string <= 255 characters
serverMessages
Array of strings
creationWorkflowStatus
string <= 255 characters
Possible values: "DRAFT" "INPROGRESS" "FINISHED"
userGroupEdit
string <= 255 characters
conditionTypeClass
string
hasWorkflowHistory
boolean
nodeId
integer
startDate
string <date-time>
status
string <= 255 characters
Possible values: "DRAFT" "PENDING" "SCHEDULED" "PROCESSING" "SCHEDULED_DIRTY" "ERROR" "READY" "CANCELLED"
lastUpdateByName
string <= 255 characters
originClicId
integer
object
property name*
additional property
object
object
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
rebateRecordSetId
integer
creationWorkflowStepCount
integer
sellerName
string
creationWorkflowStepLabel
string <= 255 characters
formulaElementGroupReadOnly
string
submittedByName
string <= 255 characters
formulaElementGroup
string
rebateAgreementStatus
string <= 255 characters
Possible values: "DRAFT" "APPROVED" "OPEN" "CLOSED" "REVOKED" "SUPERSEDED" "INVALIDATED"
createDate
string <date-time>
dirty
boolean
additionalInfo4
string <= 255 characters
additionalInfo3
string <= 255 characters
refreshInputs
boolean
additionalInfo2
number
additionalInfo1
number
numberOfAttachments
integer
originLabel
string
simulationType
string <= 255 characters
label
string <= 255 characters
nextRevUNs
Array of strings
rebateRecordSetLabel
string <= 255 characters
simulationSet
string <= 255 characters
productGroup
object
createdBy
integer
calculationWithErrorsMsg
string
Possible values: "SUCCESS" "COMMAND_GENERAL_ERROR" "COMMAND_GENERAL_ERROR_WITH_MSG" "COMMAND_GENERAL_ERROR_CONFLICT" "COMMAND_GENERAL_ERROR_CONFLICT_FIELD" "COMMAND_NOT_FOUND" "COMMAND_CONFIG_ERROR" "COMMAND_CONTEXT_PATH_NOTFOUND" "COMMAND_NOT_AUTHORIZED" "COMMAND_INVALID_PARAMETERS" "COMMAND_FORBIDDEN_IN_K8S" "COMMAND_FORBIDDEN_IN_READONLYMODE" "COMMAND_FORM_TOO_LARGE" "OBJECT_NOT_FOUND" "LOGIN_FAILURE" "LOGIN_FAILURE_BANNED" "LOGIN_FAILURE_TFA" "LOGIN_FAILURE_INACTIVE_OR_EXPIRED" "PARTITION_UNKNOWN" "COPY_OF_PREFIX" … 403 more
approvalRequiredEmailAttachmentsJson
string
object
gridViewState
string
openFolders
Array of strings
selectedNodes
Array of strings
prevRev
string
calculationStatus
integer
supersededBy
string
headerRebateType
string
lastUpdateBy
integer
{
  • "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"
      }
    ],
  • "seller": { },
  • "createdByName": "string",
  • "typedId": "string",
  • "headerText": "string",
  • "successfulCalculationMsg": "SUCCESS",
  • "endDate": "2019-08-24T14:15:22Z",
  • "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",
  • "serverMessagesExtended": [
    • {
      • "key": "string",
      • "message": "string"
      }
    ],
  • "externalRef": "string",
  • "payoutDate": "2019-08-24T14:15:22Z",
  • "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": {
          }
        },
      • "productGroup": {
        • "label": "string",
        • "productFieldName": "string",
        • "productFieldLabel": "string",
        • "productFieldValue": "string",
        • "productFilterCriteria": {
          }
        },
      • "startDate": "2019-08-24T14:15:22Z",
      • "endDate": "2019-08-24T14:15:22Z",
      • "payoutDate": "2019-08-24T14:15:22Z",
      • "calculationBaseJson": "string",
      • "calculationBase": {
        • "includedCustomerGroups": [
          ],
        • "includedProductGroups": [
          ],
        • "includedSellerReferences": [
          ],
        • "excludedCustomerGroups": [
          ],
        • "excludedproductGroups": [
          ],
        • "excludedSellerReferences": [
          ],
        • "includedTimePeriods": [
          ],
        • "excludedTimePeriods": [
          ],
        • "otherFilters": [
          ],
        • "dateDimFieldName": "string"
        },
      • "simulationType": "string",
      • "folder": true,
      • "treeLabel": "string",
      • "createDate": "string",
      • "createdBy": 0,
      • "lastUpdateDate": "string",
      • "lastUpdateBy": 0,
      • "rebateType": "string",
      • "rebateTypeLabel": "string"
      }
    ],
  • "userGroupViewDetails": "string",
  • "approvedByName": "string",
  • "creationWorkflowCurrentStep": 0,
  • "rootUniqueName": "string",
  • "originUniqueName": "string",
  • "targetDate": "2019-08-24T14:15:22Z",
  • "customerGroup": { },
  • "ioMeta": "string",
  • "originDeleted": true,
  • "version": 0,
  • "uniqueName": "string",
  • "serverMessages": [
    • "string"
    ],
  • "creationWorkflowStatus": "DRAFT",
  • "userGroupEdit": "string",
  • "conditionTypeClass": "string",
  • "hasWorkflowHistory": true,
  • "nodeId": 0,
  • "startDate": "2019-08-24T14:15:22Z",
  • "status": "DRAFT",
  • "lastUpdateByName": "string",
  • "originClicId": 0,
  • "renderInfo": {
    • "property1": { },
    • "property2": { }
    },
  • "signature": {
    • "envelopeId": "string",
    • "status": "sent",
    • "sentDateTime": "string",
    • "statusChangedDateTime": "string",
    • "customerName": "string",
    • "customerUserOrEmail": "string",
    • "sender": 0,
    • "senderName": "string",
    • "templateName": "string",
    • "note": "string",
    • "voidedReason": "string",
    • "error": "string",
    • "history": [
      • { }
      ]
    },
  • "rebateRecordSetId": 0,
  • "creationWorkflowStepCount": 0,
  • "sellerName": "string",
  • "creationWorkflowStepLabel": "string",
  • "formulaElementGroupReadOnly": "string",
  • "submittedByName": "string",
  • "formulaElementGroup": "string",
  • "rebateAgreementStatus": "DRAFT",
  • "createDate": "2019-08-24T14:15:22Z",
  • "dirty": true,
  • "additionalInfo4": "string",
  • "additionalInfo3": "string",
  • "refreshInputs": true,
  • "additionalInfo2": 0,
  • "additionalInfo1": 0,
  • "numberOfAttachments": 0,
  • "originLabel": "string",
  • "simulationType": "string",
  • "label": "string",
  • "nextRevUNs": [
    • "string"
    ],
  • "rebateRecordSetLabel": "string",
  • "simulationSet": "string",
  • "productGroup": { },
  • "createdBy": 0,
  • "calculationWithErrorsMsg": "SUCCESS",
  • "approvalRequiredEmailAttachmentsJson": "string",
  • "viewState": {
    • "gridViewState": "string",
    • "openFolders": [
      • "string"
      ],
    • "selectedNodes": [
      • "string"
      ]
    },
  • "prevRev": "string",
  • "calculationStatus": 0,
  • "supersededBy": "string",
  • "headerRebateType": "string",
  • "lastUpdateBy": 0
}