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

package/models/claim-batch-detail.ts

@@ -21,841 +21,853 @@
  */
 export interface ClaimBatchDetail {
     /**
-     * 
+     * References the ClaimBatch.Batch_Number value on the parent record.  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 ClaimBatchDetail
      */
     'batch_Number': number;
     /**
-     * 
+     * References the ClaimBatch.Batch_Claim value on the parent record.  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 ClaimBatchDetail
      */
     'batch_Claim': number;
     /**
-     * 
+     * In combination with Adjustment_Seq, creates a unique sequence for each service line on this claim.
      * @type {string}
      * @memberof ClaimBatchDetail
      */
     'claim_Seq': string;
     /**
-     * 
+     * In combination with Claim_Seq, creates a unique sequence for each service line on this claim. Used to note adjustments, cascading, etc. when utlized.
      * @type {string}
      * @memberof ClaimBatchDetail
      */
     'adjustment_Seq': string;
     /**
-     * 
+     * No longer in use.
      * @type {string}
      * @memberof ClaimBatchDetail
      */
     'ansI_Code'?: string | null;
     /**
-     * 
+     * The APC code applied to this service if identified for calculation during adjudication.
      * @type {string}
      * @memberof ClaimBatchDetail
      */
     'apC_Code'?: string | null;
     /**
-     * 
+     * For reference purposes, this hold the individual service line funding payor/account. If multiple payor/accounts are found on different service lines for the same claim, adjudication spits out an error.
      * @type {number}
      * @memberof ClaimBatchDetail
      */
     'account_Key'?: number | null;
     /**
-     * 
+     * References the Adjustment_Seq value on the original claim that this claim is adjusting.
      * @type {string}
      * @memberof ClaimBatchDetail
      */
     'adjusted_From_Adjustment_Line'?: string | null;
     /**
-     * 
+     * References the Claim_Seq value on the original claim that this claim is adjusting.
      * @type {string}
      * @memberof ClaimBatchDetail
      */
     'adjusted_From_Line'?: string | null;
     /**
-     * 
+     * The Auth Number for services that require authorization. References Auth.Auth_Number.
      * @type {string}
      * @memberof ClaimBatchDetail
      */
     'auth_Number'?: string | null;
     /**
-     * 
+     * If an Auth Penalty is applied during adjudication, that is housed here.
      * @type {number}
      * @memberof ClaimBatchDetail
      */
     'auth_Penalty'?: number | null;
     /**
-     * 
+     * Notes that this service lines required authorization.
      * @type {string}
      * @memberof ClaimBatchDetail
      */
     'auth_Required'?: string | null;
     /**
-     * 
+     * This is the benefit code assigned to this service line based on the Plan assigned on the Claim header. References BenefitCodes.Benefit_Code.
      * @type {string}
      * @memberof ClaimBatchDetail
      */
     'benefit_Code'?: string | null;
     /**
-     * 
+     * Benefit Rate being applied to this detail line.
+     * @type {number}
+     * @memberof ClaimBatchDetail
+     */
+    'benefit_Rate_Applied'?: number | null;
+    /**
+     * The billed charges assigned by the provider for this service.  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 ClaimBatchDetail
      */
     'billed_Price': number;
     /**
-     * 
+     * Pharmacy claim information submitted via file submission and used in reporting and interfaces.
      * @type {string}
      * @memberof ClaimBatchDetail
      */
     'brand_Indicator'?: string | null;
     /**
-     * 
+     * For dental claims, notes if this surface had services rendered.  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 ClaimBatchDetail
      */
     'buccal': boolean;
     /**
-     * 
+     * No longer in use.
      * @type {string}
      * @memberof ClaimBatchDetail
      */
     'cliA_Number'?: string | null;
     /**
-     * 
+     * Holds the Other Insurance calculated amount that would affect the payable amount for this service (calculated from COB_Hold, COB_Mem_Resp, COB_Savings, and COB_Savings_Used).  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 ClaimBatchDetail
      */
     'coB_Amt': number;
     /**
-     * 
+     * Used in COB calculations (Dupe or Non-Dupe) to determine the COB_Amt to be applied.
      * @type {number}
      * @memberof ClaimBatchDetail
      */
     'coB_Hold'?: number | null;
     /**
-     * 
+     * Used in COB calculations (Dupe or Non-Dupe) to determine the COB_Amt to be applied.
      * @type {number}
      * @memberof ClaimBatchDetail
      */
     'coB_Mem_Resp'?: number | null;
     /**
-     * 
+     * Used in COB calculations (Dupe or Non-Dupe) to determine the COB_Amt to be applied.
      * @type {number}
      * @memberof ClaimBatchDetail
      */
     'coB_Savings'?: number | null;
     /**
-     * 
+     * Used in COB calculations (Dupe or Non-Dupe) to determine the COB_Amt to be applied.
      * @type {number}
      * @memberof ClaimBatchDetail
      */
     'coB_Savings_Used'?: number | null;
     /**
-     * 
+     * Used for Flex Claims to indicate the calendar year this claim applies.
      * @type {string}
      * @memberof ClaimBatchDetail
      */
     'calendar_Year'?: string | null;
     /**
-     * 
+     * Notes if this service line is captiated. If the Claim.Capitation_Claim value is flagged, it overrides this value and notes the entire claim and all service lines as capitated.  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 ClaimBatchDetail
      */
     'capitation_Claim': boolean;
     /**
-     * 
+     * No longer in use.
      * @type {number}
      * @memberof ClaimBatchDetail
      */
     'check_ID'?: number | null;
     /**
-     * 
+     * The co-insurance amount applied by adjudication based on benefit definition.  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 ClaimBatchDetail
      */
     'co_Ins_Amt': number;
     /**
-     * 
+     * The co-pay amount applied by adjudication based on benefit definition.  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 ClaimBatchDetail
      */
     'co_Pay_Amt': number;
     /**
-     * 
+     * For currency calculations, this holds the destination currency.
      * @type {string}
      * @memberof ClaimBatchDetail
      */
     'currency_ID'?: string | null;
     /**
-     * 
+     * Pharmacy claim information submitted via file submission and used in reporting and interfaces.
      * @type {number}
      * @memberof ClaimBatchDetail
      */
     'days_Supply'?: number | null;
     /**
-     * 
+     * If the service is eligiblity for deductible credits, they would be stored here.
      * @type {number}
      * @memberof ClaimBatchDetail
      */
     'ded_Credit_Amt'?: number | null;
     /**
-     * 
+     * The deductible amount applied by adjudication based on benefit definition.  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 ClaimBatchDetail
      */
     'deductible_Amt': number;
     /**
-     * 
+     * The diagnosis pointer for this service line indicating which Diagnostic Codes from the Claim are applicable to this service.
      * @type {string}
      * @memberof ClaimBatchDetail
      */
     'diagnosis_Code'?: string | null;
     /**
-     * 
+     * The difference between Billed and Allowed is stored as the Discount Amount.  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 ClaimBatchDetail
      */
     'discount_Amt': number;
     /**
-     * 
+     * Pharmacy claim information submitted via file submission and used in reporting and interfaces.
      * @type {number}
      * @memberof ClaimBatchDetail
      */
     'dispense_As_Written'?: number | null;
     /**
-     * 
+     * For dental claims, notes if this surface had services rendered.  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 ClaimBatchDetail
      */
     'distal': boolean;
     /**
-     * 
+     * For RX claims or medical claims that hold a drug code. References DrugCode.Drug_Code.
      * @type {string}
      * @memberof ClaimBatchDetail
      */
     'drug_Code'?: string | null;
     /**
-     * 
+     * Pharmacy claim information submitted via file submission and used in reporting and interfaces.
      * @type {number}
      * @memberof ClaimBatchDetail
      */
     'drug_Quantity'?: number | null;
     /**
-     * 
+     * Date when the record was first added to the system.
      * @type {string}
      * @memberof ClaimBatchDetail
      */
     'entry_Date'?: string;
     /**
-     * 
+     * User that first added the record to the system.
      * @type {string}
      * @memberof ClaimBatchDetail
      */
     'entry_User'?: string | null;
     /**
-     * 
+     * During adjudication, this holds the results of claim rules associated with this error code. For a list of valid Error Codes, check the ErrorCategoryType table.
      * @type {string}
      * @memberof ClaimBatchDetail
      */
     'error_Auth'?: string | null;
     /**
-     * 
+     * During adjudication, this holds the results of claim rules associated with this error code. For a list of valid Error Codes, check the ErrorCategoryType table.
      * @type {string}
      * @memberof ClaimBatchDetail
      */
     'error_Benefit'?: string | null;
     /**
-     * 
+     * During adjudication, this holds the results of claim rules associated with this error code. For a list of valid Error Codes, check the ErrorCategoryType table.
      * @type {string}
      * @memberof ClaimBatchDetail
      */
     'error_Count'?: string | null;
     /**
-     * 
+     * During adjudication, this holds the results of claim rules associated with this error code. For a list of valid Error Codes, check the ErrorCategoryType table.
      * @type {string}
      * @memberof ClaimBatchDetail
      */
     'error_Covered'?: string | null;
     /**
-     * 
+     * During adjudication, this holds the results of claim rules associated with this error code. For a list of valid Error Codes, check the ErrorCategoryType table.
      * @type {string}
      * @memberof ClaimBatchDetail
      */
     'error_Dates'?: string | null;
     /**
-     * 
+     * During adjudication, this holds the results of claim rules associated with this error code. For a list of valid Error Codes, check the ErrorCategoryType table.
      * @type {string}
      * @memberof ClaimBatchDetail
      */
     'error_Diagnosis'?: string | null;
     /**
-     * 
+     * During adjudication, this holds the results of claim rules associated with this error code. For a list of valid Error Codes, check the ErrorCategoryType table.
      * @type {string}
      * @memberof ClaimBatchDetail
      */
     'error_ExCode'?: string | null;
     /**
-     * 
+     * During adjudication, this holds the results of claim rules associated with this error code. For a list of valid Error Codes, check the ErrorCategoryType table.
      * @type {string}
      * @memberof ClaimBatchDetail
      */
     'error_Modifier'?: string | null;
     /**
-     * 
+     * During adjudication, this holds the results of claim rules associated with this error code. For a list of valid Error Codes, check the ErrorCategoryType table.
      * @type {string}
      * @memberof ClaimBatchDetail
      */
     'error_Place'?: string | null;
     /**
-     * 
+     * During adjudication, this holds the results of claim rules associated with this error code. For a list of valid Error Codes, check the ErrorCategoryType table.
      * @type {string}
      * @memberof ClaimBatchDetail
      */
     'error_Price'?: string | null;
     /**
-     * 
+     * During adjudication, this holds the results of claim rules associated with this error code. For a list of valid Error Codes, check the ErrorCategoryType table.
      * @type {string}
      * @memberof ClaimBatchDetail
      */
     'error_Procedure'?: string | null;
     /**
-     * 
+     * A place for both user assigned reason codes applicable to this claim or for adjudication to automatically assign ex code. References ExplanationCodes.Ex_Code.
      * @type {string}
      * @memberof ClaimBatchDetail
      */
     'ex_Code'?: string | null;
     /**
-     * 
+     * A place for both user assigned reason codes applicable to this claim or for adjudication to automatically assign ex code. References ExplanationCodes.Ex_Code.
      * @type {string}
      * @memberof ClaimBatchDetail
      */
     'ex_Code2'?: string | null;
     /**
-     * 
+     * A place for both user assigned reason codes applicable to this claim or for adjudication to automatically assign ex code. References ExplanationCodes.Ex_Code.
      * @type {string}
      * @memberof ClaimBatchDetail
      */
     'ex_Code3'?: string | null;
     /**
-     * 
+     * The FICA tax amount for disability claims.  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 ClaimBatchDetail
      */
     'fica': number;
     /**
-     * 
+     * For dental claims, notes if this surface had services rendered.  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 ClaimBatchDetail
      */
     'facial': boolean;
     /**
-     * 
+     * Based on taxable amount and various configurations, this holds the Federal \"To Tax\" amount for disability claim.
      * @type {number}
      * @memberof ClaimBatchDetail
      */
     'federal_Amount_To_Tax'?: number | null;
     /**
-     * 
+     * The calculated Federal tax amount based on the \"To Tax\" amount.  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 ClaimBatchDetail
      */
     'federal_Tax': number;
     /**
-     * 
+     * A flat federal tax amount applied in addition to the calculated tax amount.
      * @type {number}
      * @memberof ClaimBatchDetail
      */
     'federal_Tax_Flat'?: number | null;
     /**
-     * 
+     * Pharmacy claim information submitted via file submission and used in reporting and interfaces.
      * @type {string}
      * @memberof ClaimBatchDetail
      */
     'fill_Date'?: string | null;
     /**
-     * 
+     * Manually entered description of this flex claim.
      * @type {string}
      * @memberof ClaimBatchDetail
      */
     'flex_Description'?: string | null;
     /**
-     * 
+     * Pharmacy claim information submitted via file submission and used in reporting and interfaces.
      * @type {string}
      * @memberof ClaimBatchDetail
      */
     'formulary_Indicator'?: string | null;
     /**
-     * 
+     * For dental claims, notes if this surface had services rendered.  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 ClaimBatchDetail
      */
     'incisal': boolean;
     /**
-     * 
+     * If interest is calculated on a claim, it is stored here and applied to payable amount.  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 ClaimBatchDetail
      */
     'interest': number;
     /**
-     * 
+     * For dental claims, notes if this surface had services rendered.  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 ClaimBatchDetail
      */
     'labial': boolean;
     /**
-     * 
+     * The Life Benefit to be applied for Life claims processing.
      * @type {string}
      * @memberof ClaimBatchDetail
      */
     'life_Benefit'?: string | null;
     /**
-     * 
+     * The Life Benefit calculated volume based on benefit definition.
      * @type {number}
      * @memberof ClaimBatchDetail
      */
     'life_Benefit_Volume'?: number | null;
     /**
-     * 
+     * Number added manually to claims and from 837 files and sent outbound on 835 files.
      * @type {string}
      * @memberof ClaimBatchDetail
      */
     'line_Control_Number'?: string | null;
     /**
-     * 
+     * For dental claims, notes if this surface had services rendered.  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 ClaimBatchDetail
      */
     'lingual': boolean;
     /**
-     * 
+     * If a locality tax is applicable it would be housed here.
      * @type {number}
      * @memberof ClaimBatchDetail
      */
     'local_Tax'?: number | null;
     /**
-     * 
+     * Pharmacy claim information submitted via file submission and used in reporting and interfaces.
      * @type {string}
      * @memberof ClaimBatchDetail
      */
     'mail_Order_Indicator'?: string | null;
     /**
-     * 
+     * Based on taxable amount and various configurations, this holds the Medicare \"To Tax\" amount for disability claim.
      * @type {number}
      * @memberof ClaimBatchDetail
      */
     'medicare_Amount_To_Tax'?: number | null;
     /**
-     * 
+     * The calculated Medicare tax amount based on the \"To Tax\" amount.
      * @type {number}
      * @memberof ClaimBatchDetail
      */
     'medicare_Tax'?: number | null;
     /**
-     * 
+     * For dental claims, notes if this surface had services rendered.  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 ClaimBatchDetail
      */
     'mesial': boolean;
     /**
-     * 
+     * This is for anesthesia, each Unit of anesthesia is equal to a specific amount of Minutes.
      * @type {number}
      * @memberof ClaimBatchDetail
      */
     'minutes_Per_Unit'?: number | null;
     /**
-     * 
+     * The modifier applied to this service.
      * @type {string}
      * @memberof ClaimBatchDetail
      */
     'modifier'?: string | null;
     /**
-     * 
+     * The modifier applied to this service.
      * @type {string}
      * @memberof ClaimBatchDetail
      */
     'modifier_2'?: string | null;
     /**
-     * 
+     * The modifier applied to this service.
      * @type {string}
      * @memberof ClaimBatchDetail
      */
     'modifier_3'?: string | null;
     /**
-     * 
+     * The modifier applied to this service.
      * @type {string}
      * @memberof ClaimBatchDetail
      */
     'modifier_4'?: string | null;
     /**
-     * 
+     * The number of the units from this detail line that comes from the Modifier. This determines pricing for the line.
      * @type {number}
      * @memberof ClaimBatchDetail
      */
     'modifier_Units'?: number | null;
     /**
-     * 
+     * For not covered services, or partially not covered services, this reflects that deduction.  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 ClaimBatchDetail
      */
     'not_Covered_Amt': number;
     /**
-     * 
+     * For dental claims, notes if this surface had services rendered.  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 ClaimBatchDetail
      */
     'occlusal': boolean;
     /**
-     * 
+     * For dental claims this holds the oral cavity designation sent on the 837D.
      * @type {string}
      * @memberof ClaimBatchDetail
      */
     'oral_Cavity_Designation_Code_1'?: string | null;
     /**
-     * 
+     * For dental claims this holds the oral cavity designation sent on the 837D.
      * @type {string}
      * @memberof ClaimBatchDetail
      */
     'oral_Cavity_Designation_Code_2'?: string | null;
     /**
-     * 
+     * For dental claims this holds the oral cavity designation sent on the 837D.
      * @type {string}
      * @memberof ClaimBatchDetail
      */
     'oral_Cavity_Designation_Code_3'?: string | null;
     /**
-     * 
+     * For dental claims this holds the oral cavity designation sent on the 837D.
      * @type {string}
      * @memberof ClaimBatchDetail
      */
     'oral_Cavity_Designation_Code_4'?: string | null;
     /**
-     * 
+     * For dental claims this holds the oral cavity designation sent on the 837D.
      * @type {string}
      * @memberof ClaimBatchDetail
      */
     'oral_Cavity_Designation_Code_5'?: string | null;
     /**
-     * 
+     * Pharmacy claim information submitted via file submission and used in reporting and interfaces.
      * @type {number}
      * @memberof ClaimBatchDetail
      */
     'other_Deduction_Amount'?: number | 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 ClaimBatchDetail
+     */
+    'override_Benefit_Code': boolean;
+    /**
+     * Notes that the associated amount field was manually overrided by an application user or automated process that would skip adjudication calculations for this 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 ClaimBatchDetail
      */
     'override_COB_Amt': boolean;
     /**
-     * 
+     * Notes that the associated amount field was manually overrided by an application user or automated process that would skip adjudication calculations for this 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 ClaimBatchDetail
      */
     'override_Co_Ins_Amt': boolean;
     /**
-     * 
+     * Notes that the associated amount field was manually overrided by an application user or automated process that would skip adjudication calculations for this 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 ClaimBatchDetail
      */
     'override_Co_Pay_Amt': boolean;
     /**
-     * 
+     * Notes that the associated amount field was manually overrided by an application user or automated process that would skip adjudication calculations for this 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 ClaimBatchDetail
      */
     'override_Ded_Credit_Amt': boolean;
     /**
-     * 
+     * Notes that the associated amount field was manually overrided by an application user or automated process that would skip adjudication calculations for this 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 ClaimBatchDetail
      */
     'override_Deductible_Amt': boolean;
     /**
-     * 
+     * Notes that the associated amount field was manually overrided by an application user or automated process that would skip adjudication calculations for this 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 ClaimBatchDetail
      */
     'override_Federal_Tax': boolean;
     /**
-     * 
+     * Notes that the associated amount field was manually overrided by an application user or automated process that would skip adjudication calculations for this 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 ClaimBatchDetail
      */
     'override_Local_Tax': boolean;
     /**
-     * 
+     * Notes that the associated amount field was manually overrided by an application user or automated process that would skip adjudication calculations for this 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 ClaimBatchDetail
      */
     'override_Medicare_Tax': boolean;
     /**
-     * 
+     * Notes that the associated amount field was manually overrided by an application user or automated process that would skip adjudication calculations for this 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 ClaimBatchDetail
      */
     'override_Not_Covered_Amt': boolean;
     /**
-     * 
+     * Notes that the associated amount field was manually overrided by an application user or automated process that would skip adjudication calculations for this 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 ClaimBatchDetail
      */
     'override_Plan_Price': boolean;
     /**
-     * 
+     * Notes that the associated amount field was manually overrided by an application user or automated process that would skip adjudication calculations for this 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 ClaimBatchDetail
      */
     'override_Social_Security': boolean;
     /**
-     * 
+     * Notes that the associated amount field was manually overrided by an application user or automated process that would skip adjudication calculations for this 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 ClaimBatchDetail
      */
     'override_State_Tax': boolean;
     /**
-     * 
+     * Notes that the associated amount field was manually overrided by an application user or automated process that would skip adjudication calculations for this 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 ClaimBatchDetail
      */
     'override_With_Hold_Amt': boolean;
     /**
-     * 
+     * Information field used in custom processing and reporting.
      * @type {number}
      * @memberof ClaimBatchDetail
      */
     'ppO_Price_Plan_Price_Diff'?: number | null;
     /**
-     * 
+     * The final paid amount for this service line based on allowed amount (Plan_Price) minus all applicable deductions.  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 ClaimBatchDetail
      */
     'paid_Amt': number;
     /**
-     * 
+     * The partial loss amount for disability claims.  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 ClaimBatchDetail
      */
     'partial_Loss': number;
     /**
-     * 
+     * For reference purposes, this hold the individual service line funding payor/account. If multiple payor/accounts are found on different service lines for the same claim, adjudication spits out an error.
      * @type {string}
      * @memberof ClaimBatchDetail
      */
     'payor_ID'?: string | null;
     /**
-     * 
+     * Pharmacy claim information submitted via file submission and used in reporting and interfaces.
      * @type {string}
      * @memberof ClaimBatchDetail
      */
     'pharmacy_Name'?: string | null;
     /**
-     * 
+     * The place of service for the services being rendered on this service line.
      * @type {string}
      * @memberof ClaimBatchDetail
      */
     'place_Of_Service'?: string | null;
     /**
-     * 
+     * The allowed amount for this service based on fee schedule, pricing, repricing, etc.  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 ClaimBatchDetail
      */
     'plan_Price': number;
     /**
-     * 
+     * The premium deduction amount for disability claims.  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 ClaimBatchDetail
      */
     'premium_Deduction': number;
     /**
-     * 
+     * Pharmacy claim information submitted via file submission and used in reporting and interfaces.
      * @type {string}
      * @memberof ClaimBatchDetail
      */
     'prescriber_ID'?: string | null;
     /**
-     * 
+     * Pharmacy claim information submitted via file submission and used in reporting and interfaces.
      * @type {string}
      * @memberof ClaimBatchDetail
      */
     'prescription_Date'?: string | null;
     /**
-     * 
+     * Pharmacy claim information submitted via file submission and used in reporting and interfaces.
      * @type {string}
      * @memberof ClaimBatchDetail
      */
     'prescription_Number'?: string | null;
     /**
-     * 
+     * For reprice claims (typically submitted via 837), this notes the reprice method used to reprice this service line.
      * @type {string}
      * @memberof ClaimBatchDetail
      */
     'pricing_Method'?: string | null;
     /**
-     * 
+     * The rate associated with the reprice method (Pricing_Method).
      * @type {number}
      * @memberof ClaimBatchDetail
      */
     'pricing_Rate'?: number | null;
     /**
-     * 
+     * For life claims, this holds the principal amount for reporting.  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 ClaimBatchDetail
      */
     'principal': number;
     /**
-     * 
+     * The service being rendered on this claim.
      * @type {string}
      * @memberof ClaimBatchDetail
      */
     'procedure_Code'?: string | null;
     /**
-     * 
+     * The secondary service being rendered on this claim.
      * @type {string}
      * @memberof ClaimBatchDetail
      */
     'procedure_Code2'?: string | null;
     /**
-     * 
+     * The number of th eunits from this detail line that comes from the Prtocedure Code. This determines pricing for the line.
      * @type {number}
      * @memberof ClaimBatchDetail
      */
     'procedure_Code_Units'?: number | null;
     /**
-     * 
+     * QPA (Qualified Payment Amount) values received in upcoming EDI transactions for the NSA (No Surprise Act) mandate.
      * @type {number}
      * @memberof ClaimBatchDetail
      */
     'qualifying_Payment_Amount'?: number | null;
     /**
-     * 
+     * No longer in use.
      * @type {number}
      * @memberof ClaimBatchDetail
      */
     'reason_Code'?: number | null;
     /**
-     * 
+     * Pharmacy claim information submitted via file submission and used in reporting and interfaces.
      * @type {number}
      * @memberof ClaimBatchDetail
      */
     'refill_Indicator'?: number | null;
     /**
-     * 
+     * Holds the submitted reprice savings amount for services that include this amount in the pricing calculation.
      * @type {number}
      * @memberof ClaimBatchDetail
      */
     'repriced_Savings_Amount'?: number | null;
     /**
-     * 
+     * For dental claims, notes if this surface had services rendered.  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 ClaimBatchDetail
      */
     'root': boolean;
     /**
-     * 
+     * The start date of the services being rendered.
      * @type {string}
      * @memberof ClaimBatchDetail
      */
     'service_Date'?: string | null;
     /**
-     * 
+     * The end date of the services being rendered.
      * @type {string}
      * @memberof ClaimBatchDetail
      */
     'service_Thru'?: string | null;
     /**
-     * 
+     * Based on taxable amount and various configurations, this holds the Social Security \"To Tax\" amount for disability claim.
      * @type {number}
      * @memberof ClaimBatchDetail
      */
     'socSec_Amount_To_Tax'?: number | null;
     /**
-     * 
+     * The calculated Social Security tax amount based on the \"To Tax\" amount.  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 ClaimBatchDetail
      */
     'social_Security': number;
     /**
-     * 
+     * Based on taxable amount and various configurations, this holds the State \"To Tax\" amount for disability claim.
      * @type {number}
      * @memberof ClaimBatchDetail
      */
     'state_Amount_To_Tax'?: number | null;
     /**
-     * 
+     * The calculated State tax amount based on the \"To Tax\" amount.  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 ClaimBatchDetail
      */
     'state_Tax': number;
     /**
-     * 
+     * A flat state tax amount applied in addition to the calculated tax amount.
      * @type {number}
      * @memberof ClaimBatchDetail
      */
     'state_Tax_Flat'?: number | null;
     /**
-     * 
+     * When state taxes are calculated, this indicates the state the tax amount was calculated against.
      * @type {string}
      * @memberof ClaimBatchDetail
      */
     'state_Tax_State'?: string | null;
     /**
-     * 
+     * Holds the individaul status of this service line based on Ex Codes. A - Payable, D - Denied, E - Pended.
      * @type {string}
      * @memberof ClaimBatchDetail
      */
     'status_Code'?: string | null;
     /**
-     * 
+     * The units applied to this service.
      * @type {number}
      * @memberof ClaimBatchDetail
      */
     'svc_Count'?: number | null;
     /**
-     * 
+     * This holds the starting taxable amount based on pre-tax and pre-gross deductions applied to this service.
      * @type {number}
      * @memberof ClaimBatchDetail
      */
     'taxable_Amount'?: number | null;
     /**
-     * 
+     * For dental claims, this identifies the tooth, quadrant or arch being worked for this service.
      * @type {number}
      * @memberof ClaimBatchDetail
      */
     'tooth_Number'?: number | null;
     /**
-     * 
+     * No longer in use.  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 ClaimBatchDetail
      */
     'ucR_Price': number;
     /**
-     * 
+     * Pharmacy claim information submitted via file submission and used in reporting and interfaces.
      * @type {number}
      * @memberof ClaimBatchDetail
      */
     'unit_Dose'?: number | null;
     /**
-     * 
+     * Pharmacy claim information submitted via file submission and used in reporting and interfaces.
      * @type {string}
      * @memberof ClaimBatchDetail
      */
     'unit_Of_Measure'?: string | null;
     /**
-     * 
+     * Date when the record was last updated in the system.
      * @type {string}
      * @memberof ClaimBatchDetail
      */
     'update_Date'?: string;
     /**
-     * 
+     * User that last updated the record in the system.
      * @type {string}
      * @memberof ClaimBatchDetail
      */
     'update_User'?: string | null;
     /**
-     * 
+     * For plans that allow withhold, this amount is used to track that amount.  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 ClaimBatchDetail
      */