Payment Plan UML


Added On:  03/16/12 
SQL Table:  PAYMENT_PLAN 
Module:  UniBill 
Type:  Entity  Status:  Active 
Java Class:  PaymentPlan 
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.
Added On:  03/16/12
SQL Column:  REF_CODE
Java Field:  refCode
Status:  Active
SQL Type:  varchar(60)
Java Type:  String
Attributes:
See Reference Code definition for additional information.
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.
Added On:  03/16/12
SQL Column:  IMPORT_DATE
Java Field:  importDate
Status:  Active
SQL Type:  datetime
Java Type:  Date
Attributes:
Date when the record was imported.
Added On:  03/16/12
SQL Column:  LAST_INVOICING_DATE
Java Field:  lastInvoicingDate
Status:  Active
SQL Type:  datetime
Java Type:  Date
Attributes:
Date when the last invoice was created.
Added On:  03/16/12
SQL Column:  LAST_PROCESSING_DATE
Java Field:  lastProcessingDate
Status:  Active
SQL Type:  datetime
Java Type:  Date
Attributes:
Date when the last billing processing occured.
Added On:  03/16/12
SQL Column:  REF_CREATOR_CODE
Java Field:  refCreatorCode
Status:  Active
SQL Type:  varchar(60)
Java Type:  String
Attributes:
Account code of the person or organization that created payment plan.
Added On:  03/16/12
SQL Column:  REF_SELLER_CODE
Java Field:  refSellerCode
Status:  Active
SQL Type:  varchar(60)
Java Type:  String
Attributes:
Code of the seller associated with the payment plan.
Added On:  03/16/12
SQL Column:  STATUS
Java Field:  status
Status:  Active
SQL Type:  varchar(1)
Java Type:  String
References Payment Plan Status
Attributes:
Represents current (or selected) status of the payment plan.

Added On:  03/16/12
SQL Column:  PREVIOUS_STATUS
Java Field:  previousStatus
Status:  Active
SQL Type:  varchar(1)
Java Type:  String
References Payment Plan Status
Attributes:
Represents previous status of the payment plan.
Added On:  03/16/12
SQL Column:  FIRST_BILLING_INDEX
Java Field:  firstBillingIndex
Status:  Active
SQL Type:  int(11)
Java Type:  Integer
Attributes:
Index of the frst billing in payment plan.
Added On:  03/16/12
SQL Column:  NEXT_PROCESSING_INDEX
Java Field:  nextProcessingIndex
Status:  Active
SQL Type:  int(11)
Java Type:  Integer
Attributes:
Index of the next billing that will be processed in payment plan.
Added On:  03/16/12
SQL Column:  LAST_PROCESSING_INDEX
Java Field:  lastProcessingIndex
Status:  Active
SQL Type:  int(11)
Java Type:  Integer
Attributes:
Index of the last billing that was processed in payment plan.
Added On:  03/16/12
SQL Column:  LENGTH
Java Field:  length
Status:  Active
SQL Type:  int(11)
Java Type:  Integer
Attributes:
Time period when the payment plan is active.
Added On:  03/16/12
SQL Column:  VALUE
Java Field:  value
Status:  Active
SQL Type:  int(11)
Java Type:  Integer
Attributes:
Total value of the payment plan.
Added On:  03/16/12
SQL Column:  DEFERRED_LENGTH
Java Field:  deferredLength
Status:  Active
SQL Type:  int(11)
Java Type:  Integer
Attributes:
Time period of the billing without invoice creation.
Added On:  03/16/12
SQL Column:  DEFERRED_VALUE
Java Field:  deferredValue
Status:  Active
SQL Type:  int(11)
Java Type:  Integer
Attributes:
Value of the billing without invoice creation.
Added On:  03/16/12
SQL Column:  ORIGINAL_VALUE
Java Field:  originalValue
Status:  Active
SQL Type:  int(11)
Java Type:  Integer
Attributes:
The original meaning of the value before the payment plan was created.
Added On:  03/16/12
SQL Column:  AMOUNT
Java Field:  amount
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.
Added On:  03/16/12
SQL Column:  TAX_AMOUNT
Java Field:  taxAmount
Status:  Active
SQL Type:  int(11)
Java Type:  Integer
Attributes:
Tax charged on the payment plan's amount.
Added On:  03/16/12
SQL Column:  RENEWAL_AMOUNT
Java Field:  renewalAmount
Status:  Active
SQL Type:  int(11)
Java Type:  Integer
Attributes:
Renewal amount on the payment plan.
Added On:  03/16/12
SQL Column:  RENEWAL_TAX_AMOUNT
Java Field:  renewalTaxAmount
Status:  Active
SQL Type:  int(11)
Java Type:  Integer
Attributes:
Tax charged on renewal amount of the payment plan.
Added On:  03/16/12
SQL Column:  REF_GROUP_CODE1
Java Field:  refGroupCode1
Status:  Active
SQL Type:  varchar(60)
Java Type:  String
Attributes:
Code of the optional group that includes any additional information that merchant needs.
Added On:  03/16/12
SQL Column:  REF_GROUP_CODE2
Java Field:  refGroupCode2
Status:  Active
SQL Type:  varchar(60)
Java Type:  String
Attributes:
Code of the optional group that includes any additional information that merchant needs.
Added On:  03/16/12
SQL Column:  REF_GROUP_CODE3
Java Field:  refGroupCode3
Status:  Active
SQL Type:  varchar(60)
Java Type:  String
Attributes:
Code of the optional group that includes any additional information that merchant needs.
Added On:  03/16/12
SQL Column:  REF_GROUP_CODE4
Java Field:  refGroupCode4
Status:  Active
SQL Type:  varchar(60)
Java Type:  String
Attributes:
Code of the optional group that includes any additional information that merchant needs.
Added On:  03/16/12
SQL Column:  REF_GROUP_CODE5
Java Field:  refGroupCode5
Status:  Active
SQL Type:  varchar(60)
Java Type:  String
Attributes:
Code of the optional group that includes any additional information that merchant needs.
Added On:  03/16/12
SQL Column:  REF_GROUP_CODE6
Java Field:  refGroupCode6
Status:  Active
SQL Type:  varchar(60)
Java Type:  String
Attributes:
Code of the optional group that includes any additional information that merchant needs.
Added On:  03/16/12
SQL Column:  REF_GROUP_CODE7
Java Field:  refGroupCode7
Status:  Active
SQL Type:  varchar(60)
Java Type:  String
Attributes:
Code of the optional group that includes any additional information that merchant needs.
Added On:  03/16/12
SQL Column:  REF_GROUP_CODE8
Java Field:  refGroupCode8
Status:  Active
SQL Type:  varchar(60)
Java Type:  String
Attributes:
Code of the optional group that includes any additional information that merchant needs.
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.
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 collector associated with a particular account.
Added On:  03/16/12
SQL Column:  CLAIM_CL
Java Field:  claimCl
Status:  Active
SQL Type:  varchar(2)
Java Type:  String
References Claim Classifier
Attributes:
Represents current (or selected) type of payments claimed for invoices.
Added On:  03/16/12
SQL Column:  PAYMENT_PLAN_CL
Java Field:  paymentPlanCl
Status:  Active
SQL Type:  varchar(1)
Java Type:  String
Attributes:
Enumeration of possible types of payment plans.
Added On:  03/16/12
SQL Column:  FIRST_BILLING_DATE
Java Field:  firstBillingDate
Status:  Active
SQL Type:  datetime
Java Type:  Date
Attributes:
Date when the first billing occured.
Added On:  03/16/12
SQL Column:  LAST_UPDATE_DATE
Java Field:  lastUpdateDate
Status:  Active
SQL Type:  datetime
Java Type:  Date
Attributes:
Date when the payment plan was updated for the last time.
Added On:  03/16/12
SQL Column:  TERMINATOR_CODE
Java Field:  terminatorCode
Status:  Active
SQL Type:  varchar(60)
Java Type:  String
Attributes:
Code of the terminator associated with a particular payment plan.
Added On:  03/16/12
SQL Column:  CANCELLATION_DATE
Java Field:  cancellationDate
Status:  Active
SQL Type:  datetime
Java Type:  Date
Attributes:
Date when the payment plan was cancelled.
Added On:  03/16/12
SQL Column:  FIRST_INVOICE_DATE
Java Field:  firstInvoiceDate
Status:  Active
SQL Type:  datetime
Java Type:  Date
Attributes:
Date when the first invoice was created within the payment plan.
Added On:  03/16/12
SQL Column:  NOTE
Java Field:  note
Status:  Active
SQL Type:  varchar(255)
Java Type:  String
Attributes:
Any additional notes related to the payment plan within the system.
Added On:  03/16/12
SQL Column:  CUSTOM_FIELDS
Java Field:  customFields
Status:  Active
SQL Type:  varchar(1024)
Java Type:  String
Attributes:
Fields created specifically for any optional needs of the customer.
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
Field that shows whether the payment operation is visible externally.
Added On:  03/16/12
SQL Column:  RENEWED_DATE
Java Field:  renewedDate
Status:  Active
SQL Type:  datetime
Java Type:  Date
Attributes:
Renewed date of the payment plan.
Added On:  03/16/12
SQL Column:  LEAD_SOURCE_CODE
Java Field:  leadSourceCode
Status:  Active
SQL Type:  varchar(255)
Java Type:  String
Attributes:
Identifier of the lead code; represents the promotion method associated with a particular customer.
Added On:  03/16/12
SQL Column:  IS_VALUE_CHANGED
Java Field:  isValueChanged
Status:  Active
SQL Type:  tinyint(1)
Java Type:  Boolean
Attributes: Default: false
Field that shows whether the value of the payment operation was changed.
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 code of the customer account to which instance of this object is attributed to.
Added On:  03/16/12
SQL Column:  BILLING_CYCLE_FK
Java Field:  billingCycle
Status:  Active
SQL Type:  bigint(20)
Java Type:  Long
References Billing Cycle
Attributes:
Reference to the entity that represents billing cycle associated with the payment plan.
Added On:  03/16/12
SQL Column:  PARENT_FK
Java Field:  parent
Status:  Active
SQL Type:  bigint(20)
Java Type:  Long
References Payment Plan
Attributes:
Reference to the entity that represents code of the parent payment plan.
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 payment option used to collect money on the payment plan.
Added On:  03/16/12
SQL Column:  ITEM_FK
Java Field:  item
Status:  Active
SQL Type:  bigint(20)
Java Type:  Long
References Item
Attributes:
Reference to the entity that represents payment plan item that is applied as the basis for the billing processing.
Added On:  03/16/12
SQL Column:  TAX_FK
Java Field:  tax
Status:  Active
SQL Type:  bigint(20)
Java Type:  Long
References Tax
Attributes:
Reference to the entity that represents tax amount applied to the payment plan.
Added On:  03/16/12
SQL Column:  TERMINAL_REVENUE_TRANSACTION_FK
Java Field:  terminalRevenueTransaction
Status:  Active
SQL Type:  bigint(20)
Java Type:  Long
References Revenue Transaction
Attributes:
Reference to the entity that represents the last terminal revenue transaction.
Added On:  03/16/12
SQL Column:  LAST_INVOICE_FK
Java Field:  lastInvoice
Status:  Active
SQL Type:  bigint(20)
Java Type:  Long
References Revenue Transaction
Attributes:
Reference to the entity that represents code of the last invoice assigned to the payment plan.
Added On:  03/16/12
SQL Column:  CONTRACT_FK
Java Field:  contract
Status:  Active
SQL Type:  bigint(20)
Java Type:  Long
References Contract
Attributes:
Reference to the entity that represents the beginning date of the contract.
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 person or organization that cancelled the payment plan.
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 person or organization that freezed the payment plan.
Added On:  03/16/12
SQL Column:  LAST_PAYMENT_PLAN_STATISTICS_FK
Java Field:  lastPaymentPlanStatistics
Status:  Active
SQL Type:  bigint(20)
Java Type:  Long
Attributes:
Reference to the entity that represents statistic information about the last assigned payment plan.
Added On:  04/09/12
SQL Column:  IS_WELCOME_LETTER_SENT
Java Field:  isWelcomeLetterSent
Status:  Active
SQL Type:  tinyint(1)
Java Type:  Boolean
Attributes: Default: false
Indicates whether the welcoming letter is sent to customer.
Added On:  01/09/14
SQL Column:  RECURRENCE_COUNT
Java Field:  recurrenceCount
Status:  Active
SQL Type:  int(11)
Java Type:  Integer
Attributes: Default: 1
Counter of the recurring operations within the payment plan.
Added On:  01/09/14
SQL Column:  RECURRENCE_LIMIT
Java Field:  recurrenceLimit
Status:  Active
SQL Type:  int(11)
Java Type:  Integer
Attributes: Default: 1
Limited amount of the recurring operations within the payment plan.
Added On:  01/10/14
SQL Column:  
Java Field:  refId
Status:  Active
SQL Type:  
Java Type:  Long
Attributes: Transient
It is used for the internal purposes during transformations. Not available for clients, isn't saved in database.
Added On:  02/28/14
SQL Column:  PENDING_EXPIRATION_DATE
Java Field:  pendingExpirationDate
Status:  Active
SQL Type:  datetime
Java Type:  Date
Attributes:
Expiration date for pending of the transaction within the payment plan.
Added On:  06/05/14
SQL Column:  COLLECTED_BILLINGS_COUNT
Java Field:  collectedBillingsCount
Status:  Active
SQL Type:  int(11)
Java Type:  Integer
Attributes:
Counter of billings collected within the system.
Added On:  01/06/15
SQL Column:  ITEM_DESCRIPTION
Java Field:  itemDescription
Status:  Active
SQL Type:  varchar(255)
Java Type:  String
Attributes:
Short description of an item.
Added On:  09/21/16
SQL Column:  LINK_ACCOUNT
Java Field:  linkAccount
Status:  Active
SQL Type:  int(11)
Java Type:  Integer
Attributes:
Added On:  09/21/16
SQL Column:  IS_AGAINST_BALANCE
Java Field:  isAgainstBalance
Status:  Active
SQL Type:  tinyint(1)
Java Type:  Boolean
Attributes: Default: false
Added On:  09/21/16
SQL Column:  CHARGES
Java Field:  charges
Status:  Active
SQL Type:  bigint(20)
Java Type:  Long
References Charge
Attributes:
Added On:  01/24/17
SQL Column:  CONTRACT_DOCUMENT_FK
Java Field:  contractDocument
Status:  Active
SQL Type:  bigint(20)
Java Type:  Long
Attributes:
Added On:  01/24/17
SQL Column:  ID_DOCUMENT_FK
Java Field:  idDocument
Status:  Active
SQL Type:  bigint(20)
Java Type:  Long
Attributes:
Added On:  03/29/18
SQL Column:  LAST_SEQUENCE_COUNT
Java Field:  lastSequenceCount
Status:  Active
SQL Type:  int(11)
Java Type:  Integer
Attributes:
Added On:  03/29/18
SQL Column:  LAST_SEQUENCE_NUMBER
Java Field:  lastSequenceNumber
Status:  Active
SQL Type:  int(11)
Java Type:  Integer
Attributes: