Email UML

Added On: 02/13/12

SQL Table: EMAIL

Module: UniCharge

Type: Entity Status: Hidden

Java Class: Email

Available Fields:

Attachment Code
Attachment Content Source CL
Balance Phase1
Balance Phase2
Balance Phase3
Balance Phase4
BCC Email
Billing City
Billing Country Code
Billing State
Billing Street 1
Billing Street 2
Billing ZIP Code
CC Email
Create Date
Customer Account Balance
Customer Account Code
Customer Account Notes
External Reference Code
File Extention

First Billing Date
First Name
From Email
Id
Is Plain Message
Last Name
Late Fee Amount
Merchant Account Code
Merchant Account Name
Merchant Name
Message
Next Billing Date
Note
Payment Option Holder Name
Payment Option Number
Payment Option Type
Payment Plan Amount
Payment Plan Code
Payment Plan Item Description
Response

Response Code
Retail Transaction Cycle FK
Return Fee Amount
Return Reason
Shipping City
Shipping Country Code
Shipping State
Shipping Street 1
Shipping Street 2
Shipping ZIP Code
Subject
Template Code
Terminal Order FK
To Email
Transaction Amount
Transaction Balance
Transaction Code
Transaction Date
Transaction Due Date
Transaction Type

Attachment Code

Added On: 02/13/12

SQL Column: ATTACHMENT_CODE

Java Field: attachmentCode

Status: Active

SQL Type: bigint(20)

Java Type: Long

Attributes:

Code of the attachment for the email in the system.

Attachment Content Source CL

Added On: 03/06/12

SQL Column: ATTACHMENT_CONTENT_SOURCE_CL

Java Field: attachmentContentSourceCl

Status: Active

SQL Type: varchar(1)

Java Type: String

References Attachment Content Source Classifier

Attributes:

Entity of attachment codes for the message.

Balance Phase1

Added On: 02/13/12

SQL Column: BALANCE_PHASE1

Java Field: balancePhase1

Status: Active

SQL Type: int(11)

Java Type: Integer

Attributes:

Balance state by the end of the period (phase).

Balance Phase2

Added On: 02/13/12

SQL Column: BALANCE_PHASE2

Java Field: balancePhase2

Status: Active

SQL Type: int(11)

Java Type: Integer

Attributes:

Balance state by the end of the period (phase).

Balance Phase3

Added On: 02/13/12

SQL Column: BALANCE_PHASE3

Java Field: balancePhase3

Status: Active

SQL Type: int(11)

Java Type: Integer

Attributes:

Balance state by the end of the period (phase).

Balance Phase4

Added On: 02/13/12

SQL Column: BALANCE_PHASE4

Java Field: balancePhase4

Status: Active

SQL Type: int(11)

Java Type: Integer

Attributes:

Balance state by the end of the period (phase).

BCC Email

Added On: 12/21/15

SQL Column: BCC_EMAIL

Java Field: bccEmail

Status: Active

SQL Type: varchar(255)

Java Type: String

Attributes:

Billing City

Added On: 03/22/15

SQL Column: BILLING_CITY

Java Field: billingCity

Status: Active

SQL Type: varchar(50)

Java Type: String

Attributes:

The city of the billing address of the merchant.

Billing Country Code

Added On: 03/22/15

SQL Column: BILLING_COUNTRY_CODE

Java Field: billingCountryCode

Status: Active

SQL Type: varchar(2)

Java Type: String

Attributes:

The country code of the billing address of the merchant.

Billing State

Added On: 03/22/15

SQL Column: BILLING_STATE

Java Field: billingState

Status: Active

SQL Type: varchar(3)

Java Type: String

Attributes:

The state code of the billing address of the merchant.

Billing Street 1

Added On: 03/22/15

SQL Column: BILLING_STREET1

Java Field: billingStreet1

Status: Active

SQL Type: varchar(128)

Java Type: String

Attributes:

The street of the billing address of the merchant.

Billing Street 2

Added On: 03/22/15

SQL Column: BILLING_STREET2

Java Field: billingStreet2

Status: Active

SQL Type: varchar(128)

Java Type: String

Attributes:

The street of the billing address of the merchant.

Billing ZIP Code

Added On: 03/22/15

SQL Column: BILLING_ZIP_CODE

Java Field: billingZipCode

Status: Active

SQL Type: varchar(10)

Java Type: String

Attributes:

The ZIP/postal code of the billing address of the merchant.

CC Email

Added On: 09/26/13

SQL Column: CC_EMAIL

Java Field: ccEmail

Status: Active

SQL Type: varchar(255)

Java Type: String

Attributes:

Create Date

Added On: 02/13/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 Balance

Added On: 02/13/12

SQL Column: CUSTOMER_ACCOUNT_BALANCE

Java Field: customerAccountBalance

Status: Active

SQL Type: int(11)

Java Type: Integer

Attributes:

Available balance of the customer account.

Customer Account Code

Added On: 02/13/12

SQL Column: CUSTOMER_ACCOUNT_CODE

Java Field: customerAccountCode

Status: Active

SQL Type: varchar(60)

Java Type: String

Attributes:

Value, identifying customer in submitter’s system.

Customer Account Notes

Added On: 03/22/15

SQL Column: CUSTOMER_ACCOUNT_NOTES

Java Field: customerAccountNotes

Status: Active

SQL Type: varchar(255)

Java Type: String

Attributes:

Any additional notes or information about the customer's account.

External Reference Code

Added On: 02/13/12

SQL Column: EXTERNAL_REFERENCE_CODE

Java Field: externalReferenceCode

Status: Active

SQL Type: bigint(20)

Java Type: Long

Attributes:

File Extention

Added On: 02/13/12

SQL Column: FILE_EXTENTION

Java Field: fileExtention

Status: Active

SQL Type: varchar(5)

Java Type: String

Attributes:

The extension of the uploaded or attached to the email file (e.g: .txt, .doc, .xlsx etc).

First Billing Date

Added On: 02/13/12

SQL Column: FIRST_BILLING_DATE

Java Field: firstBillingDate

Status: Active

SQL Type: datetime

Java Type: Date

Attributes:

The date when the first billing was made.

First Name

Added On: 02/13/12

SQL Column: FIRST_NAME

Java Field: firstName

Status: Active

SQL Type: varchar(50)

Java Type: String

Attributes:

The first name of the user.

From Email

Added On: 03/22/15

SQL Column: FROM_EMAIL

Java Field: fromEmail

Status: Active

SQL Type: varchar(255)

Java Type: String

Attributes:

The sender of the email.

Added On: 02/13/12

SQL Column: ID

Java Field: id

Status: Active

SQL Type: bigint(20)

Java Type: Long

Identifier / Primary Key

Attributes: Unique, Required, CreateOnly

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

Is Plain Message

Added On: 10/10/13

SQL Column: IS_PLAIN_MESSAGE

Java Field: isPlainMessage

Status: Active

SQL Type: tinyint(1)

Java Type: Boolean

Attributes: Default:false

Indicates whether the message includes plain text.

Last Name

Added On: 02/13/12

SQL Column: LAST_NAME

Java Field: lastName

Status: Active

SQL Type: varchar(100)

Java Type: String

Attributes:

The last name of the user.

Late Fee Amount

Added On: 02/13/12

SQL Column: LATE_FEE_AMOUNT

Java Field: lateFeeAmount

Status: Active

SQL Type: int(11)

Java Type: Integer

Attributes:

Amount of the late fee.

Merchant Account Code

Added On: 02/13/12

SQL Column: MERCHANT_ACCOUNT_CODE

Java Field: merchantAccountCode

Status: Active

SQL Type: int(11)

Java Type: Integer

Attributes: Required, CreateOnly

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.

Merchant Account Name

Added On: 02/13/12

SQL Column: MERCHANT_ACCOUNT_NAME

Java Field: merchantAccountName

Status: Active

SQL Type: varchar(100)

Java Type: String

Attributes:

Name assosiated with this merchant account.

Merchant Name

Added On: 02/13/12

SQL Column: MERCHANT_NAME

Java Field: merchantName

Status: Active

SQL Type: varchar(100)

Java Type: String

Attributes:

Name assosiated with this merchant.

Message

Added On: 02/13/12

SQL Column: MESSAGE

Java Field: message

Status: Active

SQL Type: varchar(8192)

Java Type: String

Attributes:

Text message included in the email.

Next Billing Date

Added On: 02/13/12

SQL Column: NEXT_BILLING_DATE

Java Field: nextBillingDate

Status: Active

SQL Type: datetime

Java Type: Date

Attributes:

The date of the next billing.

Note

Added On: 02/13/12

SQL Column: NOTE

Java Field: note

Status: Active

SQL Type: varchar(255)

Java Type: String

Attributes:

Any additional information for the merchant.

Payment Option Holder Name

Added On: 02/13/12

SQL Column: PAYMENT_OPTION_HOLDER_NAME

Java Field: paymentOptionHolderName

Status: Active

SQL Type: varchar(160)

Java Type: String

Attributes:

Name of the bank account or credit card holder.

Payment Option Number

Added On: 02/13/12

SQL Column: PAYMENT_OPTION_NUMBER

Java Field: paymentOptionNumber

Status: Active

SQL Type: varchar(25)

Java Type: String

Attributes:

Number of a payment card or bank account.

Payment Option Type

Added On: 02/13/12

SQL Column: PAYMENT_OPTION_TYPE

Java Field: paymentOptionType

Status: Active

SQL Type: varchar(50)

Java Type: String

Attributes:

Selected payment option type.

Payment Plan Amount

Added On: 02/13/12

SQL Column: PAYMENT_PLAN_AMOUNT

Java Field: paymentPlanAmount

Status: Active

SQL Type: int(11)

Java Type: Integer

Attributes:

The amount of money charged every time billing occurs for this payment plan (e.g. amount of the transaction). Value must be submitted in cents without a decimal point.

Payment Plan Code

Added On: 02/13/12

SQL Column: PAYMENT_PLAN_CODE

Java Field: paymentPlanCode

Status: Active

SQL Type: varchar(60)

Java Type: String

Attributes:

Code of the payment plan within the system.

Payment Plan Item Description

Added On: 03/22/15

SQL Column: PAYMENT_PLAN_ITEM_DESCRIPTION

Java Field: paymentPlanItemDescription

Status: Active

SQL Type: varchar(255)

Java Type: String

Attributes:

Short description of a payment plan item.

Response

Added On: 02/13/12

SQL Column: RESPONSE

Java Field: response

Status: Active

SQL Type: varchar(255)

Java Type: String

Attributes:

Response Code

Added On: 02/13/12

SQL Column: RESPONSE_CODE

Java Field: responseCode

Status: Active

SQL Type: varchar binary(255)

Java Type: String

Attributes:

Gateway generated response code.

Retail Transaction Cycle FK

Added On: 02/13/12

SQL Column: RETAIL_TRANSACTION_CYCLE_FK

Java Field: retailTransactionCycle

Status: Active

SQL Type: bigint(20)

Java Type: Long

References Retail Transaction Cycle

Attributes:

Reference to the entity that represents a group of real-time transactions which must be settled together.

Return Fee Amount

Added On: 02/13/12

SQL Column: RETURN_FEE_AMOUNT

Java Field: returnFeeAmount

Status: Active

SQL Type: int(11)

Java Type: Integer

Attributes:

Amount of the return fee.

Return Reason

Added On: 02/13/12

SQL Column: RETURN_REASON

Java Field: returnReason

Status: Active

SQL Type: varchar(255)

Java Type: String

Attributes:

This field will contain the description of the return based on the value Return Reason Code.

Shipping City

Added On: 03/22/15

SQL Column: SHIPPING_CITY

Java Field: shippingCity

Status: Active

SQL Type: varchar(50)

Java Type: String

Attributes:

The city of the shipping address of the merchant.

Shipping Country Code

Added On: 03/22/15

SQL Column: SHIPPING_COUNTRY_CODE

Java Field: shippingCountryCode

Status: Active

SQL Type: varchar(2)

Java Type: String

Attributes:

The country code of the shipping address of the merchant.

Shipping State

Added On: 03/22/15

SQL Column: SHIPPING_STATE

Java Field: shippingState

Status: Active

SQL Type: varchar(3)

Java Type: String

Attributes:

The state code of the shipping address of the merchant.

Shipping Street 1

Added On: 03/22/15

SQL Column: SHIPPING_STREET1

Java Field: shippingStreet1

Status: Active

SQL Type: varchar(128)

Java Type: String

Attributes:

The street of the shipping address of the merchant.

Shipping Street 2

Added On: 03/22/15

SQL Column: SHIPPING_STREET2

Java Field: shippingStreet2

Status: Active

SQL Type: varchar(128)

Java Type: String

Attributes:

The street of the shipping address of the merchant.

Shipping ZIP Code

Added On: 03/22/15

SQL Column: SHIPPING_ZIP_CODE

Java Field: shippingZipCode

Status: Active

SQL Type: varchar(10)

Java Type: String

Attributes:

The ZIP/postal code of the shipping address of the merchant.

Subject

Added On: 02/13/12

SQL Column: SUBJECT

Java Field: subject

Status: Active

SQL Type: varchar(100)

Java Type: String

Attributes:

Subject line of the email.

Template Code

Added On: 02/13/12

SQL Column: TEMPLATE_CODE

Java Field: templateCode

Status: Active

SQL Type: varchar(255)

Java Type: String

Attributes:

Internal code of the used email template.

Terminal Order FK

Added On: 08/27/15

SQL Column: TERMINAL_ORDER_FK

Java Field: terminalOrder

Status: Active

SQL Type: bigint(20)

Java Type: Long

References Terminal Order

Attributes:

Reference to the entity that represents terminal order information.

To Email

Added On: 02/13/12

SQL Column: TO_EMAIL

Java Field: toEmail

Status: Active

SQL Type: varchar(255)

Java Type: String

Attributes:

Email address where email is sent.

Transaction Amount

Added On: 02/13/12

SQL Column: TRANSACTION_AMOUNT

Java Field: transactionAmount

Status: Active

SQL Type: int(11)

Java Type: Integer

Attributes:

Total amount of the transaction including discount and tax.

Transaction Balance

Added On: 02/13/12

SQL Column: TRANSACTION_BALANCE

Java Field: transactionBalance

Status: Active

SQL Type: int(11)

Java Type: Integer

Attributes:

Balance of the transaction.

Transaction Code

Added On: 02/13/12

SQL Column: TRANSACTION_CODE

Java Field: transactionCode

Status: Active

SQL Type: varchar(60)

Java Type: String

Attributes:

Value identifying this transaction in submitter’s system.

Transaction Date

Added On: 02/13/12

SQL Column: TRANSACTION_DATE

Java Field: transactionDate

Status: Active

SQL Type: datetime

Java Type: Date

Attributes:

Date of the actual transaction.

Transaction Due Date

Added On: 02/13/12

SQL Column: TRANSACTION_DUE_DATE

Java Field: transactionDueDate

Status: Active

SQL Type: datetime

Java Type: Date

Attributes:

Time within which payment for the transaction must be made.

Transaction Type

Added On: 03/22/15

SQL Column: TRANSACTION_TYPE

Java Field: transactionType

Status: Active

SQL Type: varchar(50)

Java Type: String

Attributes:

Type of the transaction.