@vbasoftware/vbapi-vbasoftware-typescript-axios 1.20230208.2 → 1.20230225.1

package/models/cost-contain-zelis-ex-code.ts

@@ -21,37 +21,37 @@
  */
 export interface CostContainZelisExCode {
     /**
-     * 
+     * An Ex Code that is being used for Zelis
      * @type {string}
      * @memberof CostContainZelisExCode
      */
     'ex_Code': string;
     /**
-     * 
+     * Date record was first added to the system
      * @type {string}
      * @memberof CostContainZelisExCode
      */
     'entry_Date'?: string;
     /**
-     * 
+     * User that first added the record to the system
      * @type {string}
      * @memberof CostContainZelisExCode
      */
     'entry_User'?: string | null;
     /**
-     * 
+     * When the Ex Code is present on the claim, when this is sent to Zelis, send it as In Network  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.
      * @type {boolean}
      * @memberof CostContainZelisExCode
      */
     'in_Network': boolean;
     /**
-     * 
+     * Date the record was last updated in the system
      * @type {string}
      * @memberof CostContainZelisExCode
      */
     'update_Date'?: string;
     /**
-     * 
+     * User that last updated the record in the system
      * @type {string}
      * @memberof CostContainZelisExCode
      */

package/models/groups.ts

@@ -51,7 +51,7 @@ export interface Groups {
      */
     'address2'?: string | null;
     /**
-     * Indicates if this Group administers COBRA.
+     * Indicates if this Group administers COBRA.  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.
      * @type {boolean}
      * @memberof Groups
      */
@@ -63,19 +63,19 @@ export interface Groups {
      */
     'adult_Age'?: number | null;
     /**
-     * Notes if the claims for this Group should be Advice_To_Pay (flagged as unpaid when processed).
+     * Notes if the claims for this Group should be Advice_To_Pay (flagged as unpaid when processed).  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.
      * @type {boolean}
      * @memberof Groups
      */
     'advice_To_Pay': boolean;
     /**
-     * Flag if adjudication should apply an Ex Code to a claim for this Group.
+     * Flag if adjudication should apply an Ex Code to a claim for this Group.  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.
      * @type {boolean}
      * @memberof Groups
      */
     'apply_Ex_Code': boolean;
     /**
-     * Notes if this group allows Auth Required claims edit to be overridden and paid.
+     * Notes if this group allows Auth Required claims edit to be overridden and paid.  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.
      * @type {boolean}
      * @memberof Groups
      */
@@ -147,7 +147,7 @@ export interface Groups {
      */
     'claim_Days_Allowed'?: number | null;
     /**
-     * Notes that this group calculates copay max (based on plan configuration) by provider rather than across the entire plan.
+     * Notes that this group calculates copay max (based on plan configuration) by provider rather than across the entire plan.  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.
      * @type {boolean}
      * @memberof Groups
      */
@@ -213,13 +213,13 @@ export interface Groups {
      */
     'default_Invoice_ReportDefinition_Key'?: number | null;
     /**
-     * Process by Disability Date can be defined here to apply to all claims for this group rather than on a claim by claim basis (acts as a default).
+     * Process by Disability Date can be defined here to apply to all claims for this group rather than on a claim by claim basis (acts as a default).  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.
      * @type {boolean}
      * @memberof Groups
      */
     'default_Process_by_Disability_Date': boolean;
     /**
-     * Roll Up Waiting Period can be defined here to apply to all claims for this group rather than on a claim by claim basis (acts as a default).
+     * Roll Up Waiting Period can be defined here to apply to all claims for this group rather than on a claim by claim basis (acts as a default).  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.
      * @type {boolean}
      * @memberof Groups
      */
@@ -231,7 +231,7 @@ export interface Groups {
      */
     'disability_Pay_Through_Day'?: number | null;
     /**
-     * 
+     * This flag indicates that the Group COBRA premium will not be automatically populated during member disenrollment.  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.
      * @type {boolean}
      * @memberof Groups
      */
@@ -255,7 +255,7 @@ export interface Groups {
      */
     'distribution_Payor_ID'?: string | null;
     /**
-     * Notes if this group allows Duplicate Claims to be overridden to be paid.
+     * Notes if this group allows Duplicate Claims to be overridden to be paid.  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.
      * @type {boolean}
      * @memberof Groups
      */
@@ -333,19 +333,19 @@ export interface Groups {
      */
     'group_Account'?: number | null;
     /**
-     * No longer in use.
+     * No longer in use.  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.
      * @type {boolean}
      * @memberof Groups
      */
     'individual_Billing': boolean;
     /**
-     * No longer in use.
+     * No longer in use.  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.
      * @type {boolean}
      * @memberof Groups
      */
     'individual_Cycle': boolean;
     /**
-     * No longer in use.
+     * No longer in use.  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.
      * @type {boolean}
      * @memberof Groups
      */
@@ -393,7 +393,7 @@ export interface Groups {
      */
     'notes'?: string | null;
     /**
-     * Information field used in custom client reporting.
+     * Information field used in custom client reporting.  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.
      * @type {boolean}
      * @memberof Groups
      */
@@ -411,7 +411,7 @@ export interface Groups {
      */
     'paid_Through'?: string | null;
     /**
-     * Notes if this Group is Paperless (this overrides the individual member settings from VBAGateway). Used in process automation.
+     * Notes if this Group is Paperless (this overrides the individual member settings from VBAGateway). Used in process automation.  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.
      * @type {boolean}
      * @memberof Groups
      */
@@ -441,7 +441,7 @@ export interface Groups {
      */
     'phone_Country_Code'?: string | null;
     /**
-     * Information field used in custom client reporting.
+     * Information field used in custom client reporting.  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.
      * @type {boolean}
      * @memberof Groups
      */
@@ -459,7 +459,7 @@ export interface Groups {
      */
     'producer'?: string | null;
     /**
-     * Notes if the disability deductions should be prorated during adjudication.
+     * Notes if the disability deductions should be prorated during adjudication.  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.
      * @type {boolean}
      * @memberof Groups
      */
@@ -531,13 +531,13 @@ export interface Groups {
      */
     'renewal_Date'?: string | null;
     /**
-     * Notes if this group has Self-Admin billing.
+     * Notes if this group has Self-Admin billing.  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.
      * @type {boolean}
      * @memberof Groups
      */
     'self_Admin': boolean;
     /**
-     * Indicates if the system should calculate the Due Date on an invoice based on Billing_Due_Date settings. By default the due date is the \"Bill Thru\" on an invoice, this gives the option to change that calculation.
+     * Indicates if the system should calculate the Due Date on an invoice based on Billing_Due_Date settings. By default the due date is the \"Bill Thru\" on an invoice, this gives the option to change that calculation.  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.
      * @type {boolean}
      * @memberof Groups
      */

package/models/idcard-request.ts

@@ -21,7 +21,7 @@
  */
 export interface IDCardRequest {
     /**
-     * Key value of the ID Card request
+     * Key value of the ID Card request  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.
      * @type {number}
      * @memberof IDCardRequest
      */
@@ -33,7 +33,7 @@ export interface IDCardRequest {
      */
     'as_Of_Date'?: string | null;
     /**
-     * 
+     * Reason indicating why the ID Card Request was cancelled
      * @type {string}
      * @memberof IDCardRequest
      */
@@ -81,7 +81,7 @@ export interface IDCardRequest {
      */
     'member_Seq'?: string | null;
     /**
-     * Flag indicating the ID card request was for a renewal
+     * Flag indicating the ID card request was for a renewal  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.
      * @type {boolean}
      * @memberof IDCardRequest
      */

package/models/mem-enrollment-plan.ts

@@ -45,13 +45,13 @@ export interface MemEnrollmentPlan {
      */
     'division_ID': string;
     /**
-     * References the Subenrollment.Group_Coverage_Start value in the parent table.
+     * References the Subenrollment.Group_Coverage_Start value in the parent table.  Note: The database will apply a default value of `1/1/0001 12:00:00 AM` 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 `1/1/0001 12:00:00 AM` to meet the API requirements and ensure that the functionality occurs as expected.
      * @type {string}
      * @memberof MemEnrollmentPlan
      */
     'group_Coverage_Start': string;
     /**
-     * References the Subenrollment.Start_Date value in the parent table.
+     * References the Subenrollment.Start_Date value in the parent table.  Note: The database will apply a default value of `1/1/0001 12:00:00 AM` 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 `1/1/0001 12:00:00 AM` to meet the API requirements and ensure that the functionality occurs as expected.
      * @type {string}
      * @memberof MemEnrollmentPlan
      */
@@ -63,7 +63,7 @@ export interface MemEnrollmentPlan {
      */
     'plan_ID': string;
     /**
-     * Start date of the Plan coverage.
+     * Start date of the Plan coverage.  Note: The database will apply a default value of `1/1/0001 12:00:00 AM` 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 `1/1/0001 12:00:00 AM` to meet the API requirements and ensure that the functionality occurs as expected.
      * @type {string}
      * @memberof MemEnrollmentPlan
      */
@@ -87,31 +87,31 @@ export interface MemEnrollmentPlan {
      */
     'entry_User'?: string | null;
     /**
-     * 
+     * Member elected Daily Benefit Amount
      * @type {number}
      * @memberof MemEnrollmentPlan
      */
     'ltC_Daily_Benefit_Amount'?: number | null;
     /**
-     * 
+     * Lifetime Max Amount elected
      * @type {number}
      * @memberof MemEnrollmentPlan
      */
     'ltC_Lifetime_Max_Amount'?: number | null;
     /**
-     * 
+     * Lifetime Max Days elected
      * @type {number}
      * @memberof MemEnrollmentPlan
      */
     'ltC_Lifetime_Max_Days'?: number | null;
     /**
-     * 
+     * Lifetime Max Years elected
      * @type {number}
      * @memberof MemEnrollmentPlan
      */
     'ltC_Lifetime_Max_Years'?: number | null;
     /**
-     * 
+     * Member elected Monthly Benefit Amount
      * @type {number}
      * @memberof MemEnrollmentPlan
      */
@@ -141,7 +141,7 @@ export interface MemEnrollmentPlan {
      */
     'update_User'?: string | null;
     /**
-     * Indicates if this enrollment plan record should calculate the Dollar_Amount value through the Group leve Volume settings rather than use the value stored in Dollar_Amount.
+     * Indicates if this enrollment plan record should calculate the Dollar_Amount value through the Group leve Volume settings rather than use the value stored in Dollar_Amount.  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.
      * @type {boolean}
      * @memberof MemEnrollmentPlan
      */

package/models/mem-enrollment-rider.ts

@@ -45,13 +45,13 @@ export interface MemEnrollmentRider {
      */
     'division_ID': string;
     /**
-     * References the MemenrollmentPlan.Group_Coverage_Start value in parent table.
+     * References the MemenrollmentPlan.Group_Coverage_Start value in parent table.  Note: The database will apply a default value of `1/1/0001 12:00:00 AM` 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 `1/1/0001 12:00:00 AM` to meet the API requirements and ensure that the functionality occurs as expected.
      * @type {string}
      * @memberof MemEnrollmentRider
      */
     'group_Coverage_Start': string;
     /**
-     * References the MemenrollmentPlan.Sub_Start_Date value in parent table.
+     * References the MemenrollmentPlan.Sub_Start_Date value in parent table.  Note: The database will apply a default value of `1/1/0001 12:00:00 AM` 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 `1/1/0001 12:00:00 AM` to meet the API requirements and ensure that the functionality occurs as expected.
      * @type {string}
      * @memberof MemEnrollmentRider
      */
@@ -63,7 +63,7 @@ export interface MemEnrollmentRider {
      */
     'plan_ID': string;
     /**
-     * References the MemenrollmentPlan.Plan_Start value in parent table.
+     * References the MemenrollmentPlan.Plan_Start value in parent table.  Note: The database will apply a default value of `1/1/0001 12:00:00 AM` 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 `1/1/0001 12:00:00 AM` to meet the API requirements and ensure that the functionality occurs as expected.
      * @type {string}
      * @memberof MemEnrollmentRider
      */
@@ -75,7 +75,7 @@ export interface MemEnrollmentRider {
      */
     'benefit_Code': string;
     /**
-     * Start date of Rider coverage.
+     * Start date of Rider coverage.  Note: The database will apply a default value of `1/1/0001 12:00:00 AM` 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 `1/1/0001 12:00:00 AM` to meet the API requirements and ensure that the functionality occurs as expected.
      * @type {string}
      * @memberof MemEnrollmentRider
      */
@@ -87,7 +87,7 @@ export interface MemEnrollmentRider {
      */
     'employee_Contribution'?: number | null;
     /**
-     * Indicates if the Emploee Contribution amount entered is a Pct or flat amount.
+     * Indicates if the Emploee Contribution amount entered is a Pct or flat amount.  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.
      * @type {boolean}
      * @memberof MemEnrollmentRider
      */
@@ -111,31 +111,31 @@ export interface MemEnrollmentRider {
      */
     'external_ID'?: string | null;
     /**
-     * 
+     * Member elected Daily Benefit Amount
      * @type {number}
      * @memberof MemEnrollmentRider
      */
     'ltC_Daily_Benefit_Amount'?: number | null;
     /**
-     * 
+     * Lifetime Max Amount elected
      * @type {number}
      * @memberof MemEnrollmentRider
      */
     'ltC_Lifetime_Max_Amount'?: number | null;
     /**
-     * 
+     * Lifetime Max Days elected
      * @type {number}
      * @memberof MemEnrollmentRider
      */
     'ltC_Lifetime_Max_Days'?: number | null;
     /**
-     * 
+     * Lifetime Max Years elected
      * @type {number}
      * @memberof MemEnrollmentRider
      */
     'ltC_Lifetime_Max_Years'?: number | null;
     /**
-     * 
+     * Member elected Monthly Benefit Amount
      * @type {number}
      * @memberof MemEnrollmentRider
      */

package/models/member-beneficiary.ts

@@ -93,7 +93,7 @@ export interface MemberBeneficiary {
      */
     'entry_User'?: string | null;
     /**
-     * Indicates if interest should be excluded when adjudicating Life claims paid to this beneficiary.
+     * Indicates if interest should be excluded when adjudicating Life claims paid to this beneficiary.  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.
      * @type {boolean}
      * @memberof MemberBeneficiary
      */
@@ -147,7 +147,7 @@ export interface MemberBeneficiary {
      */
     'ssn'?: string | null;
     /**
-     * 
+     * This flag indicates if this beneficiary is secondary.
      * @type {boolean}
      * @memberof MemberBeneficiary
      */
@@ -165,7 +165,7 @@ export interface MemberBeneficiary {
      */
     'state'?: string | null;
     /**
-     * 
+     * This flag indicates if this tertiary is secondary.
      * @type {boolean}
      * @memberof MemberBeneficiary
      */

package/models/member-language.ts

@@ -39,16 +39,52 @@ export interface MemberLanguage {
      */
     'language_ID': string;
     /**
-     * Idenfities that the associated language is the Member\'s primary language.
+     * Date when the record was first added to the system.
+     * @type {string}
+     * @memberof MemberLanguage
+     */
+    'entry_Date'?: string;
+    /**
+     * User that first added the record to the system.
+     * @type {string}
+     * @memberof MemberLanguage
+     */
+    'entry_User'?: string | null;
+    /**
+     * Idenfities that the associated language is the Member\'s primary language.  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.
      * @type {boolean}
      * @memberof MemberLanguage
      */
     'primary_Language': boolean;
     /**
-     * Identifies that the associated language is the Member\'s secondary language.
+     * Identifies that the associated language is the Member\'s secondary language.  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.
      * @type {boolean}
      * @memberof MemberLanguage
      */
     'secondary_Language': boolean;
+    /**
+     * 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.
+     * @type {boolean}
+     * @memberof MemberLanguage
+     */
+    'spoken_Language': boolean;
+    /**
+     * Date when the record was last updated in the system.
+     * @type {string}
+     * @memberof MemberLanguage
+     */
+    'update_Date'?: string;
+    /**
+     * User that last updated the record in the system.
+     * @type {string}
+     * @memberof MemberLanguage
+     */
+    '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.
+     * @type {boolean}
+     * @memberof MemberLanguage
+     */
+    'written_Language': boolean;
 }
 

package/models/plan-benefit-cluster.ts

@@ -21,73 +21,73 @@
  */
 export interface PlanBenefitCluster {
     /**
-     * 
+     * Identity column for table PlanBenefitCluster  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.
      * @type {number}
      * @memberof PlanBenefitCluster
      */
     'planBenefitCluster_Key': number;
     /**
-     * 
+     * Which Benefit Code is the base code for this Plan Benefit Cluster
      * @type {string}
      * @memberof PlanBenefitCluster
      */
     'benefit_Code': string;
     /**
-     * 
+     * Date record was first added to the system
      * @type {string}
      * @memberof PlanBenefitCluster
      */
     'entry_Date'?: string;
     /**
-     * 
+     * User that first added the record to the system
      * @type {string}
      * @memberof PlanBenefitCluster
      */
     'entry_User'?: string | null;
     /**
-     * 
+     * First Multitier for the Benefit Code listed under this Plan Benefit Cluster
      * @type {string}
      * @memberof PlanBenefitCluster
      */
     'multiTier_1'?: string | null;
     /**
-     * 
+     * Second Multitier for the Benefit Code listed under this Plan Benefit Cluster
      * @type {string}
      * @memberof PlanBenefitCluster
      */
     'multiTier_2'?: string | null;
     /**
-     * 
+     * Third Multitier for the Benefit Code listed under this Plan Benefit Cluster
      * @type {string}
      * @memberof PlanBenefitCluster
      */
     'multiTier_3'?: string | null;
     /**
-     * 
+     * Fourth Multitier for the Benefit Code listed under this Plan Benefit Cluster
      * @type {string}
      * @memberof PlanBenefitCluster
      */
     'multiTier_4'?: string | null;
     /**
-     * 
+     * Fifth Multitier for the Benefit Code listed under this Plan Benefit Cluster
      * @type {string}
      * @memberof PlanBenefitCluster
      */
     'multiTier_5'?: string | null;
     /**
-     * 
+     * Which Plan this Plan Benefit Cluster belongs to
      * @type {string}
      * @memberof PlanBenefitCluster
      */
     'plan_ID': string;
     /**
-     * 
+     * Date the record was last updated in the system
      * @type {string}
      * @memberof PlanBenefitCluster
      */
     'update_Date'?: string;
     /**
-     * 
+     * User that last updated the record in the system
      * @type {string}
      * @memberof PlanBenefitCluster
      */

package/models/plan-benefit-rate.ts

@@ -21,7 +21,7 @@
  */
 export interface PlanBenefitRate {
     /**
-     * Unique idenfiter assigned to the Plan Benefit Rate.
+     * Unique idenfiter assigned to the Plan Benefit 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.
      * @type {number}
      * @memberof PlanBenefitRate
      */
@@ -33,7 +33,7 @@ export interface PlanBenefitRate {
      */
     'benefit_Code': string;
     /**
-     * Date when the Rate becomes effective.
+     * Date when the Rate becomes effective.  Note: The database will apply a default value of `1/1/0001 12:00:00 AM` 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 `1/1/0001 12:00:00 AM` to meet the API requirements and ensure that the functionality occurs as expected.
      * @type {string}
      * @memberof PlanBenefitRate
      */
@@ -57,7 +57,7 @@ export interface PlanBenefitRate {
      */
     'ex_Code'?: string | null;
     /**
-     * 
+     * Network ID associated with the Plan Benefit Rate
      * @type {string}
      * @memberof PlanBenefitRate
      */
@@ -69,7 +69,7 @@ export interface PlanBenefitRate {
      */
     'plan_ID': string;
     /**
-     * This area will allow for a limit (dollar or percentage) of how much of the allowed amount can be paid out, per claim detail line, by the specific plan benefit.
+     * This area will allow for a limit (dollar or percentage) of how much of the allowed amount can be paid out, per claim detail line, by the specific plan benefit.  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.
      * @type {number}
      * @memberof PlanBenefitRate
      */
@@ -87,7 +87,7 @@ export interface PlanBenefitRate {
      */
     'rate_Max_Type'?: string | null;
     /**
-     * Indicates whether the Rate will be a percentage or fixed amount.
+     * Indicates whether the Rate will be a percentage or fixed amount.  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.
      * @type {boolean}
      * @memberof PlanBenefitRate
      */