Letter UML

Added On: 03/16/12

SQL Table: LETTER

Module: UniBill

Type: Entity Status: Active

Java Class: Letter

Available Fields:

Account Transaction FK
Address FK
City
Collector Account Code
Create Date
Creator Code
Custom Field1
Custom Field2
Custom Field3
Custom Field4

Custom Field5
Customer Account FK
Due Date
Email
Id
Is Statement
Is Visible Externally
Letter Code FK
Letter Document FK
Merchant Account Code

Name
Payment Option FK
Payment Plan FK
Processed Date
Ref ID
Reference Code
State
Status CL
Street1
Street2

Template Code
ZIP Code

Account Transaction FK

Added On: 03/16/12

SQL Column: ACCOUNT_TRANSACTION_FK

Java Field: accountTransaction

Status: Active

SQL Type: bigint(20)

Java Type: Long

References Account Transaction

Attributes:

Reference to the entity that represents an account transaction.

Address FK

Added On: 10/02/12

SQL Column: ADDRESS_FK

Java Field: address

Status: Active

SQL Type: bigint(20)

Java Type: Long

References Address

Attributes:

Reference to the entity that represents customer's mailing address.

City

Added On: 03/16/12

SQL Column: CITY

Java Field: city

Status: Active

SQL Type: varchar(50)

Java Type: String

Attributes:

City of the mailing address.

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:

Code of the associated collector's agent account.

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.

Creator Code

Added On: 03/16/12

SQL Column: CREATOR_CODE

Java Field: creatorCode

Status: Active

SQL Type: varchar(60)

Java Type: String

Attributes:

User who created the letter.

Custom Field1

Added On: 03/16/12

SQL Column: CUSTOM_FIELD1

Java Field: customField1

Status: Active

SQL Type: varchar(100)

Java Type: String

Attributes:

Field used for any additional information.

Custom Field2

Added On: 03/16/12

SQL Column: CUSTOM_FIELD2

Java Field: customField2

Status: Active

SQL Type: varchar(100)

Java Type: String

Attributes:

Field used for any additional information.

Custom Field3

Added On: 03/16/12

SQL Column: CUSTOM_FIELD3

Java Field: customField3

Status: Active

SQL Type: varchar(100)

Java Type: String

Attributes:

Field used for any additional information.

Custom Field4

Added On: 03/16/12

SQL Column: CUSTOM_FIELD4

Java Field: customField4

Status: Active

SQL Type: varchar(100)

Java Type: String

Attributes:

Field used for any additional information.

Custom Field5

Added On: 03/16/12

SQL Column: CUSTOM_FIELD5

Java Field: customField5

Status: Active

SQL Type: varchar(100)

Java Type: String

Attributes:

Field used for any additional information.

Customer Account FK

Added On: 03/16/12

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 a customer’s account.

Due Date

Added On: 03/16/12

SQL Column: DUE_DATE

Java Field: dueDate

Status: Active

SQL Type: datetime

Java Type: Date

Attributes:

Due date of the letter.

Added On: 03/16/12

SQL Column: EMAIL

Java Field: email

Status: Active

SQL Type: varchar(100)

Java Type: String

Attributes:

Email address assciated with the customer account.

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.

Is Statement

Added On: 03/16/12

SQL Column: IS_STATEMENT

Java Field: isStatement

Status: Active

SQL Type: tinyint(1)

Java Type: Boolean

Attributes: Default:false

Indicates whether the letter type is statement.

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 email is visible on external resources.

Letter Code FK

Added On: 03/16/12

SQL Column: LETTER_CODE_FK

Java Field: letterCode

Status: Active

SQL Type: bigint(20)

Java Type: Long

References Letter Code

Attributes:

Reference to the entity that represents letter code information within the system.

Letter Document FK

Added On: 03/16/12

SQL Column: LETTER_DOCUMENT_FK

Java Field: letterDocument

Status: Active

SQL Type: bigint(20)

Java Type: Long

References Billing File Store Content

Attributes:

Reference to the entity that represents file store where the letter document is stored.

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(100)

Java Type: String

Attributes:

Name of the letter.

Payment Option FK

Added On: 03/16/12

SQL Column: PAYMENT_OPTION_FK

Java Field: paymentOption

Status: Active

SQL Type: bigint(20)

Java Type: Long

References Payment Option

Attributes:

Reference to the entity that represents a payment option for the customer account.

Payment Plan FK

Added On: 03/16/12

SQL Column: PAYMENT_PLAN_FK

Java Field: paymentPlan

Status: Active

SQL Type: bigint(20)

Java Type: Long

References Payment Plan

Attributes:

Reference to the entity that represents a payment plan.

Processed Date

Added On: 03/16/12

SQL Column: PROCESSED_DATE

Java Field: processedDate

Status: Active

SQL Type: datetime

Java Type: Date

Attributes:

Date when the letter was processed.

Ref ID

Added On: 09/21/16

SQL Column:

Java Field: refId

Status: Active

SQL Type:

Java Type: Long

Attributes: Transient

Secondary identifier that can be 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.

State

Added On: 03/16/12

SQL Column: STATE

Java Field: state

Status: Active

SQL Type: varchar(3)

Java Type: String

Attributes:

State of the mailing address.

Status CL

Added On: 03/16/12

SQL Column: STATUS_CL

Java Field: statusCl

Status: Active

SQL Type: varchar(1)

Java Type: String

References Letter Status Classifier

Attributes:

Reference to the entity that represents enumeration of possible letter statuses.

Street1

Added On: 03/16/12

SQL Column: STREET1

Java Field: street1

Status: Active

SQL Type: varchar(128)

Java Type: String

Attributes:

Street (line 1) of the mailing address.

Street2

Added On: 03/16/12

SQL Column: STREET2

Java Field: street2

Status: Active

SQL Type: varchar(128)

Java Type: String

Attributes:

Street (line 2) of the mailing address.

Template Code

Added On: 03/16/12

SQL Column: TEMPLATE_CODE

Java Field: templateCode

Status: Active

SQL Type: varchar(50)

Java Type: String

Attributes:

Template that is used for the letter.

ZIP Code

Added On: 03/16/12

SQL Column: ZIP_CODE

Java Field: zipCode

Status: Active

SQL Type: varchar(10)

Java Type: String

Attributes:

ZIP or postal code of the mailing address.