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 Name | Label | Data Type | Description/Meaning |
|---|---|---|---|
| customerGroup | Customer(s) | CustomerGroup | |
| productGroup | Product(s) | ProductGroup | |
| startDate | Start Date | Date | |
| endDate | End Date | Date | |
| targetDate | Calculation Date | Date | |
| contractStatus | Status | ContractStatus | DRAFT |
| externalRef | External Reference | String | |
| createDate | Created | Date | |
| uniqueName | ID | String | |
| rootUniqueName | Name w/o revision | String | |
| label | Description | String | |
| headerText | Header text | String | |
| supersededByUN | Superseded/Invalidated by | String | |
| workflowStatus | Workflow Status | WorkflowStatus | DRAFT |
| submittedByName | Workflow Submitter | String | |
| approvedByName | |||
| lastUpdateDate | Last Update | ||
| lastUpdateByName | Last Updated By | String | |
| createdByName | Created By | String | |
| Attachements | |||
| userGroupEdit | User Group (Edit) | String | |
| userGroupViewDetails | User Group (View Details) | String | |
| additionalInfo1 | Extra Info 1 (Number) | BigDecimal | |
| additionalInfo2 | Extra Info 2 (Number) | BigDecimal | |
| additionalInfo3 | Extra Info 3 (Text) | String | |
| additionalInfo4 | Extra 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 name | Label | Data Type | Description |
|---|---|---|---|
| contractTermType | Contract Term Type | String | Data type of this line, i.e. the name of the Contract Term Type which this line is based on. |
| startDate | Date | First day of validity of this contract conditions. Could be different from Header. | |
| endDate | Date | Last day of validity of this contract conditions. Could be different from Header. | |
| customerGroup | CustomerGroup | Customers for whom these conditions are valid. If not specified, it is valid for all. | |
| productGroup | ProductGroup | Products 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.