DealPlan

The type code is DP

Array of objects
Array
resultName
string
resultLabel
string
result
string
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 strings or null
overrideAllowEmpty
boolean
labelTranslations
string
overridable
boolean
overridden
boolean
resultDescription
string
lastUpdateByName
string <= 255 characters
createdByName
string <= 255 characters
dealPlanType
string <= 255 characters
typedId
string
assignedToName
string <= 255 characters
Array of objects
Array
name
string
label
string
lookupTableId
string
url
string
type
string
value
string
valueHint
string
readOnly
boolean
object
property name*
additional property
string
parameterGroup
string
required
boolean
labelTranslations
string
addUnknownValues
boolean
typedId
string
alwaysEditable
boolean
inputs
Array of objects
object
property name*
additional property
string
object
property name*
additional property
string
valueOptions
Array of strings
workflowStatus
string <= 255 characters
Possible values: "DRAFT" "SUBMITTED" "DENIED" "APPROVED" "NO_APPROVAL_REQUIRED" "WITHDRAWN" "INVALIDATED"
lastUpdateDate
string <date-time>
submitDate
string <date-time>
planStatus
string <= 255 characters
Possible values: "DRAFT" "OFFER" "DEAL" "REVOKED" "LOST"
externalRef
string <= 255 characters
assignedTo
integer
deniedByName
string <= 255 characters
customerId
string <= 255 characters
submittedByName
string <= 255 characters
userGroupViewDetails
string <= 255 characters
approvedByName
string <= 255 characters
id
integer
openingDate
string <date-time>
createDate
string <date-time>
object
version
integer
typedId
string
uniqueName
string
label
string
headerFormulaName
string
workflowFormulaName
string
userGroupEdit
string
userGroupViewDetails
string
configuration
string
createDate
string
createdBy
integer
lastUpdateDate
string
lastUpdateBy
integer
comments
string
approvalRequiredEmailAttachments
Array of strings or null
targetDate
string <date-time>
label
string <= 255 characters
version
integer
customerName
string <= 255 characters
uniqueName
string <= 255 characters
createdBy
integer
calculationStatus
integer
userGroupEdit
string <= 255 characters
object
additional property
object
lineId
string
title
string
ourMessage
string
theirMessage
string
finalAgreement
string
ourImpact
string
theirImpact
string
ourAnchor
string
theirAnchor
string
ourMDO
string
theirMDO
string
ourLAA
string
theirLAA
string
status
string
Possible values: "TEMPORARY" "NOT_STARTED" "IN_PROGRESS" "AGREED_ON"
negotiationDate
string <date-time>
roundId
string
effectiveDate
string <date-time>
lastUpdateBy
integer
{
  • "outputs": [
    • {
      • "resultName": "string",
      • "resultLabel": "string",
      • "result": "string",
      • "excludeFromExport": true,
      • "warnings": [
        • "string"
        ],
      • "alertMessage": "string",
      • "alertType": "CRITICAL",
      • "displayOptions": 0,
      • "formatType": "NUMERIC",
      • "suffix": "string",
      • "resultType": "string",
      • "cssProperties": "string",
      • "userGroup": "string",
      • "resultGroup": "string",
      • "overrideValueOptions": [
        • "string"
        ],
      • "overrideAllowEmpty": true,
      • "labelTranslations": "string",
      • "overridable": true,
      • "overridden": true,
      • "resultDescription": "string"
      }
    ],
  • "lastUpdateByName": "string",
  • "createdByName": "string",
  • "dealPlanType": "string",
  • "typedId": "string",
  • "assignedToName": "string",
  • "inputs": [
    • {
      • "name": "string",
      • "label": "string",
      • "lookupTableId": "string",
      • "url": "string",
      • "type": "string",
      • "value": "string",
      • "valueHint": "string",
      • "readOnly": true,
      • "filter": {
        • "property1": "string",
        • "property2": "string"
        },
      • "parameterGroup": "string",
      • "required": true,
      • "labelTranslations": "string",
      • "addUnknownValues": true,
      • "typedId": "string",
      • "alwaysEditable": true,
      • "inputs": [
        • { }
        ],
      • "parameterConfig": {
        • "property1": "string",
        • "property2": "string"
        },
      • "formattingOptions": {
        • "property1": "string",
        • "property2": "string"
        },
      • "valueOptions": [
        • "string"
        ]
      }
    ],
  • "workflowStatus": "DRAFT",
  • "lastUpdateDate": "2019-08-24T14:15:22Z",
  • "submitDate": "2019-08-24T14:15:22Z",
  • "planStatus": "DRAFT",
  • "externalRef": "string",
  • "assignedTo": 0,
  • "deniedByName": "string",
  • "customerId": "string",
  • "submittedByName": "string",
  • "userGroupViewDetails": "string",
  • "approvedByName": "string",
  • "id": 0,
  • "openingDate": "2019-08-24T14:15:22Z",
  • "createDate": "2019-08-24T14:15:22Z",
  • "dealPlanTypeObject": {
    • "version": 0,
    • "typedId": "string",
    • "uniqueName": "string",
    • "label": "string",
    • "headerFormulaName": "string",
    • "workflowFormulaName": "string",
    • "userGroupEdit": "string",
    • "userGroupViewDetails": "string",
    • "configuration": "string",
    • "createDate": "string",
    • "createdBy": 0,
    • "lastUpdateDate": "string",
    • "lastUpdateBy": 0
    },
  • "comments": "string",
  • "approvalRequiredEmailAttachments": [
    • "string"
    ],
  • "targetDate": "2019-08-24T14:15:22Z",
  • "label": "string",
  • "version": 0,
  • "customerName": "string",
  • "uniqueName": "string",
  • "createdBy": 0,
  • "calculationStatus": 0,
  • "userGroupEdit": "string",
  • "drivers": {
    • "property1": {
      • "lineId": "string",
      • "title": "string",
      • "ourMessage": "string",
      • "theirMessage": "string",
      • "finalAgreement": "string",
      • "ourImpact": "string",
      • "theirImpact": "string",
      • "ourAnchor": "string",
      • "theirAnchor": "string",
      • "ourMDO": "string",
      • "theirMDO": "string",
      • "ourLAA": "string",
      • "theirLAA": "string",
      • "status": "TEMPORARY",
      • "negotiationDate": "2019-08-24T14:15:22Z",
      • "roundId": "string"
      },
    • "property2": {
      • "lineId": "string",
      • "title": "string",
      • "ourMessage": "string",
      • "theirMessage": "string",
      • "finalAgreement": "string",
      • "ourImpact": "string",
      • "theirImpact": "string",
      • "ourAnchor": "string",
      • "theirAnchor": "string",
      • "ourMDO": "string",
      • "theirMDO": "string",
      • "ourLAA": "string",
      • "theirLAA": "string",
      • "status": "TEMPORARY",
      • "negotiationDate": "2019-08-24T14:15:22Z",
      • "roundId": "string"
      }
    },
  • "effectiveDate": "2019-08-24T14:15:22Z",
  • "lastUpdateBy": 0
}