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

package/models/subscriber-idcode.ts

@@ -38,5 +38,29 @@ export interface SubscriberIDCode {
      * @memberof SubscriberIDCode
      */
     'description'?: string | null;
+    /**
+     * No longer in use.
+     * @type {string}
+     * @memberof SubscriberIDCode
+     */
+    'entry_Date'?: string;
+    /**
+     * No longer in use.
+     * @type {string}
+     * @memberof SubscriberIDCode
+     */
+    'entry_User'?: string | null;
+    /**
+     * No longer in use.
+     * @type {string}
+     * @memberof SubscriberIDCode
+     */
+    'update_Date'?: string;
+    /**
+     * No longer in use.
+     * @type {string}
+     * @memberof SubscriberIDCode
+     */
+    'update_User'?: string | null;
 }
 

package/models/subscriber-idhistory.ts

@@ -21,11 +21,23 @@
  */
 export interface SubscriberIDHistory {
     /**
-     * Unique identifier for each Subscriber ID change process.
+     * Unique identifier for each Subscriber ID change process. Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {number}
      * @memberof SubscriberIDHistory
      */
     'change_ID': number;
+    /**
+     * Date when the record was first added to the system.
+     * @type {string}
+     * @memberof SubscriberIDHistory
+     */
+    'entry_Date'?: string;
+    /**
+     * User that first added the record to the system.
+     * @type {string}
+     * @memberof SubscriberIDHistory
+     */
+    'entry_User'?: string | null;
     /**
      * Indicates if the process returned an error during the change procedure.
      * @type {number}

package/models/subscriber-plan-policy.ts

@@ -44,6 +44,18 @@ export interface SubscriberPlanPolicy {
      * @memberof SubscriberPlanPolicy
      */
     'policy_Number': string;
+    /**
+     * Date when the record was first added to the system.
+     * @type {string}
+     * @memberof SubscriberPlanPolicy
+     */
+    'entry_Date'?: string;
+    /**
+     * User that first added the record to the system.
+     * @type {string}
+     * @memberof SubscriberPlanPolicy
+     */
+    'entry_User'?: string | null;
     /**
      * Date when the selected policy matures.
      * @type {string}
@@ -56,5 +68,17 @@ export interface SubscriberPlanPolicy {
      * @memberof SubscriberPlanPolicy
      */
     'paid_Through'?: string | null;
+    /**
+     * Date when the record was last updated in the system.
+     * @type {string}
+     * @memberof SubscriberPlanPolicy
+     */
+    'update_Date'?: string;
+    /**
+     * User that last updated the record in the system.
+     * @type {string}
+     * @memberof SubscriberPlanPolicy
+     */
+    'update_User'?: string | null;
 }
 

package/models/subscriber-policy-status.ts

@@ -51,16 +51,40 @@ export interface SubscriberPolicyStatus {
      */
     'policy_Status': string;
     /**
-     * Date when the policy status goes/went into effect.
+     * Date when the policy status goes/went into effect. Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {string}
      * @memberof SubscriberPolicyStatus
      */
     'effective_Date': string;
+    /**
+     * Date when the record was first added to the system.
+     * @type {string}
+     * @memberof SubscriberPolicyStatus
+     */
+    'entry_Date'?: string;
+    /**
+     * User that first added the record to the system.
+     * @type {string}
+     * @memberof SubscriberPolicyStatus
+     */
+    'entry_User'?: string | null;
     /**
      * Date when the policy status expires/expired.
      * @type {string}
      * @memberof SubscriberPolicyStatus
      */
     'term_Date'?: string | null;
+    /**
+     * Date when the record was last updated in the system.
+     * @type {string}
+     * @memberof SubscriberPolicyStatus
+     */
+    'update_Date'?: string;
+    /**
+     * User that last updated the record in the system.
+     * @type {string}
+     * @memberof SubscriberPolicyStatus
+     */
+    'update_User'?: string | null;
 }
 

package/models/subscriber-prem-rate-split.ts

@@ -21,29 +21,41 @@
  */
 export interface SubscriberPremRateSplit {
     /**
-     * Unqiue identiferi for each Premium Rate split configured for this subscriber.
+     * Unqiue identiferi for each Premium Rate split configured for this subscriber. Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {number}
      * @memberof SubscriberPremRateSplit
      */
     'subscriberPremRateSplit_Key': number;
     /**
-     * Specifies the amount of the rate split.
+     * Specifies the amount of the rate split. Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {number}
      * @memberof SubscriberPremRateSplit
      */
     'amount': number;
     /**
-     * Identifies that the rate split is a percentage.
+     * Identifies that the rate split is a percentage. Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {boolean}
      * @memberof SubscriberPremRateSplit
      */
     'amount_Pct': boolean;
     /**
-     * Date when the associated rate split becomes/became effective.
+     * Date when the associated rate split becomes/became effective. Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {string}
      * @memberof SubscriberPremRateSplit
      */
     'effective_Date': string;
+    /**
+     * Date when the record was first added to the system.
+     * @type {string}
+     * @memberof SubscriberPremRateSplit
+     */
+    'entry_Date'?: string;
+    /**
+     * User that first added the record to the system.
+     * @type {string}
+     * @memberof SubscriberPremRateSplit
+     */
+    'entry_User'?: string | null;
     /**
      * Identifies at which level the rate split will be invoiced.
      * @type {string}
@@ -51,7 +63,7 @@ export interface SubscriberPremRateSplit {
      */
     'invoice_Level': string;
     /**
-     * References PremRate.PremRate_Key value on the referenced record.
+     * References PremRate.PremRate_Key value on the referenced record. Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {number}
      * @memberof SubscriberPremRateSplit
      */
@@ -74,5 +86,17 @@ export interface SubscriberPremRateSplit {
      * @memberof SubscriberPremRateSplit
      */
     'term_Date'?: string | null;
+    /**
+     * Date when the record was last updated in the system.
+     * @type {string}
+     * @memberof SubscriberPremRateSplit
+     */
+    'update_Date'?: string;
+    /**
+     * User that last updated the record in the system.
+     * @type {string}
+     * @memberof SubscriberPremRateSplit
+     */
+    'update_User'?: string | null;
 }
 

package/models/subscriber-reimbursement.ts

@@ -21,7 +21,7 @@
  */
 export interface SubscriberReimbursement {
     /**
-     * Unique identifier for each remibursement configuration for this Group and Plan.
+     * Unique identifier for each remibursement configuration for this Group and Plan. Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {number}
      * @memberof SubscriberReimbursement
      */
@@ -38,6 +38,18 @@ export interface SubscriberReimbursement {
      * @memberof SubscriberReimbursement
      */
     'effective_Date'?: string | null;
+    /**
+     * User that first added the record to the system.
+     * @type {string}
+     * @memberof SubscriberReimbursement
+     */
+    'entry_Date'?: string;
+    /**
+     * Date when the record was first added to the system.
+     * @type {string}
+     * @memberof SubscriberReimbursement
+     */
+    'entry_User'?: string | null;
     /**
      * References Groups.Group_ID value on parent record.
      * @type {string}
@@ -62,5 +74,17 @@ export interface SubscriberReimbursement {
      * @memberof SubscriberReimbursement
      */
     'term_Date'?: string | null;
+    /**
+     * User that last updated the record in the system.
+     * @type {string}
+     * @memberof SubscriberReimbursement
+     */
+    'update_Date'?: string;
+    /**
+     * Date when the record was last updated in the system.
+     * @type {string}
+     * @memberof SubscriberReimbursement
+     */
+    'update_User'?: string | null;
 }
 

package/models/subscriber-sponsor.ts

@@ -21,13 +21,13 @@
  */
 export interface SubscriberSponsor {
     /**
-     * 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 Subscriber Sponsor entry. This is the primary key of the table. Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {number}
      * @memberof SubscriberSponsor
      */
     'subscriberSponsor_Key': number;
     /**
-     * 
+     * Beginning date for this sponsor record to apply.
      * @type {string}
      * @memberof SubscriberSponsor
      */
@@ -45,25 +45,25 @@ export interface SubscriberSponsor {
      */
     'entry_User'?: string | null;
     /**
-     * 
+     * Identifier for the sponsor of this subscriber, matches Subscribers.Subscriber_ID.
      * @type {string}
      * @memberof SubscriberSponsor
      */
     'sponsor_ID': string;
     /**
-     * 
+     * Relation of the sponsor to the subscriber, matches Relationships.Relate_Code.
      * @type {string}
      * @memberof SubscriberSponsor
      */
     'sponsor_Relate_Code'?: string | null;
     /**
-     * 
+     * Unique ID assigned to the Subscriber
      * @type {string}
      * @memberof SubscriberSponsor
      */
     'subscriber_ID': string;
     /**
-     * 
+     * Ending date for this sponsor record to apply.
      * @type {string}
      * @memberof SubscriberSponsor
      */

package/models/subscriber-waive-premium.ts

@@ -21,7 +21,7 @@
  */
 export interface SubscriberWaivePremium {
     /**
-     * Unique identifier for this waived preimum.
+     * Unique identifier for this waived preimum. Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {number}
      * @memberof SubscriberWaivePremium
      */
@@ -38,6 +38,18 @@ export interface SubscriberWaivePremium {
      * @memberof SubscriberWaivePremium
      */
     'effective_Date'?: string | null;
+    /**
+     * Date when the record was first added to the system.
+     * @type {string}
+     * @memberof SubscriberWaivePremium
+     */
+    'entry_Date'?: string;
+    /**
+     * User that first added the record to the system.
+     * @type {string}
+     * @memberof SubscriberWaivePremium
+     */
+    'entry_User'?: string | null;
     /**
      * Specifies the Ex Code that is to be applied with the waiver.
      * @type {string}
@@ -62,5 +74,17 @@ export interface SubscriberWaivePremium {
      * @memberof SubscriberWaivePremium
      */
     'term_Date'?: string | null;
+    /**
+     * Date when the record was last updated in the system.
+     * @type {string}
+     * @memberof SubscriberWaivePremium
+     */
+    'update_Date'?: string;
+    /**
+     * User that last updated the record in the system.
+     * @type {string}
+     * @memberof SubscriberWaivePremium
+     */
+    'update_User'?: string | null;
 }
 

package/models/subscriber-writing-agent.ts

@@ -21,67 +21,67 @@
  */
 export interface SubscriberWritingAgent {
     /**
-     * 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 Subscriber Writing Agent entry. Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {number}
      * @memberof SubscriberWritingAgent
      */
     'subscriberWritingAgent_Key': number;
     /**
-     * 
+     * Date account is effective for the Rep Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {string}
      * @memberof SubscriberWritingAgent
      */
     'effective_Date': string;
     /**
-     * 
+     * Date record was first added to the system
      * @type {string}
      * @memberof SubscriberWritingAgent
      */
     'entry_Date'?: string;
     /**
-     * 
+     * User that first added the record to the system
      * @type {string}
      * @memberof SubscriberWritingAgent
      */
     'entry_User'?: string | null;
     /**
-     * 
+     * ID of the plan that the commission is associated with.
      * @type {string}
      * @memberof SubscriberWritingAgent
      */
     'plan_ID': string;
     /**
-     * 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.
+     * The percentage the Rep receives for this Commission. Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {number}
      * @memberof SubscriberWritingAgent
      */
     'split': number;
     /**
-     * 
+     * Unique identifier assigned to the Subscriber by the system.
      * @type {string}
      * @memberof SubscriberWritingAgent
      */
     'subscriber_ID': string;
     /**
-     * 
+     * Date account is no longer effective for the Rep Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {string}
      * @memberof SubscriberWritingAgent
      */
     'term_Date': string;
     /**
-     * 
+     * Date the record was last updated in the system
      * @type {string}
      * @memberof SubscriberWritingAgent
      */
     'update_Date'?: string;
     /**
-     * 
+     * User that last updated the record in the system
      * @type {string}
      * @memberof SubscriberWritingAgent
      */
     'update_User'?: string | null;
     /**
-     * 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 CommissionAgencyRep table Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {number}
      * @memberof SubscriberWritingAgent
      */

package/models/subscribers.ts

@@ -117,7 +117,7 @@ export interface Subscribers {
      */
     'home_Phone'?: string | null;
     /**
-     * 
+     * For Life & Disability clients, this holds the issue state for processing taxes and reporting.
      * @type {string}
      * @memberof Subscribers
      */

package/models/suffix.ts

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

package/models/tax-filing-status.ts

@@ -21,7 +21,7 @@
  */
 export interface TaxFilingStatus {
     /**
-     * Identifier for the specific filing status
+     * Identifier for the specific filing status Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {number}
      * @memberof TaxFilingStatus
      */
@@ -33,10 +33,34 @@ export interface TaxFilingStatus {
      */
     'description'?: string | null;
     /**
-     * Flag identifying the specific status as the default filing status
+     * Date record was first added to the system
+     * @type {string}
+     * @memberof TaxFilingStatus
+     */
+    'entry_Date'?: string;
+    /**
+     * User that first added the record to the system
+     * @type {string}
+     * @memberof TaxFilingStatus
+     */
+    'entry_User'?: string | null;
+    /**
+     * Flag identifying the specific status as the default filing status Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {boolean}
      * @memberof TaxFilingStatus
      */
     'filing_Default': boolean;
+    /**
+     * Date the record was last updated in the system
+     * @type {string}
+     * @memberof TaxFilingStatus
+     */
+    'update_Date'?: string;
+    /**
+     * User that last updated the record in the system
+     * @type {string}
+     * @memberof TaxFilingStatus
+     */
+    'update_User'?: string | null;
 }
 

package/models/taxonomy-group-detail.ts

@@ -21,11 +21,23 @@
  */
 export interface TaxonomyGroupDetail {
     /**
-     * Key value identifying the range of taxonomies in the taxonomy group
+     * Key value identifying the range of taxonomies in the taxonomy group Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {number}
      * @memberof TaxonomyGroupDetail
      */
     'taxonomyGroupDetail_Key': number;
+    /**
+     * Date record was first added to the system
+     * @type {string}
+     * @memberof TaxonomyGroupDetail
+     */
+    'entry_Date'?: string;
+    /**
+     * User that first added the record to the system
+     * @type {string}
+     * @memberof TaxonomyGroupDetail
+     */
+    'entry_User'?: string | null;
     /**
      * Taxonomy code value for the first taxonomy in the range
      * @type {string}
@@ -44,5 +56,17 @@ export interface TaxonomyGroupDetail {
      * @memberof TaxonomyGroupDetail
      */
     'thru_Value'?: string | null;
+    /**
+     * Date the record was last updated in the system
+     * @type {string}
+     * @memberof TaxonomyGroupDetail
+     */
+    'update_Date'?: string;
+    /**
+     * User that last updated the record in the system
+     * @type {string}
+     * @memberof TaxonomyGroupDetail
+     */
+    'update_User'?: string | null;
 }
 

package/models/taxonomy-group.ts

@@ -32,11 +32,35 @@ export interface TaxonomyGroup {
      * @memberof TaxonomyGroup
      */
     'description': string;
+    /**
+     * Date record was first added to the system
+     * @type {string}
+     * @memberof TaxonomyGroup
+     */
+    'entry_Date'?: string;
+    /**
+     * User that first added the record to the system
+     * @type {string}
+     * @memberof TaxonomyGroup
+     */
+    'entry_User'?: string | null;
     /**
      * Type of taxonomy included in the taxonomy group
      * @type {string}
      * @memberof TaxonomyGroup
      */
     'taxonomy_Type': string;
+    /**
+     * Date the record was last updated in the system
+     * @type {string}
+     * @memberof TaxonomyGroup
+     */
+    'update_Date'?: string;
+    /**
+     * User that last updated the record in the system
+     * @type {string}
+     * @memberof TaxonomyGroup
+     */
+    'update_User'?: string | null;
 }
 

package/models/taxonomy.ts

@@ -21,7 +21,7 @@
  */
 export interface Taxonomy {
     /**
-     * Key value identifying a specific provider taxonomy
+     * Key value identifying a specific provider taxonomy Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {number}
      * @memberof Taxonomy
      */
@@ -38,6 +38,18 @@ export interface Taxonomy {
      * @memberof Taxonomy
      */
     'definition'?: string | null;
+    /**
+     * Date record was first added to the system
+     * @type {string}
+     * @memberof Taxonomy
+     */
+    'entry_Date'?: string;
+    /**
+     * User that first added the record to the system
+     * @type {string}
+     * @memberof Taxonomy
+     */
+    'entry_User'?: string | null;
     /**
      * Grouping associated with the provider taxonomy
      * @type {string}
@@ -62,5 +74,17 @@ export interface Taxonomy {
      * @memberof Taxonomy
      */
     'taxonomy_Code': string;
+    /**
+     * Date the record was last updated in the system
+     * @type {string}
+     * @memberof Taxonomy
+     */
+    'update_Date'?: string;
+    /**
+     * User that last updated the record in the system
+     * @type {string}
+     * @memberof Taxonomy
+     */
+    'update_User'?: string | null;
 }