Retail Transaction Cycle                                                    UML
                                
         
     
    
    
    
    
        
            Added On:  02/13/12 
        
        
        
            Module:  UniCharge 
        
     
    
        
            Type:  Entity 
            Status:  Active 
        
        
                            Java Class:  RetailTransactionCycle 
                    
        
        
     
    
        
            
                
                    Represents a group of real-time transactions that must be settled together.
The settlements process occurs when a cycle is closed. At this time, all non-captured transactions are voided, all voids (when applicable) are processed as authorization reversals and all authorizations and credits are settled with a 
Provider.                
 
             
         
     
        
        
                    
                        
                Added On:  03/30/16
                SQL Column:  BILLING_PROFILE_CODE1
                Java Field:  billingProfileCode1
             
            
                Status:  Active
                SQL Type:  bigint(20)
                Java Type:  Long
             
            
            
            
                
                    
                        
                        Number (code) of the profile of corresponding external code.
                        
                     
                 
             
                    
                        
                Added On:  03/30/16
                SQL Column:  BILLING_PROFILE_CODE2
                Java Field:  billingProfileCode2
             
            
                Status:  Active
                SQL Type:  bigint(20)
                Java Type:  Long
             
            
            
            
                
                    
                        
                        Number (code) of the profile of corresponding external code.
                        
                     
                 
             
                    
                        
                Added On:  03/30/16
                SQL Column:  BILLING_PROFILE_CODE3
                Java Field:  billingProfileCode3
             
            
                Status:  Active
                SQL Type:  bigint(20)
                Java Type:  Long
             
            
            
            
                
                    
                        
                        Number (code) of the profile of corresponding external code.
                        
                     
                 
             
                    
                        
                Added On:  03/30/16
                SQL Column:  BILLING_PROFILE_TYPE1
                Java Field:  billingProfileType1
             
            
                Status:  Active
                SQL Type:  varchar(65)
                Java Type:  String
             
            
            
            
                
                    
                        
                        Type of the billing profile to which the corresponding external code belongs to.
                        
                     
                 
             
                    
                        
                Added On:  03/30/16
                SQL Column:  BILLING_PROFILE_TYPE2
                Java Field:  billingProfileType2
             
            
                Status:  Active
                SQL Type:  varchar(65)
                Java Type:  String
             
            
            
            
                
                    
                        
                        Type of the billing profile to which the corresponding external code belongs to.
                        
                     
                 
             
                    
                        
                Added On:  03/30/16
                SQL Column:  BILLING_PROFILE_TYPE3
                Java Field:  billingProfileType3
             
            
                Status:  Active
                SQL Type:  varchar(65)
                Java Type:  String
             
            
            
            
                
                    
                        
                        Type of the billing profile to which the corresponding external code belongs to.
                        
                     
                 
             
                    
                        
                Added On:  07/05/16
                SQL Column:  CHARGE_TRANSACTION_FK
                Java Field:  chargeTransactions
             
            
                Status:  Active
                SQL Type:  bigint(20)
                Java Type:  Long
             
            
            
            
                
                    
                        
                        Reference to the entity that represents real-time financial transaction.
                        
                     
                 
             
                    
                        
                Added On:  02/13/12
                SQL Column:  CLOSE_DATE
                Java Field:  closeDate
             
            
                Status:  Active
                SQL Type:  datetime
                Java Type:  Date
             
            
            
            
                
                    
                        
                        The date when the transaction cycle was closed.
                        
                     
                 
             
                    
                        
                Added On:  09/21/13
                SQL Column:  CONFIRMATION_LOG
                Java Field:  confirmationLog
             
            
                Status:  Active
                SQL Type:  varchar(255)
                Java Type:  String
             
            
            
            
                
                    
                        
                        Used in the confirmation logic. This field stores the value of referenceNumber.
                        
                     
                 
             
                    
                        
                Added On:  05/16/14
                SQL Column:  EXPECTED_CLOSE_DATE
                Java Field:  expectedCloseDate
             
            
                Status:  Active
                SQL Type:  datetime
                Java Type:  Date
             
            
            
            
                
                    
                        
                        The date when settlement is expected to occur.
                        
                     
                 
             
                    
                        
                Added On:  03/30/16
                SQL Column:  EXTERNAL_CODE1
                Java Field:  externalCode1
             
            
                Status:  Active
                SQL Type:  int(11)
                Java Type:  Integer
             
            
            
            
                
                    
                        
                        External order number of the batch file, that is sent to the processor. 
                        
                     
                 
             
                    
                        
                Added On:  03/30/16
                SQL Column:  EXTERNAL_CODE2
                Java Field:  externalCode2
             
            
                Status:  Active
                SQL Type:  int(11)
                Java Type:  Integer
             
            
            
            
                
                    
                        
                        External order number of the batch file, that is sent to the processor. 
                        
                     
                 
             
                    
                        
                Added On:  03/30/16
                SQL Column:  EXTERNAL_CODE3
                Java Field:  externalCode3
             
            
                Status:  Active
                SQL Type:  int(11)
                Java Type:  Integer
             
            
            
            
                
                    
                        
                        External order number of the batch file, that is sent to the processor.
                        
                     
                 
             
                    
                        
                Added On:  02/13/12
                SQL Column:  IS_LOCKED
                Java Field:  isLocked
             
            
                Status:  Active
                SQL Type:  tinyint(1)
                Java Type:  Boolean
             
            
            
                
                    Attributes:
                    Default:false                
                             
            
                
                    
                        
                        Indicates that settlement process for this retail transaction cycle is already started. Adding of a new transaction in this retail transaction cycle is not available.
                        
                     
                 
             
                    
                        
                Added On:  03/30/16
                SQL Column:  IS_REALTIME_MANUAL_CLIENT_CAPTURE
                Java Field:  isRealtimeManualClientCapture
             
            
                Status:  Active
                SQL Type:  tinyint(1)
                Java Type:  Boolean
             
            
            
                
                    Attributes:
                    Default:false                
                             
            
                
                    
                        
                        Indicates that settlement process should be manually initialized by the client.
                        
                     
                 
             
                    
                        
                Added On:  12/11/13
                SQL Column:  IS_SETTLEMENT_NOTIFICATION_ENABLED
                Java Field:  isSettlementNotificationEnabled
             
            
                Status:  Active
                SQL Type:  tinyint(1)
                Java Type:  Boolean
             
            
            
                
                    Attributes:
                    Default:false                
                             
            
                
                    
                        
                        Indicates whether the settlement notification is enabled.
                        
                     
                 
             
                    
                        
                Added On:  06/28/13
                SQL Column:  IS_TRANSACTION_CONFIRMATION_ENABLED
                Java Field:  isTransactionConfirmationEnabled
             
            
                Status:  Active
                SQL Type:  tinyint(1)
                Java Type:  Boolean
             
            
            
                
                    Attributes:
                    Default:false                
                             
            
                
                    
                        
                        Indicates whether the transaction confirmation is enabled.
                        
                     
                 
             
                    
                        
                Added On:  02/13/12
                SQL Column:  OPEN_DATE
                Java Field:  openDate
             
            
                Status:  Active
                SQL Type:  datetime
                Java Type:  Date
             
            
            
            
                
                    
                        
                        The date when the transaction cycle was opened.
                        
                     
                 
             
                    
                        
                Added On:  02/13/12
                SQL Column:  PROCESSED_DATE
                Java Field:  processedDate
             
            
                Status:  Active
                SQL Type:  datetime
                Java Type:  Date
             
            
            
            
                
                    
                        
                        The date when the transaction cycle was processed.
                        
                     
                 
             
                    
                        
                Added On:  07/05/16
                SQL Column:  PROVISIONING_TRANSACTION_FK
                Java Field:  provisioningTransactions
             
            
                Status:  Active
                SQL Type:  bigint(20)
                Java Type:  Long
             
            
            
            
                
                    
                        
                        Reference to the entity that represents provisioning transaction information.
                        
                     
                 
             
                    
                        
                Added On:  02/13/12
                SQL Column:  RETAIL_TRANSACTION_CYCLE_CL
                Java Field:  retailTransactionCycleCl
             
            
                Status:  Active
                SQL Type:  varchar(1)
                Java Type:  String
             
            
            
            
                
                    
                        
                        Represents the type of retail transaction cycle.
                        
                     
                 
             
                    
                        
                Added On:  09/05/14
                SQL Column:  REVIEW_CL
                Java Field:  reviewCl
             
            
                Status:  Active
                SQL Type:  varchar(9)
                Java Type:  String
             
            
            
            
                
                    
                        
                        Represents the review type for this retail transaction cycle.
                        
                     
                 
             
                    
                        
                Added On:  05/19/16
                SQL Column:  SETTLEMENT_MODE_CL
                Java Field:  settlementModeCl
             
            
                Status:  Active
                SQL Type:  varchar(2)
                Java Type:  String
             
            
            
            
                
                    
                        
                        Represents the settlement mode type for this retail transaction cycle.
                        
                     
                 
             
                    
                        
                Added On:  10/30/13
                SQL Column:  SUB_BATCH_CODE
                Java Field:  subBatchCode
             
            
                Status:  Active
                SQL Type:  bigint(20)
                Java Type:  Long
             
            
            
            
                
                    
                        
                        Code of the sub-batch file.
                        
                     
                 
             
                    
                        
                Added On:  07/05/16
                SQL Column:  SUB_BATCH_FK
                Java Field:  subBatches
             
            
                Status:  Active
                SQL Type:  bigint(20)
                Java Type:  Long
             
            
            
            
                
                    
                        
                        Reference to the entity that represents sub-batch file information.
                        
                     
                 
             
                    
                        
                Added On:  09/01/17
                SQL Column:  TERMINAL_CODE
                Java Field:  terminalCode
             
            
                Status:  Active
                SQL Type:  bigint(20)
                Java Type:  Long
             
            
            
            
                
                    
                        
                        Code of the associated terminal.