@vbasoftware/vbapi-vbasoftware-typescript-axios 1.20240302.1 → 1.20240913.2

package/models/commission-rate.ts

@@ -21,7 +21,7 @@
  */
 export interface CommissionRate {
     /**
-     * Unique identifier for the Commission Rate  Note: The database will apply a default value of `0` for this field if a value is not provided.  This field is also marked as NOT NULL in the database and therefore required by the API.  If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.
+     * Unique identifier for the Commission Rate Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {number}
      * @memberof CommissionRate
      */
@@ -105,19 +105,19 @@ export interface CommissionRate {
      */
     'group_ID'?: string | null;
     /**
-     * 
+     * Holds the lower bound of the applicable age range for the commission rate record.
      * @type {number}
      * @memberof CommissionRate
      */
     'issue_Age_From'?: number | null;
     /**
-     * 
+     * Holds the upper bound of the applicable age range for the commission rate record.
      * @type {number}
      * @memberof CommissionRate
      */
     'issue_Age_Thru'?: number | null;
     /**
-     * 
+     * Holds the abbreviated state name for the commission rate record.
      * @type {string}
      * @memberof CommissionRate
      */
@@ -135,7 +135,7 @@ export interface CommissionRate {
      */
     'parent_CommissionRate_Key'?: number | null;
     /**
-     * 
+     * Defines which CommissionRateCluster.Rate_Cluster is a parent to this commission rate record.
      * @type {string}
      * @memberof CommissionRate
      */
@@ -153,25 +153,25 @@ export interface CommissionRate {
      */
     'plan_ID'?: string | null;
     /**
-     * 
+     * Holds the plan_type for which this commission rate record applies.
      * @type {string}
      * @memberof CommissionRate
      */
     'plan_Type'?: string | null;
     /**
-     * 
+     * TBD
      * @type {string}
      * @memberof CommissionRate
      */
     'pre_Payment_Adjustment_Reason'?: string | null;
     /**
-     * Note: The database will apply a default value of `False` for this field if a value is not provided.  This field is also marked as NOT NULL in the database and therefore required by the API.  If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.
+     * TBD Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {boolean}
      * @memberof CommissionRate
      */
     'pre_Payment_Rate': boolean;
     /**
-     * 
+     * TBD
      * @type {string}
      * @memberof CommissionRate
      */
@@ -231,7 +231,7 @@ export interface CommissionRate {
      */
     'rate_Variable3'?: number | null;
     /**
-     * Determines if Header Adjustments are included in the scaling  Note: The database will apply a default value of `False` for this field if a value is not provided.  This field is also marked as NOT NULL in the database and therefore required by the API.  If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.
+     * Determines if Header Adjustments are included in the scaling Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {boolean}
      * @memberof CommissionRate
      */
@@ -303,7 +303,7 @@ export interface CommissionRate {
      */
     'update_User'?: string | null;
     /**
-     * Note: The database will apply a default value of `False` for this field if a value is not provided.  This field is also marked as NOT NULL in the database and therefore required by the API.  If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.
+     * Flag to calculate commission based on the first calculated premium for this rate and then agent. Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {boolean}
      * @memberof CommissionRate
      */

package/models/commission.ts

@@ -21,139 +21,139 @@
  */
 export interface Commission {
     /**
-     * 
+     * Unique identifier for the Commission table Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {number}
      * @memberof Commission
      */
     'commission_Key': number;
     /**
-     * 
+     * Unique identifier for the Account
      * @type {number}
      * @memberof Commission
      */
     'account_Key'?: number | null;
     /**
-     * 
+     * Adjustment Amounts to this Commission
      * @type {number}
      * @memberof Commission
      */
     'adjustment_Amount'?: number | null;
     /**
-     * 
+     * Adjustment Amounts Received to this Commission
      * @type {number}
      * @memberof Commission
      */
     'adjustment_Amount_Received'?: number | null;
     /**
-     * 
+     * Commission Amount after previous amounts
      * @type {number}
      * @memberof Commission
      */
     'calculated_Commission_Amount'?: number | null;
     /**
-     * 
+     * Premium Amount after previous amounts
      * @type {number}
      * @memberof Commission
      */
     'calculated_Premium_Amount'?: number | null;
     /**
-     * 
+     * Premium Amount Received after previous amounts
      * @type {number}
      * @memberof Commission
      */
     'calculated_Premium_Amount_Received'?: number | null;
     /**
-     * 
+     * Check Batch for this Commission
      * @type {number}
      * @memberof Commission
      */
     'check_Batch'?: number | null;
     /**
-     * 
+     * Check for this Commission
      * @type {number}
      * @memberof Commission
      */
     'check_ID'?: number | null;
     /**
-     * 
+     * Decimal value that defines the base rate
      * @type {number}
      * @memberof Commission
      */
     'comm_Rate'?: number | null;
     /**
-     * 
+     * Maximum the rate will be regardless of the calculation
      * @type {number}
      * @memberof Commission
      */
     'comm_Rate_Max'?: number | null;
     /**
-     * 
+     * Minimum the rate will be regardless of the calculation
      * @type {number}
      * @memberof Commission
      */
     'comm_Rate_Min'?: number | null;
     /**
-     * 
+     * First variable used in calculating the rate based on the type
      * @type {number}
      * @memberof Commission
      */
     'comm_Rate_Variable1'?: number | null;
     /**
-     * 
+     * Second variable used in calculating the rate based on the type
      * @type {number}
      * @memberof Commission
      */
     'comm_Rate_Variable2'?: number | null;
     /**
-     * 
+     * Third variable used in calculating the rate based on the type
      * @type {number}
      * @memberof Commission
      */
     'comm_Rate_Variable3'?: number | null;
     /**
-     * 
+     * Beginning range of the amount used for scaling
      * @type {number}
      * @memberof Commission
      */
     'comm_Scale_From'?: number | null;
     /**
-     * 
+     * Ending range of the amount used for scaling
      * @type {number}
      * @memberof Commission
      */
     'comm_Scale_Thru'?: number | null;
     /**
-     * 
+     * Used to detemine what date to begin the range for scaling
      * @type {string}
      * @memberof Commission
      */
     'comm_Scale_Timeframe'?: string | null;
     /**
-     * 
+     * Determines what amount the scale is based off of
      * @type {string}
      * @memberof Commission
      */
     'comm_Scale_Type'?: string | null;
     /**
-     * 
+     * Beginning range of a number of Days, Months, or Years
      * @type {number}
      * @memberof Commission
      */
     'comm_Term_Range_From'?: number | null;
     /**
-     * 
+     * Ending range of a number of Days, Months, or Years
      * @type {number}
      * @memberof Commission
      */
     'comm_Term_Range_Thru'?: number | null;
     /**
-     * 
+     * Determines if Term Range is Days, Months, or Years
      * @type {string}
      * @memberof Commission
      */
     'comm_Term_Range_Type'?: string | null;
     /**
-     * 
+     * Unique identifier for the CommissionAgencyRepRate table
      * @type {number}
      * @memberof Commission
      */
@@ -163,189 +163,201 @@ export interface Commission {
      * @type {number}
      * @memberof Commission
      */
-    'commissionTransaction_Key'?: number | null;
+    'commissionAgencyRep_Key'?: number | null;
     /**
      * 
      * @type {number}
      * @memberof Commission
      */
+    'commissionRate_Key'?: number | null;
+    /**
+     * Unique identifier for the CommissionTransaction table
+     * @type {number}
+     * @memberof Commission
+     */
+    'commissionTransaction_Key'?: number | null;
+    /**
+     * Full Commission Amount without adjusting for previous amounts
+     * @type {number}
+     * @memberof Commission
+     */
     'commission_Amount'?: number | null;
     /**
-     * 
+     * Basis of the Commission
      * @type {string}
      * @memberof Commission
      */
     'commission_Basis'?: string | null;
     /**
-     * 
+     * Cycle of the Commission
      * @type {string}
      * @memberof Commission
      */
     'commission_Cycle'?: string | null;
     /**
-     * 
+     * Date the Commission was calculated for
      * @type {string}
      * @memberof Commission
      */
     'commission_Date'?: string | null;
     /**
-     * 
+     * Number of Dependents used for this Commission
      * @type {number}
      * @memberof Commission
      */
     'dependent_Count'?: number | null;
     /**
-     * 
+     * Division for this Commission
      * @type {string}
      * @memberof Commission
      */
     'division_ID'?: string | null;
     /**
-     * 
+     * Date record was first added to the system
      * @type {string}
      * @memberof Commission
      */
     'entry_Date'?: string;
     /**
-     * 
+     * User that first added the record to the system
      * @type {string}
      * @memberof Commission
      */
     'entry_User'?: string | null;
     /**
-     * 
+     * Group for this Commission
      * @type {string}
      * @memberof Commission
      */
     'group_ID'?: string | null;
     /**
-     * 
+     * Unique identifier for the InvoiceAdjustment table
      * @type {number}
      * @memberof Commission
      */
     'invoiceAdjustment_Key'?: number | null;
     /**
-     * 
+     * Unique identifier for the PremInvoice table
      * @type {number}
      * @memberof Commission
      */
     'invoice_Key'?: number | null;
     /**
-     * 
+     * Not used
      * @type {string}
      * @memberof Commission
      */
     'license_Number'?: string | null;
     /**
-     * 
+     * Not used
      * @type {string}
      * @memberof Commission
      */
     'license_State'?: string | null;
     /**
-     * 
+     * Not used
      * @type {string}
      * @memberof Commission
      */
     'license_Type'?: string | null;
     /**
-     * 
+     * Number of Members used for this Commission
      * @type {number}
      * @memberof Commission
      */
     'member_Count'?: number | null;
     /**
-     * 
+     * Not used
      * @type {number}
      * @memberof Commission
      */
     'new_CommissionAgencyRep_Key'?: number | null;
     /**
-     * 
+     * Not used
      * @type {number}
      * @memberof Commission
      */
     'original_CommissionAgencyRep_Key'?: number | null;
     /**
-     * 
+     * Unique identifier for the Payor
      * @type {string}
      * @memberof Commission
      */
     'payor_ID'?: string | null;
     /**
-     * 
+     * Plan for this Commission
      * @type {string}
      * @memberof Commission
      */
     'plan_ID'?: string | null;
     /**
-     * 
+     * PremRate for this Commission
      * @type {number}
      * @memberof Commission
      */
     'premRate_Key'?: number | null;
     /**
-     * 
+     * Full Premium Amount without adjusting for previous amounts
      * @type {number}
      * @memberof Commission
      */
     'premium_Amount'?: number | null;
     /**
-     * 
+     * Full Premium Amount Received without adjusting for previous amounts
      * @type {number}
      * @memberof Commission
      */
     'premium_Amount_Received'?: number | null;
     /**
-     * 
+     * The amount or percentage of the split
      * @type {number}
      * @memberof Commission
      */
     'rep_Split'?: number | null;
     /**
-     * 
+     * Maximum amount of the split
      * @type {number}
      * @memberof Commission
      */
     'rep_Split_Max'?: number | null;
     /**
-     * 
+     * Minimum amount of the split
      * @type {number}
      * @memberof Commission
      */
     'rep_Split_Min'?: number | null;
     /**
-     * 
+     * Priority of the split
      * @type {number}
      * @memberof Commission
      */
     'rep_Split_Priority'?: number | null;
     /**
-     * 
+     * Determines if split is percent or flat amount
      * @type {string}
      * @memberof Commission
      */
     'rep_Split_Type'?: string | null;
     /**
-     * 
+     * Number of Subscribers used for this Commission
      * @type {number}
      * @memberof Commission
      */
     'subscriber_Count'?: number | null;
     /**
-     * 
+     * Subscriber for this Commission
      * @type {string}
      * @memberof Commission
      */
     'subscriber_ID'?: string | null;
     /**
-     * 
+     * Date the record was last updated in the system
      * @type {string}
      * @memberof Commission
      */
     'update_Date'?: string;
     /**
-     * 
+     * User that last updated the record in the system
      * @type {string}
      * @memberof Commission
      */

package/models/communication-method.ts

@@ -32,5 +32,29 @@ export interface CommunicationMethod {
      * @memberof CommunicationMethod
      */
     'description'?: string | null;
+    /**
+     * Date record was first added to the system
+     * @type {string}
+     * @memberof CommunicationMethod
+     */
+    'entry_Date'?: string;
+    /**
+     * User that first added the record to the system
+     * @type {string}
+     * @memberof CommunicationMethod
+     */
+    'entry_User'?: string | null;
+    /**
+     * Date the record was last updated in the system
+     * @type {string}
+     * @memberof CommunicationMethod
+     */
+    'update_Date'?: string;
+    /**
+     * User that last updated the record in the system
+     * @type {string}
+     * @memberof CommunicationMethod
+     */
+    'update_User'?: string | null;
 }