Contract (CT)

Since Godfather 8.0 you can find the Contract documents in the user interface under the name Agreements & Promotions, located in the Agreements & Promotions menu.

The Contract (CT) entity represents the header information of the promotion contract document, e.g. customer or customer group, document validity and optional summary results for the whole promotion contract.

Note: The Contract entity does not contain line items. Those are stored in a Contract Line Item (CTLI) entity.

Fields

uniqueName

Autogenerated unique name of the contract document. It has this pattern: "C-####".

label

Description of the contract provided by the user.

contractHeaderTypeUN

(String) Unique Name of the Contract Header Type. (Since version 10.0)

customerGroup : CustomerGroup

Copy of the information provided by the user in the CustomerGroup input field on the header. This copy is done automatically.

productGroup : ProductGroup

Copy of the information provided by the user in the ProductGroup input field on the header. This copy is done automatically.

startDate : Date

First date of validity of the negotiated conditions.

endDate : Date

Last date of validity of the negotiated conditions.

targetDate : Date

Calculation Date of the contract, used as targetDate for the calculation process.

inputs

List of input field definitions and values entered by the user.

Input fields CustomerGroup and ProductGroup are usually added automatically thanks to configuration setting on the partition.

outputs

Results of calculation performed by the contract header logic and stored in the "ROOT" virtual folder.

externalRef

External reference number. ID of a related document (e.g. order) which is located in another system.

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.

contractStatus

Status of the contract document. 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 the 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.

locked

(Boolean) Indicates whether an Agreement/Promotion is locked for editing because it is part of a mass update. Administrator can manually unlock selected Agreement/Promotion on the list page. (Available since version 13.0)