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

package/models/commission-adjustment.ts

@@ -21,7 +21,7 @@
  */
 export interface CommissionAdjustment {
     /**
-     * Unique identifier for the Commission Activity  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 Activity Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {number}
      * @memberof CommissionAdjustment
      */
@@ -99,7 +99,7 @@ export interface CommissionAdjustment {
      */
     'payor_ID'?: 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 CommissionAdjustment
      */

package/models/commission-agency-rep.ts

@@ -21,103 +21,109 @@
  */
 export interface CommissionAgencyRep {
     /**
-     * 
+     * Unique identifier for the CommissionAgencyRep table Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {number}
      * @memberof CommissionAgencyRep
      */
     'commissionAgencyRep_Key': number;
     /**
-     * 
+     * Unique identifier for the Agent
      * @type {string}
      * @memberof CommissionAgencyRep
      */
     'agent_Number'?: string | null;
     /**
      * 
+     * @type {string}
+     * @memberof CommissionAgencyRep
+     */
+    'cluster_Level'?: string | null;
+    /**
+     * Unique identifier for the CommissionAgency table Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {number}
      * @memberof CommissionAgencyRep
      */
     'commissionAgency_Key': number;
     /**
-     * 
+     * Unique identifier for the CommissionRep table Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {number}
      * @memberof CommissionAgencyRep
      */
     'commissionRep_Key': number;
     /**
-     * 
+     * Informational
      * @type {number}
      * @memberof CommissionAgencyRep
      */
     'eO_Coverage_Deductible'?: number | null;
     /**
-     * 
+     * Informational
      * @type {string}
      * @memberof CommissionAgencyRep
      */
     'eO_Coverage_End'?: string | null;
     /**
-     * 
+     * Informational
      * @type {string}
      * @memberof CommissionAgencyRep
      */
     'eO_Coverage_Level'?: string | null;
     /**
-     * 
+     * Informational
      * @type {string}
      * @memberof CommissionAgencyRep
      */
     'eO_Coverage_Name'?: string | null;
     /**
-     * 
+     * Informational
      * @type {string}
      * @memberof CommissionAgencyRep
      */
     'eO_Coverage_Start'?: string | null;
     /**
-     * 
+     * Beginning date range the Agent represents the Agency
      * @type {string}
      * @memberof CommissionAgencyRep
      */
     'effective_Date'?: string | null;
     /**
-     * 
+     * Date record was first added to the system
      * @type {string}
      * @memberof CommissionAgencyRep
      */
     'entry_Date'?: string;
     /**
-     * 
+     * User that first added the record to the system
      * @type {string}
      * @memberof CommissionAgencyRep
      */
     'entry_User'?: string | null;
     /**
-     * 
+     * Payee of the Agent
      * @type {string}
      * @memberof CommissionAgencyRep
      */
     'payee_ID'?: string | null;
     /**
-     * 
+     * Determine if the Payee, Agnecy, or Agent is paid
      * @type {string}
      * @memberof CommissionAgencyRep
      */
     'send_Check_To'?: string | null;
     /**
-     * 
+     * Ending date range the Agent represents the Agency
      * @type {string}
      * @memberof CommissionAgencyRep
      */
     'term_Date'?: string | null;
     /**
-     * 
+     * Date the record was last updated in the system
      * @type {string}
      * @memberof CommissionAgencyRep
      */
     'update_Date'?: string;
     /**
-     * 
+     * User that last updated the record in the system
      * @type {string}
      * @memberof CommissionAgencyRep
      */

package/models/commission-agency.ts

@@ -21,31 +21,31 @@
  */
 export interface CommissionAgency {
     /**
-     * 
+     * Unique identifier for the Commission Agency table Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {number}
      * @memberof CommissionAgency
      */
     'commissionAgency_Key': number;
     /**
-     * 
+     * Address1 of the Agency
      * @type {string}
      * @memberof CommissionAgency
      */
     'address1'?: string | null;
     /**
-     * 
+     * Address2 of the Agency
      * @type {string}
      * @memberof CommissionAgency
      */
     'address2'?: string | null;
     /**
-     * 
+     * Type of the Agency
      * @type {string}
      * @memberof CommissionAgency
      */
     'agency_Type'?: string | null;
     /**
-     * 
+     * City of the Agency
      * @type {string}
      * @memberof CommissionAgency
      */
@@ -55,87 +55,93 @@ export interface CommissionAgency {
      * @type {string}
      * @memberof CommissionAgency
      */
+    'cluster_Hierarchy'?: string | null;
+    /**
+     * Country ID of the Agency
+     * @type {string}
+     * @memberof CommissionAgency
+     */
     'country_ID'?: string | null;
     /**
-     * 
+     * County Code of the Agency
      * @type {string}
      * @memberof CommissionAgency
      */
     'county_Code'?: string | null;
     /**
-     * 
+     * Date record was first added to the system
      * @type {string}
      * @memberof CommissionAgency
      */
     'entry_Date'?: string;
     /**
-     * 
+     * User that first added the record to the system
      * @type {string}
      * @memberof CommissionAgency
      */
     'entry_User'?: string | null;
     /**
-     * 
+     * Fax Country Code of the Agency
      * @type {string}
      * @memberof CommissionAgency
      */
     'fax_Country_Code'?: string | null;
     /**
-     * 
+     * Fax Number of the Agency
      * @type {string}
      * @memberof CommissionAgency
      */
     'fax_Number'?: string | null;
     /**
-     * 
+     * Name of the Agency
      * @type {string}
      * @memberof CommissionAgency
      */
     'name'?: string | null;
     /**
-     * 
+     * Payee ID of the Agency
      * @type {string}
      * @memberof CommissionAgency
      */
     'payee_ID'?: string | null;
     /**
-     * 
+     * Payment Distribution Interval of the Agency
      * @type {string}
      * @memberof CommissionAgency
      */
     'payment_Distribution_Interval'?: string | null;
     /**
-     * 
+     * Phone Country Code of the Agency
      * @type {string}
      * @memberof CommissionAgency
      */
     'phone_Country_Code'?: string | null;
     /**
-     * 
+     * Phone Number of the Agency
      * @type {string}
      * @memberof CommissionAgency
      */
     'phone_Number'?: string | null;
     /**
-     * 
+     * State of the Agency
      * @type {string}
      * @memberof CommissionAgency
      */
     'state'?: string | null;
     /**
-     * 
+     * Date the record was last updated in the system
      * @type {string}
      * @memberof CommissionAgency
      */
     'update_Date'?: string;
     /**
-     * 
+     * User that last updated the record in the system
      * @type {string}
      * @memberof CommissionAgency
      */
     'update_User'?: string | null;
     /**
-     * 
+     * Zip Code of the Agency
      * @type {string}
      * @memberof CommissionAgency
      */

package/models/commission-rate-cluster-agency-rep.ts

@@ -21,43 +21,43 @@
  */
 export interface CommissionRateClusterAgencyRep {
     /**
-     * Note: This field is marked as NOT NULL in the database and therefore required by the API.
+     * Unique identifer for the Commission Rate Cluster Agency Rep Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {number}
      * @memberof CommissionRateClusterAgencyRep
      */
     'commissionRateClusterAgencyRep_Key': number;
     /**
-     * 
+     * Unique identifier for the CommissionAgencyRep
      * @type {number}
      * @memberof CommissionRateClusterAgencyRep
      */
     'commissionAgencyRep_Key'?: number | null;
     /**
-     * Date record was first added to the system
+     * Date when the record was first added to the system.
      * @type {string}
      * @memberof CommissionRateClusterAgencyRep
      */
     'entry_Date'?: string;
     /**
-     * User that first added the record to the system
+     * User that first added the record to the system.
      * @type {string}
      * @memberof CommissionRateClusterAgencyRep
      */
     'entry_User'?: string | null;
     /**
-     * 
+     * Parent key for the CommissionAgencyRep record this is a child of
      * @type {number}
      * @memberof CommissionRateClusterAgencyRep
      */
     'parent_CommissionAgencyRep_Key'?: number | null;
     /**
-     * 
+     * Unique identifer for the Rate Cluster
      * @type {string}
      * @memberof CommissionRateClusterAgencyRep
      */
     'rate_Cluster'?: string | null;
     /**
-     * 
+     * The amount or percentage of the split
      * @type {number}
      * @memberof CommissionRateClusterAgencyRep
      */
@@ -81,19 +81,19 @@ export interface CommissionRateClusterAgencyRep {
      */
     'split_Priority'?: number | null;
     /**
-     * 
+     * Determines if split is percent or flat amount
      * @type {string}
      * @memberof CommissionRateClusterAgencyRep
      */
     'split_Type'?: string | null;
     /**
-     * Date the record was last updated in the system
+     * Date when the record was last updated in the system.
      * @type {string}
      * @memberof CommissionRateClusterAgencyRep
      */
     'update_Date'?: string;
     /**
-     * User that last updated the record in the system
+     * User that last updated the record in the system.
      * @type {string}
      * @memberof CommissionRateClusterAgencyRep
      */

package/models/commission-rate-cluster.ts

@@ -21,7 +21,7 @@
  */
 export interface CommissionRateCluster {
     /**
-     * 
+     * Unique identifer for the Rate Cluster
      * @type {string}
      * @memberof CommissionRateCluster
      */
@@ -31,27 +31,33 @@ export interface CommissionRateCluster {
      * @type {string}
      * @memberof CommissionRateCluster
      */
+    'cluster_Level'?: string | null;
+    /**
+     * Description of the rate Cluster
+     * @type {string}
+     * @memberof CommissionRateCluster
+     */
     'description'?: string | null;
     /**
-     * 
+     * Date record was first added to the system
      * @type {string}
      * @memberof CommissionRateCluster
      */
     'entry_Date'?: string;
     /**
-     * 
+     * User that first added the record to the system
      * @type {string}
      * @memberof CommissionRateCluster
      */
     'entry_User'?: string | null;
     /**
-     * 
+     * Date the record was last updated in the system
      * @type {string}
      * @memberof CommissionRateCluster
      */
     'update_Date'?: string;
     /**
-     * 
+     * User that last updated the record in the system
      * @type {string}
      * @memberof CommissionRateCluster
      */

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
      */