Rebate Agreement (RBA)

Fields

uniqueName

ID of the agreement, generated by the system.

label

Name of the agreement entered by the user.

customerGroup

(CustomerGroup) Selection of customers (usually based on the customer hierarchy) for whom the agreement is. This value is selected in the input field of the Rebate Agreement header, and during Save copied to this field, so the value is available also in the list of Rebate Agreements.

productGroup

(ProductGroup) Selection of products (usually based on the product hierarchy) for which the agreement is. This value is selected in the input field of the Rebate Agreement header, and during Save copied to this field, so the value is available also in the list of Rebate Agreements. (Available since version 10.0.)

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 other 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 Company Parameters. You can also use it in 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.

attributeExtension___<fieldName>

Arbitrary number of customizable attributeExtension fields which can be used to store any information you need. The fields with the String type do not have a limited size.

rebateAgreementStatus

Status of the agreement. All valid values are listed in the document status article.

creationWorkflowStatus

See CreationWorkflowStatus.

creationWorkflowCurrentStep

Order of the current active creation step (integer). The first step has number 0.

creationWorkflowStepCount

Total number of all creation steps (integer).

creationWorkflowStepLabel

Label of the current creation workflow step (String).

workflowStatus

See WorkflowStatus.

viewState

Contains some (limited) information about the state of the front-end application. See View State.