Contract UML

Added On: 03/16/12

SQL Table: CONTRACT

Module: UniBill

Type: Entity Status: Active

Java Class: Contract

Available Fields:

Cancellation Adjustment FK
Cancellation Date
Collector Account Code
Contract CL
Create Date
Customer Account FK
Default Payment Plan FK
Document FK
Effective Date

Expiration Date
Freeze Adjustment FK
Freeze Begin Date
Freeze End Date
Id
Import Code
Industry Type
Invoice FK
Is Visible Externally

Length
Level
Merchant Account Code
Name
Ref Creator Code
Ref ID
Ref Seller Code
Reference Code
Status CL

Value

Cancellation Adjustment FK

Added On: 03/16/12

SQL Column: CANCELLATION_ADJUSTMENT_FK

Java Field: cancellationAdjustment

Status: Active

SQL Type: bigint(20)

Java Type: Long

References Adjustment

Attributes:

Reference to the entity that represents information about adjustment cancellation.

Cancellation Date

Added On: 11/22/13

SQL Column: CANCELLATION_DATE

Java Field: cancellationDate

Status: Active

SQL Type: datetime

Java Type: Date

Attributes:

Date when the contract was cancelled.

Collector Account Code

Added On: 03/16/12

SQL Column: COLLECTOR_ACCOUNT_CODE

Java Field: collectorAccountCode

Status: Active

SQL Type: int(11)

Java Type: Integer

Attributes:

Account code of the collector agent assigned for this type of contract.

Contract CL

Added On: 03/16/12

SQL Column: CONTRACT_CL

Java Field: contractCl

Status: Active

SQL Type: varchar(1)

Java Type: String

References Contract Classifier

Attributes:

Reference to the entity that represents available types of contracts.

Create Date

Added On: 03/16/12

SQL Column: CREATE_DATE

Java Field: createDate

Status: Active

SQL Type: datetime

Java Type: Date

Attributes:

Date when the record was created.

Customer Account FK

Added On: 09/21/16

SQL Column: CUSTOMER_ACCOUNT_FK

Java Field: customerAccount

Status: Active

SQL Type: bigint(20)

Java Type: Long

References Customer Account

Attributes:

Reference to the entity that represents customer account information.

Default Payment Plan FK

Added On: 03/16/12

SQL Column: DEFAULT_PAYMENT_PLAN_FK

Java Field: defaultPaymentPlan

Status: Active

SQL Type: bigint(20)

Java Type: Long

References Payment Plan

Attributes:

Reference to the entity that represents default payment plan for the contract.

Document FK

Added On: 03/16/12

SQL Column: DOCUMENT_FK

Java Field: document

Status: Active

SQL Type: bigint(20)

Java Type: Long

References Billing File Store Content

Attributes:

Reference to the entity that represents the associated document information.

Effective Date

Added On: 03/16/12

SQL Column: EFFECTIVE_DATE

Java Field: effectiveDate

Status: Active

SQL Type: datetime

Java Type: Date

Attributes:

Date when the terms of the contract start.

Expiration Date

Added On: 03/16/12

SQL Column: EXPIRATION_DATE

Java Field: expirationDate

Status: Active

SQL Type: datetime

Java Type: Date

Attributes:

Date when the terms of the contract end.

Freeze Adjustment FK

Added On: 03/16/12

SQL Column: FREEZE_ADJUSTMENT_FK

Java Field: freezeAdjustment

Status: Active

SQL Type: bigint(20)

Java Type: Long

References Adjustment

Attributes:

Reference to the entity that represents information about adjustment freeze.

Freeze Begin Date

Added On: 03/16/12

SQL Column: FREEZE_BEGIN_DATE

Java Field: freezeBeginDate

Status: Active

SQL Type: datetime

Java Type: Date

Attributes:

Date when the contract was freezed.

Freeze End Date

Added On: 03/16/12

SQL Column: FREEZE_END_DATE

Java Field: freezeEndDate

Status: Active

SQL Type: datetime

Java Type: Date

Attributes:

Date when the contract became activated again.

Added On: 03/16/12

SQL Column: ID

Java Field: id

Status: Active

SQL Type: bigint(20)

Java Type: Long

Identifier / Primary Key

Attributes: Required

Identifier of the object used for references; auto-incremented integer value.

Import Code

Added On: 03/16/12

SQL Column: IMPORT_CODE

Java Field: importCode

Status: Active

SQL Type: varchar(60)

Java Type: String

Attributes:

Import code of the contract.

Industry Type

Added On: 03/16/12

SQL Column: INDUSTRY_TYPE

Java Field: industryType

Status: Active

SQL Type: varchar(3)

Java Type: String

Attributes:

Type of industry specified in the contract.

Invoice FK

Added On: 03/16/12

SQL Column: INVOICE_FK

Java Field: invoice

Status: Active

SQL Type: bigint(20)

Java Type: Long

References Revenue Transaction

Attributes:

Reference to the entity that represents revenue transaction.

Is Visible Externally

Added On: 03/16/12

SQL Column: IS_VISIBLE_EXTERNALLY

Java Field: isVisibleExternally

Status: Active

SQL Type: tinyint(1)

Java Type: Boolean

Attributes: Default:true

Indicates whether the contract is visible on external resources.

Length

Added On: 03/16/12

SQL Column: LENGTH

Java Field: length

Status: Active

SQL Type: int(11)

Java Type: Integer

Attributes:

Length of the contract.

Level

Added On: 03/16/12

SQL Column: LEVEL

Java Field: level

Status: Active

SQL Type: int(11)

Java Type: Integer

Attributes:

Level of the contract.

Merchant Account Code

Added On: 03/16/12

SQL Column: MERCHANT_ACCOUNT_CODE

Java Field: merchantAccountCode

Status: Active

SQL Type: int(11)

Java Type: Integer

Attributes: Required

Code of Merchant Account to which instance of this object is attributed to. Depending on the context, Merchant Account Code field may contain either Merchant Code or Merchant Account Code.
The field is primarily used for data partitioning and data management, to make it easy to determine the ownership of a record within the database.

Name

Added On: 03/16/12

SQL Column: NAME

Java Field: name

Status: Active

SQL Type: varchar(255)

Java Type: String

Attributes:

Name of the contract.

Ref Creator Code

Added On: 03/16/12

SQL Column: REF_CREATOR_CODE

Java Field: refCreatorCode

Status: Active

SQL Type: varchar(60)

Java Type: String

Attributes:

Secondary identifier of the creator of the record, used to cross-reference records between UniPay and integrated systems.

Ref ID

Added On: 09/21/16

SQL Column:

Java Field: refId

Status: Active

SQL Type:

Java Type: Long

Attributes: Transient

Secondary identifier, which can be used to cross-reference records between UniPay and integrated systems. See Reference Code for additional information.

Ref Seller Code

Added On: 03/16/12

SQL Column: REF_SELLER_CODE

Java Field: refSellerCode

Status: Active

SQL Type: varchar(60)

Java Type: String

Attributes:

Secondary identifier of the seller assigned to the contract, used to cross-reference records between UniPay and integrated systems.

Reference Code

Added On: 03/16/12

SQL Column: REF_CODE

Java Field: refCode

Status: Active

SQL Type: varchar(60)

Java Type: String

Attributes:

Secondary identifier, which can be used to cross-reference records between UniPay and integrated systems.

See Reference Code for additional information.

Status CL

Added On: 03/16/12

SQL Column: STATUS_CL

Java Field: statusCl

Status: Active

SQL Type: varchar(1)

Java Type: String

References Contract Status Classifier

Attributes:

Reference to the entity that represents possible statuses of the contract.

Value

Added On: 03/16/12

SQL Column: VALUE

Java Field: value

Status: Active

SQL Type: int(11)

Java Type: Integer

Attributes: