Compensation

The Compensation object. The type code is CO.

Array of objects or null

Header results calculated for the Compensation Plan by the compensation header logic. Usually a summary / overall results for the whole agreement.

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
createdByName
string <= 255 characters
typedId
string
headerText
string or null
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" … 382 more
endDate
string or null

The last day of validity.

workflowStatus
string <= 255 characters
Possible values: "DRAFT" "SUBMITTED" "DENIED" "APPROVED" "NO_APPROVAL_REQUIRED" "WITHDRAWN" "INVALIDATED"
Array of objects or null

Custom header input fields, created by the compensation header logic. It is used by the user to enter values/conditions needed to calculate the results.

Array
name
string
label
string
lookupTableId
string or null
url
string or null
type
string
value
object or null
valueHint
string or null
readOnly
boolean or null
object or null
property name*
additional property
object
parameterGroup
string or null
required
boolean or null
labelTranslations
string or null
addUnknownValues
boolean or null
typedId
string or null
alwaysEditable
boolean or null
inputs
Array of objects
object
property name*
additional property
object
object
property name*
additional property
object
valueOptions
Array of strings or null
lastUpdateDate
string <date-time>
readOnlyLineItemClass
string
compensationHeaderType
string or null
Array of objects or null
Array
key
string or null
message
string
compensationRecordSetLabel
string or null <= 255 characters
payoutDate
string or null

The date on which the seller expects to receive the compensation money. If there are more payout periods during the Contract duration, such dates will be specified via custom input fields.

deniedByName
string or null
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 or null
endDate
string or null
payoutDate
string or null <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
Array of (integer or null) or (string or null) or (number or null) or (string or null) or (string or null) or (string or null)
dateDimFieldName
string
simulationType
string
folder
boolean
treeLabel
string
createDate
string
createdBy
integer
lastUpdateDate
string
lastUpdateBy
integer
compensationConditionType
string
compensationConditionTypeLabel
string
userGroupViewDetails
string or null <= 255 characters
approvedByName
string or null
creationWorkflowCurrentStep
integer or null

The order of the current active creation step. The first step is the number 0.

rootUniqueName
string
originUniqueName
string or null
targetDate
string or null

Stands for a "calculation date" – a date which will be used to distinguish which data are used for calculation. Its value is used automatically by the system when retrieving proper versions of Company Parameters. You can also use it the logic to select correct data which change in time.

customerGroup
object or null

A selection of customers (usually based on the customer hierarchy) the plan is intended for.

string or object
Any of:
string
originDeleted
boolean
version
integer
uniqueName
string <= 255 characters

ID of the plan, generated by the system. The prefix of the uniqueName can be modified in Administration > Configuration > System Configuration > Advanced Configuration Options.

serverMessages
Array of strings or null
creationWorkflowStatus
string or null <= 255 characters
Possible values: "DRAFT" "INPROGRESS" "FINISHED" null
userGroupEdit
string or null <= 255 characters
conditionTypeClass
string
hasWorkflowHistory
boolean
nodeId
integer
startDate
string or null

The first day of validity of conditions negotiated on the Compensation Plan header & lines.

status
string <= 255 characters
Possible values: "DRAFT" "PENDING" "SCHEDULED" "PROCESSING" "SCHEDULED_DIRTY" "ERROR" "READY" "CANCELLED"
lastUpdateByName
string <= 255 characters
originClicId
integer or null
object or null
property name*
additional property
object
object or null
envelopeId
string
status
string
Possible values: "sent" "delivered" "signed" "completed" "declined" "voided" "processing" "error" "cancelling"
(integer or null) or (string or null) or (number or null) or (string or null) or (string or null) or (string or null)
Any of:
integer or null
(integer or null) or (string or null) or (number or null) or (string or null) or (string or null) or (string or null)
Any of:
integer or null
customerName
string
customerUserOrEmail
string
sender
integer
senderName
string
templateName
string
note
string
voidedReason
string
error
string
history
Array of objects
creationWorkflowStepCount
integer or null

The total number of all creation steps.

(integer or null) or (string or null) or (number or null) or (string or null) or (string or null) or (string or null) or (object or null)

A selection of sellers (usually based on the seller hierarchy) the plan is intended for.

Any of:

A selection of sellers (usually based on the seller hierarchy) the plan is intended for.

integer or null

A selection of sellers (usually based on the seller hierarchy) the plan is intended for.

compensationRecordSetId
integer or null
creationWorkflowStepLabel
string or null <= 255 characters

The label of the current creation workflow step.

formulaElementGroupReadOnly
string
submittedByName
string or null <= 255 characters
formulaElementGroup
string
createDate
string <date-time>
dirty
boolean
additionalInfo4
string or null <= 255 characters
additionalInfo3
string or null <= 255 characters
refreshInputs
boolean
additionalInfo2
number or null
additionalInfo1
number or null
numberOfAttachments
integer
compensationStatus
string <= 255 characters

Status of the Compensation Plan.

Possible values: "DRAFT" "APPROVED" "OPEN" "CLOSED" "REVOKED" "SUPERSEDED" "INVALIDATED"
originLabel
string or null <= 255 characters
simulationType
string or null <= 255 characters
label
string <= 255 characters

The name of the Compensation Plan entered by the user.

nextRevUNs
Array of strings
simulationSet
string or null <= 255 characters
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" … 382 more
approvalRequiredEmailAttachmentsJson
string or null
object or null

Contains some (limited) information about the state of the front-end application. See View State.

gridViewState
string or null
openFolders
Array of strings or null
selectedNodes
Array of strings or null
prevRev
string or null
calculationStatus
integer
supersededBy
string or null
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"
      }
    ],
  • "createdByName": "string",
  • "typedId": "string",
  • "headerText": "string",
  • "successfulCalculationMsg": "SUCCESS",
  • "endDate": "string",
  • "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",
  • "compensationHeaderType": "string",
  • "serverMessagesExtended": [
    • {
      • "key": "string",
      • "message": "string"
      }
    ],
  • "compensationRecordSetLabel": "string",
  • "payoutDate": "string",
  • "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": "string",
      • "endDate": "string",
      • "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,
      • "compensationConditionType": "string",
      • "compensationConditionTypeLabel": "string"
      }
    ],
  • "userGroupViewDetails": "string",
  • "approvedByName": "string",
  • "creationWorkflowCurrentStep": 0,
  • "rootUniqueName": "string",
  • "originUniqueName": "string",
  • "targetDate": "string",
  • "customerGroup": { },
  • "ioMeta": "string",
  • "originDeleted": true,
  • "version": 0,
  • "uniqueName": "string",
  • "serverMessages": [
    • "string"
    ],
  • "creationWorkflowStatus": "DRAFT",
  • "userGroupEdit": "string",
  • "conditionTypeClass": "string",
  • "hasWorkflowHistory": true,
  • "nodeId": 0,
  • "startDate": "string",
  • "status": "DRAFT",
  • "lastUpdateByName": "string",
  • "originClicId": 0,
  • "renderInfo": {
    • "property1": { },
    • "property2": { }
    },
  • "signature": {
    • "envelopeId": "string",
    • "status": "sent",
    • "sentDateTime": 0,
    • "statusChangedDateTime": 0,
    • "customerName": "string",
    • "customerUserOrEmail": "string",
    • "sender": 0,
    • "senderName": "string",
    • "templateName": "string",
    • "note": "string",
    • "voidedReason": "string",
    • "error": "string",
    • "history": [
      • { }
      ]
    },
  • "creationWorkflowStepCount": 0,
  • "sellerGroup": 0,
  • "compensationRecordSetId": 0,
  • "creationWorkflowStepLabel": "string",
  • "formulaElementGroupReadOnly": "string",
  • "submittedByName": "string",
  • "formulaElementGroup": "string",
  • "createDate": "2019-08-24T14:15:22Z",
  • "dirty": true,
  • "additionalInfo4": "string",
  • "additionalInfo3": "string",
  • "refreshInputs": true,
  • "additionalInfo2": 0,
  • "additionalInfo1": 0,
  • "numberOfAttachments": 0,
  • "compensationStatus": "DRAFT",
  • "originLabel": "string",
  • "simulationType": "string",
  • "label": "string",
  • "nextRevUNs": [
    • "string"
    ],
  • "simulationSet": "string",
  • "createdBy": 0,
  • "calculationWithErrorsMsg": "SUCCESS",
  • "approvalRequiredEmailAttachmentsJson": "string",
  • "viewState": {
    • "gridViewState": "string",
    • "openFolders": [
      • "string"
      ],
    • "selectedNodes": [
      • "string"
      ]
    },
  • "prevRev": "string",
  • "calculationStatus": 0,
  • "supersededBy": "string",
  • "lastUpdateBy": 0
}