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

package/models/prem-rate.ts

@@ -21,11 +21,17 @@
  */
 export interface PremRate {
     /**
-     * Unique identifier for the PremRate  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 PremRate Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {number}
      * @memberof PremRate
      */
     'premRate_Key': number;
+    /**
+     * Used to identify Add On rates by Group
+     * @type {string}
+     * @memberof PremRate
+     */
+    'add_On_Grouping_ID'?: string | null;
     /**
      * Address the additional invoice is sent to
      * @type {string}
@@ -57,7 +63,7 @@ export interface PremRate {
      */
     'adjustment_Reason'?: number | null;
     /**
-     * Flag used to determine if the rate applies to Adults  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 used to determine if the rate applies to Adults Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {boolean}
      * @memberof PremRate
      */
@@ -87,25 +93,25 @@ export interface PremRate {
      */
     'age_Type_Month'?: string | null;
     /**
-     * Flag to determine if the rate applies to new Divisions  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 determine if the rate applies to new Divisions Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {boolean}
      * @memberof PremRate
      */
     'assign_To_New_Division': boolean;
     /**
-     * Flag to determine if the rate applies to new Groups  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 determine if the rate applies to new Groups Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {boolean}
      * @memberof PremRate
      */
     'assign_To_New_Group': boolean;
     /**
-     * Flag to determine if the rate applies to new Members  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 determine if the rate applies to new Members Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {boolean}
      * @memberof PremRate
      */
     'assign_To_New_Member': boolean;
     /**
-     * Flag that determines if the rate is automatically adjusted  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 that determines if the rate is automatically adjusted Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {boolean}
      * @memberof PremRate
      */
@@ -117,7 +123,7 @@ export interface PremRate {
      */
     'auto_Adjust_Reason'?: number | null;
     /**
-     * This flag indicates prevention of the retro logic from creating backout adjustments for this rate  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.
+     * This flag indicates prevention of the retro logic from creating backout adjustments for this rate Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {boolean}
      * @memberof PremRate
      */
@@ -129,7 +135,13 @@ export interface PremRate {
      */
     'benefit_Code'?: string | null;
     /**
-     * Flag used to determine if the rate applies to Children  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.
+     * This is the Billing Cycle the invoice was gerenated for.
+     * @type {string}
+     * @memberof PremRate
+     */
+    'billing_Cycle_ID'?: string | null;
+    /**
+     * Flag used to determine if the rate applies to Children Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {boolean}
      * @memberof PremRate
      */
@@ -176,6 +188,12 @@ export interface PremRate {
      * @memberof PremRate
      */
     'effective_Date'?: string | null;
+    /**
+     * Determines the logic that modifies the Effective Date of the PremRate to a date based on the enrollment of the member. Note: The database will apply a default value of `NORMAL` for this field if a value is not provided.
+     * @type {string}
+     * @memberof PremRate
+     */
+    'effective_Date_Type'?: string | null;
     /**
      * Determines if the contribution is Employee or Employer
      * @type {string}
@@ -189,7 +207,7 @@ export interface PremRate {
      */
     'employer_Contribution'?: number | null;
     /**
-     * Determines if the contribution is a percentage  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 the contribution is a percentage Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {boolean}
      * @memberof PremRate
      */
@@ -309,7 +327,7 @@ export interface PremRate {
      */
     'entry_User'?: string | null;
     /**
-     * Used to determine which records are updated when applying changes to a template  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.
+     * Used to determine which records are updated when applying changes to a template Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {boolean}
      * @memberof PremRate
      */
@@ -339,13 +357,13 @@ export interface PremRate {
      */
     'network_Type'?: string | null;
     /**
-     * Flag that determines the Age based on the date of hire  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 that determines the Age based on the date of hire Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {boolean}
      * @memberof PremRate
      */
     'new_Hire_Age': 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.
+     * This flag indicates the rate should be paid if enrolled in for even a single day during the month. Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {boolean}
      * @memberof PremRate
      */
@@ -357,7 +375,7 @@ export interface PremRate {
      */
     'parent_PremRate_Key'?: number | null;
     /**
-     * 
+     * The primary key of the payment method
      * @type {string}
      * @memberof PremRate
      */
@@ -399,7 +417,7 @@ export interface PremRate {
      */
     'premRate_Type'?: string | null;
     /**
-     * Flag that determines if the rate is prorated
+     * Flag that determines if the rate is prorated Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {boolean}
      * @memberof PremRate
      */
@@ -512,6 +530,12 @@ export interface PremRate {
      * @memberof PremRate
      */
     'term_Date'?: string | null;
+    /**
+     * Determines the logic that modifies the Term Date of the PremRate to a date based on the enrollment of the member. Note: The database will apply a default value of `NORMAL` for this field if a value is not provided.
+     * @type {string}
+     * @memberof PremRate
+     */
+    'term_Date_type'?: string | null;
     /**
      * Tier of the PremRate
      * @type {string}

package/models/procedure-category.ts

@@ -21,16 +21,40 @@
  */
 export interface ProcedureCategory {
     /**
-     * 
+     * Name of the \'Procedure Category\'.
      * @type {string}
      * @memberof ProcedureCategory
      */
     'category_ID': string;
     /**
-     * 
+     * Description of the \'Procedure Category\'.
      * @type {string}
      * @memberof ProcedureCategory
      */
     'description'?: string | null;
+    /**
+     * Date record was first added to the system
+     * @type {string}
+     * @memberof ProcedureCategory
+     */
+    'entry_Date'?: string;
+    /**
+     * User that first added the record to the system
+     * @type {string}
+     * @memberof ProcedureCategory
+     */
+    'entry_User'?: string | null;
+    /**
+     * Date the record was last updated in the system
+     * @type {string}
+     * @memberof ProcedureCategory
+     */
+    'update_Date'?: string;
+    /**
+     * User that last updated the record in the system
+     * @type {string}
+     * @memberof ProcedureCategory
+     */
+    'update_User'?: string | null;
 }
 

package/models/procedure-code.ts

@@ -33,7 +33,7 @@ export interface ProcedureCode {
      */
     'age_Range_Type'?: string | null;
     /**
-     * Indicates that the associated procedure is limited to a certain age range.
+     * Indicates that the associated procedure is limited to a certain age range. Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {boolean}
      * @memberof ProcedureCode
      */
@@ -62,6 +62,18 @@ export interface ProcedureCode {
      * @memberof ProcedureCode
      */
     'effective_Date'?: string | null;
+    /**
+     * Date record was first added to the system
+     * @type {string}
+     * @memberof ProcedureCode
+     */
+    'entry_Date'?: string;
+    /**
+     * User that first added the record to the system
+     * @type {string}
+     * @memberof ProcedureCode
+     */
+    'entry_User'?: string | null;
     /**
      * Identifies the starting age for the acceptable age range for the associated procedure code.
      * @type {number}
@@ -111,7 +123,7 @@ export interface ProcedureCode {
      */
     'qualifier'?: string | null;
     /**
-     * Indicates that an auth will be required when the associated procedure is used within a claim.
+     * Indicates that an auth will be required when the associated procedure is used within a claim. Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {boolean}
      * @memberof ProcedureCode
      */
@@ -140,5 +152,17 @@ export interface ProcedureCode {
      * @memberof ProcedureCode
      */
     'ucR_Price'?: number | null;
+    /**
+     * Date the record was last updated in the system
+     * @type {string}
+     * @memberof ProcedureCode
+     */
+    'update_Date'?: string;
+    /**
+     * User that last updated the record in the system
+     * @type {string}
+     * @memberof ProcedureCode
+     */
+    'update_User'?: string | null;
 }
 

package/models/procedure-group.ts

@@ -21,7 +21,7 @@
  */
 export interface ProcedureGroup {
     /**
-     * Name for the \'Procedure Group\'.
+     * Name for the \'Procedure Group\'. Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {number}
      * @memberof ProcedureGroup
      */
@@ -32,5 +32,29 @@ export interface ProcedureGroup {
      * @memberof ProcedureGroup
      */
     'description'?: string | null;
+    /**
+     * Date record was first added to the system
+     * @type {string}
+     * @memberof ProcedureGroup
+     */
+    'entry_Date'?: string;
+    /**
+     * User that first added the record to the system
+     * @type {string}
+     * @memberof ProcedureGroup
+     */
+    'entry_User'?: string | null;
+    /**
+     * Date the record was last updated in the system
+     * @type {string}
+     * @memberof ProcedureGroup
+     */
+    'update_Date'?: string;
+    /**
+     * User that last updated the record in the system
+     * @type {string}
+     * @memberof ProcedureGroup
+     */
+    'update_User'?: string | null;
 }
 

package/models/provider-account.ts

@@ -21,13 +21,13 @@
  */
 export interface ProviderAccount {
     /**
-     * Unique identifier for each account record.
+     * Unique identifier for each account record. Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {number}
      * @memberof ProviderAccount
      */
     'providerAccount_Key': number;
     /**
-     * References the FundingAccount.Account_Key record for account details.
+     * References the FundingAccount.Account_Key record for account details. Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {number}
      * @memberof ProviderAccount
      */
@@ -38,6 +38,18 @@ export interface ProviderAccount {
      * @memberof ProviderAccount
      */
     'effective_Date'?: string | null;
+    /**
+     * Date when the record was first added to the system.
+     * @type {string}
+     * @memberof ProviderAccount
+     */
+    'entry_Date'?: string;
+    /**
+     * User that first added the record to the system.
+     * @type {string}
+     * @memberof ProviderAccount
+     */
+    'entry_User'?: string | null;
     /**
      * Unique idenfitier assigned to the Proivider record.
      * @type {string}
@@ -51,7 +63,19 @@ export interface ProviderAccount {
      */
     'term_Date'?: string | null;
     /**
-     * Indicates if this account accepts wire transfers.
+     * Date when the record was last updated in the system.
+     * @type {string}
+     * @memberof ProviderAccount
+     */
+    'update_Date'?: string;
+    /**
+     * User that last updated the record in the system.
+     * @type {string}
+     * @memberof ProviderAccount
+     */
+    'update_User'?: string | null;
+    /**
+     * Indicates if this account accepts wire transfers. Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {boolean}
      * @memberof ProviderAccount
      */

package/models/provider-affiliation.ts

@@ -33,16 +33,40 @@ export interface ProviderAffiliation {
      */
     'affiliation_Provider_ID': string;
     /**
-     * Date when the Affiliate Provider status becomes/became effective.
+     * Date when the Affiliate Provider status becomes/became effective. Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {string}
      * @memberof ProviderAffiliation
      */
     'effective_Date': string;
+    /**
+     * User that first added the record to the system.
+     * @type {string}
+     * @memberof ProviderAffiliation
+     */
+    'entry_Date'?: string;
+    /**
+     * Date when the record was first added to the system.
+     * @type {string}
+     * @memberof ProviderAffiliation
+     */
+    'entry_User'?: string | null;
     /**
      * Date when the Affiliate Provider status expires/expired.
      * @type {string}
      * @memberof ProviderAffiliation
      */
     'term_Date'?: string | null;
+    /**
+     * User that last updated the record in the system.
+     * @type {string}
+     * @memberof ProviderAffiliation
+     */
+    'update_Date'?: string;
+    /**
+     * Date when the record was last updated in the system.
+     * @type {string}
+     * @memberof ProviderAffiliation
+     */
+    'update_User'?: string | null;
 }
 

package/models/provider-alternate.ts

@@ -33,16 +33,40 @@ export interface ProviderAlternate {
      */
     'alternate_Provider_ID': string;
     /**
-     * Date when the Alternate Provider status becomes/became effective.
+     * Date when the Alternate Provider status becomes/became effective. Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {string}
      * @memberof ProviderAlternate
      */
     'effective_Date': string;
+    /**
+     * Date when the record was first added to the system.
+     * @type {string}
+     * @memberof ProviderAlternate
+     */
+    'entry_Date'?: string;
+    /**
+     * User that first added the record to the system.
+     * @type {string}
+     * @memberof ProviderAlternate
+     */
+    'entry_User'?: string | null;
     /**
      * Date when the Alternate Provider status expires/expired.
      * @type {string}
      * @memberof ProviderAlternate
      */
     'term_Date'?: string | null;
+    /**
+     * Date when the record was last updated in the system.
+     * @type {string}
+     * @memberof ProviderAlternate
+     */
+    'update_Date'?: string;
+    /**
+     * User that last updated the record in the system.
+     * @type {string}
+     * @memberof ProviderAlternate
+     */
+    'update_User'?: string | null;
 }
 

package/models/provider-apc.ts

@@ -21,7 +21,7 @@
  */
 export interface ProviderAPC {
     /**
-     * Unique identifier assigned to each APC configuration record.
+     * Unique identifier assigned to each APC configuration record. Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {number}
      * @memberof ProviderAPC
      */
@@ -39,7 +39,7 @@ export interface ProviderAPC {
      */
     'apC_Schedule'?: string | null;
     /**
-     * Indicates whether the rate will be applied to Out of Network claims.
+     * Indicates whether the rate will be applied to Out of Network claims. Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {boolean}
      * @memberof ProviderAPC
      */
@@ -51,11 +51,23 @@ export interface ProviderAPC {
      */
     'cost_To_Charge'?: number | null;
     /**
-     * Start of the range of acceptable service dates for the modifier.
+     * Start of the range of acceptable service dates for the modifier. Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {string}
      * @memberof ProviderAPC
      */
     'effective_Date': string;
+    /**
+     * Date when the record was first added to the system.
+     * @type {string}
+     * @memberof ProviderAPC
+     */
+    'entry_Date'?: string;
+    /**
+     * User that first added the record to the system.
+     * @type {string}
+     * @memberof ProviderAPC
+     */
+    'entry_User'?: string | null;
     /**
      * Ex code associated with the price line.
      * @type {string}
@@ -92,6 +104,18 @@ export interface ProviderAPC {
      * @memberof ProviderAPC
      */
     'trim_Point'?: number | null;
+    /**
+     * Date when the record was last updated in the system.
+     * @type {string}
+     * @memberof ProviderAPC
+     */
+    'update_Date'?: string;
+    /**
+     * User that last updated the record in the system.
+     * @type {string}
+     * @memberof ProviderAPC
+     */
+    'update_User'?: string | null;
     /**
      * Variable cost factor used for APC calculations.
      * @type {number}

package/models/provider-benefit-admin.ts

@@ -33,7 +33,7 @@ export interface ProviderBenefitAdmin {
      */
     'benefit_Code': string;
     /**
-     * Start of the range of acceptable service dates for the admin fee.
+     * Start of the range of acceptable service dates for the admin fee. Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {string}
      * @memberof ProviderBenefitAdmin
      */
@@ -51,11 +51,23 @@ export interface ProviderBenefitAdmin {
      */
     'admin_Fee'?: number | null;
     /**
-     * Indicates that the associated fee is percentage based.
+     * Indicates that the associated fee is percentage based. Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {boolean}
      * @memberof ProviderBenefitAdmin
      */
     'admin_Pct': boolean;
+    /**
+     * Date when the record was first added to the system.
+     * @type {string}
+     * @memberof ProviderBenefitAdmin
+     */
+    'entry_Date'?: string;
+    /**
+     * User that first added the record to the system.
+     * @type {string}
+     * @memberof ProviderBenefitAdmin
+     */
+    'entry_User'?: string | null;
     /**
      * This field is currently informational only.
      * @type {string}
@@ -68,5 +80,17 @@ export interface ProviderBenefitAdmin {
      * @memberof ProviderBenefitAdmin
      */
     'term_Date'?: string | null;
+    /**
+     * Date when the record was last updated in the system.
+     * @type {string}
+     * @memberof ProviderBenefitAdmin
+     */
+    'update_Date'?: string;
+    /**
+     * User that last updated the record in the system.
+     * @type {string}
+     * @memberof ProviderBenefitAdmin
+     */
+    'update_User'?: string | null;
 }
 

package/models/provider-cred-amount.ts

@@ -21,13 +21,13 @@
  */
 export interface ProviderCredAmount {
     /**
-     * Associates these custom amount values with the credentialing process (ProviderCred.ProviderCred_Key)
+     * Associates these custom amount values with the credentialing process (ProviderCred.ProviderCred_Key) Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {number}
      * @memberof ProviderCredAmount
      */
     'providerCred_Key': number;
     /**
-     * The type associated with the credentialing amount.
+     * The type associated with the credentialing amount. Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {number}
      * @memberof ProviderCredAmount
      */
@@ -39,10 +39,34 @@ export interface ProviderCredAmount {
      */
     'amount'?: number | null;
     /**
-     * This indicates that the associated amount represents a percentage.
+     * This indicates that the associated amount represents a percentage. Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {boolean}
      * @memberof ProviderCredAmount
      */
     'amount_Pct': boolean;
+    /**
+     * Date when the record was first added to the system.
+     * @type {string}
+     * @memberof ProviderCredAmount
+     */
+    'entry_Date'?: string;
+    /**
+     * User that first added the record to the system.
+     * @type {string}
+     * @memberof ProviderCredAmount
+     */
+    'entry_User'?: string | null;
+    /**
+     * Date when the record was last updated in the system.
+     * @type {string}
+     * @memberof ProviderCredAmount
+     */
+    'update_Date'?: string;
+    /**
+     * User that last updated the record in the system.
+     * @type {string}
+     * @memberof ProviderCredAmount
+     */
+    'update_User'?: string | null;
 }
 

package/models/provider-cred-attestation.ts

@@ -21,7 +21,7 @@
  */
 export interface ProviderCredAttestation {
     /**
-     * Unique identifier for each attestation question.
+     * Unique identifier for each attestation question. Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {number}
      * @memberof ProviderCredAttestation
      */
@@ -57,7 +57,7 @@ export interface ProviderCredAttestation {
      */
     'credAttestationMethod_Key'?: number | null;
     /**
-     * Allows the User to select a question from the available attestation questions.
+     * Allows the User to select a question from the available attestation questions. Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {number}
      * @memberof ProviderCredAttestation
      */
@@ -75,7 +75,19 @@ export interface ProviderCredAttestation {
      */
     'credAttestationType_Key'?: number | null;
     /**
-     * Associates these custom question values with the credentialing process (ProviderCred.ProviderCred_Key)
+     * User that first added the record to the system.
+     * @type {string}
+     * @memberof ProviderCredAttestation
+     */
+    'entry_Date'?: string;
+    /**
+     * Date when the record was first added to the system.
+     * @type {string}
+     * @memberof ProviderCredAttestation
+     */
+    'entry_User'?: string | null;
+    /**
+     * Associates these custom question values with the credentialing process (ProviderCred.ProviderCred_Key) Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {number}
      * @memberof ProviderCredAttestation
      */
@@ -86,5 +98,17 @@ export interface ProviderCredAttestation {
      * @memberof ProviderCredAttestation
      */
     'question_Date'?: string | null;
+    /**
+     * User that last updated the record in the system.
+     * @type {string}
+     * @memberof ProviderCredAttestation
+     */
+    'update_Date'?: string;
+    /**
+     * Date when the record was last updated in the system.
+     * @type {string}
+     * @memberof ProviderCredAttestation
+     */
+    'update_User'?: string | null;
 }