Data Structures

Promotion Contract consists of:

  • Contract itself – So called "header" information.
  • Lines (and folders) – Those represent the negotiated contract conditions. Every line is of a certain type (of Contract Term Type).

Relations between Contract, Lines and Term Types

Header Fields

Colors used in this table: yellow = fields specific for Promotion Contract; white = fields can also be found in headers of other objects.

Field NameLabelData TypeDescription/Meaning
customerGroupCustomer(s)CustomerGroup
productGroupProduct(s)ProductGroup
startDateStart DateDate
endDateEnd DateDate
targetDateCalculation DateDate
contractStatusStatusContractStatus

DRAFT
APPROVED
REVOKED
SUPERSEDED
INVALIDATED

externalRefExternal ReferenceString
createDateCreatedDate
uniqueNameIDString
rootUniqueNameName w/o revisionString
labelDescriptionString
headerTextHeader textString
supersededByUNSuperseded/Invalidated byString
workflowStatusWorkflow StatusWorkflowStatus

DRAFT
SUBMITTED
DENIED
APPROVED
NO_APPROVAL_REQUIRED
WITHDRAWN
INVALIDATED

submittedByNameWorkflow SubmitterString
approvedByName


lastUpdateDateLast Update

lastUpdateByNameLast Updated ByString
createdByNameCreated ByString

Attachements

userGroupEditUser Group (Edit)String
userGroupViewDetailsUser Group (View Details)String
additionalInfo1Extra Info 1 (Number)BigDecimal
additionalInfo2Extra Info 2 (Number)BigDecimal
additionalInfo3Extra Info 3 (Text)String
additionalInfo4Extra Info 4 (Text)String

Line

The line represents either the line itself or a folder. But when the contract calculation logic runs, it is executed only for lines (not for folders).

Colors used in this table: yellow = fields specific for Promotion Contract Line; white = fields can also be found in lines of other objects.

Field nameLabelData TypeDescription
contractTermTypeContract Term TypeStringData type of this line, i.e. the name of the Contract Term Type which this line is based on.
startDate
DateFirst day of validity of this contract conditions. Could be different from Header.
endDate
DateLast day of validity of this contract conditions. Could be different from Header.
customerGroup
CustomerGroupCustomers for whom these conditions are valid. If not specified, it is valid for all.
productGroup
ProductGroupProducts for whom these conditions are valid. If not specified, it is valid for all.
lineId
String
parentId
String
calculationStatus
int
editabilityStatus
int
label
String
createDate


folder
Boolean
typedId
String

Found an issue in documentation? Write to us.