CompensationLineItem

The type code is COLI

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 objects
overrideAllowEmpty
boolean
labelTranslations
string
overridable
boolean
overridden
boolean
resultDescription
string
typedId
string
calculationBaseJson
string
endDate
string <date-time>
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>
payoutDate
string <date-time>
createDate
string <date-time>
dirty
boolean
object
includedCustomerGroups
Array of objects
includedProductGroups
Array of objects
Array of objects
Array
sellerId
string
sellerName
string
excludedCustomerGroups
Array of objects
excludedproductGroups
Array of objects
excludedSellerReferences
Array of objects
Array of objects
Array
timeUnit
string
Possible values: "DAY" "WEEK" "MONTH" "QUARTER" "YEAR"
startDate
string <date-time>
endDate
string <date-time>
single
boolean
excludedTimePeriods
Array of objects
otherFilters
Array of strings
dateDimFieldName
string
compensationConditionType
string
treeLabel
string
object
label
string
customerFieldName
string
customerFieldLabel
string
customerFieldValue
string
object
property name*
additional property
object
lineId
string <= 255 characters
simulationType
string <= 255 characters
label
string <= 255 characters
clicId
integer
version
integer
parentId
string <= 255 characters
folder
boolean
object
label
string
productFieldName
string
productFieldLabel
string
productFieldValue
string
object
property name*
additional property
object
createdBy
integer
compensationConditionTypeLabel
string
calculationStatus
integer
editabilityStatus
integer
containsProductImage
boolean
startDate
string <date-time>
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": [
        • { }
        ],
      • "overrideAllowEmpty": true,
      • "labelTranslations": "string",
      • "overridable": true,
      • "overridden": true,
      • "resultDescription": "string"
      }
    ],
  • "typedId": "string",
  • "calculationBaseJson": "string",
  • "endDate": "2019-08-24T14:15:22Z",
  • "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",
  • "payoutDate": "2019-08-24T14:15:22Z",
  • "createDate": "2019-08-24T14:15:22Z",
  • "dirty": true,
  • "calculationBase": {
    • "includedCustomerGroups": [
      • { }
      ],
    • "includedProductGroups": [
      • { }
      ],
    • "includedSellerReferences": [
      • {
        • "sellerId": "string",
        • "sellerName": "string"
        }
      ],
    • "excludedCustomerGroups": [
      • { }
      ],
    • "excludedproductGroups": [
      • { }
      ],
    • "excludedSellerReferences": [
      • { }
      ],
    • "includedTimePeriods": [
      • {
        • "timeUnit": "DAY",
        • "startDate": "2019-08-24T14:15:22Z",
        • "endDate": "2019-08-24T14:15:22Z",
        • "single": true
        }
      ],
    • "excludedTimePeriods": [
      • { }
      ],
    • "otherFilters": [
      • "string"
      ],
    • "dateDimFieldName": "string"
    },
  • "compensationConditionType": "string",
  • "treeLabel": "string",
  • "customerGroup": {
    • "label": "string",
    • "customerFieldName": "string",
    • "customerFieldLabel": "string",
    • "customerFieldValue": "string",
    • "customerFilterCriteria": {
      • "property1": { },
      • "property2": { }
      }
    },
  • "lineId": "string",
  • "simulationType": "string",
  • "label": "string",
  • "clicId": 0,
  • "version": 0,
  • "parentId": "string",
  • "folder": true,
  • "productGroup": {
    • "label": "string",
    • "productFieldName": "string",
    • "productFieldLabel": "string",
    • "productFieldValue": "string",
    • "productFilterCriteria": {
      • "property1": { },
      • "property2": { }
      }
    },
  • "createdBy": 0,
  • "compensationConditionTypeLabel": "string",
  • "calculationStatus": 0,
  • "editabilityStatus": 0,
  • "containsProductImage": true,
  • "startDate": "2019-08-24T14:15:22Z",
  • "lastUpdateBy": 0
}