Fields
-
uniqueName - ID of the agreement, generated by the system.
-
label - Name of the agreement entered by the user.
-
customerGroup - Selection of customers (usually based on the customer hierarchy) for whom the agreement is.
-
startDate - First day of validity of the conditions negotiated on the agreement header & lines.
-
endDate - Last date of validity.
-
payoutDate - Date on which the customer expects to receive the rebate money. If there are more payouts periods during the contract duration, such dates will be specified in another input fields.
-
targetDate - 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 Price Parameters. You can also use it the logic to select correct data which change in time.
-
rebateRecordSetId - ID of the recordset used on this agreement.
-
inputs - Custom header input fields, created by the rebate header logic. It is used by the user to enter values/conditions needed to calculate the results.
-
outputs - Header results calculated for the agreement by the rebate header logic. Usually a summary / overall results for the whole agreement.
-
rebateAgreementStatus - Status of the agreement. Values:
-
DRAFT - Newly created agreement.
-
APPROVED - When the agreement went successfully through the workflow (or when there is none).
-
OPEN - This state is no longer used.
-
CLOSED - This state is no longer used.
-
REVOKED - When the user clicked the Revoke button.
-
SUPERSEDED - When the user created a new version of the agreement.
-
INVALIDATED - Used as indication of the agreement level status on the rebate record level. It is not a status of the agreement itself. A Rebate Record has fields for both the agreement status and the actual record status. When an agreement revision is created, the 'Agreement Status' field on the Rebate Records for that agreement (not the status of the agreement) is set to either:
-
Invalidated – When the agreement was not yet (fully) approved.
-
or Superseded – When that revised agreement was submitted but not yet (fully) approved.
-
-
-
creationWorkflowStatus: see CreationWorkflowStatus
-
creationWorkflowCurrentStep: integer - order of the current active creation step. First step has number 0.
-
creationWorkflowStepCount: integer - total number of all creation steps
-
creationWorkflowStepLabel: String - the label of the current creation workflow step
-
workflowStatus - see WorkflowStatus