# Get ClaimBatchDetail Gets ClaimBatchDetail Endpoint: GET /claim-batches/{batchNumber}/claims/{batchClaim}/details/{claimSeq}/{adjustmentSeq} Version: v1 Security: apiKeyAuth, bearerAuth ## Header parameters: - `vbasoftware-database` (string, required) Target database ## Path parameters: - `batchNumber` (integer, required) Batch Number - `batchClaim` (integer, required) Batch Claim - `claimSeq` (string, required) Claim Seq - `adjustmentSeq` (string, required) Adjustment Seq ## Response 200 fields (text/plain): - `data` (object) - `data.batch_Number` (integer, required) References the ClaimBatch.Batch_Number value on the parent record. Note: This field is marked as NOT NULL in the database and therefore required by the API. - `data.batch_Claim` (integer, required) References the ClaimBatch.Batch_Claim value on the parent record. Note: This field is marked as NOT NULL in the database and therefore required by the API. - `data.claim_Seq` (string, required) In combination with Adjustment_Seq, creates a unique sequence for each service line on this claim. - `data.adjustment_Seq` (string, required) In combination with Claim_Seq, creates a unique sequence for each service line on this claim. Used to note adjustments, cascading, etc. when utlized. Note: This field is marked as NOT NULL in the database and therefore required by the API. - `data.ansI_Code` (string,null) No longer in use. - `data.apC_Code` (string,null) The APC code applied to this service if identified for calculation during adjudication. - `data.account_Key` (integer,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. - `data.adjusted_From_Adjustment_Line` (string,null) References the Adjustment_Seq value on the original claim that this claim is adjusting. - `data.adjusted_From_Line` (string,null) References the Claim_Seq value on the original claim that this claim is adjusting. - `data.auth_Number` (string,null) The Auth Number for services that require authorization. References Auth.Auth_Number. - `data.auth_Penalty` (number,null) If an Auth Penalty is applied during adjudication, that is housed here. - `data.auth_Required` (string,null) Notes that this service lines required authorization. - `data.benefit_Code` (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. - `data.benefit_Rate_Applied` (number,null) Benefit Rate being applied to this detail line. - `data.billed_Price` (number, required) The billed charges assigned by the provider for this service. Note: This field is marked as NOT NULL in the database and therefore required by the API. - `data.brand_Indicator` (string,null) Pharmacy claim information submitted via file submission and used in reporting and interfaces. - `data.buccal` (boolean, required) For dental claims, notes if this surface had services rendered. Note: This field is marked as NOT NULL in the database and therefore required by the API. - `data.cliA_Number` (string,null) No longer in use. - `data.coB_Amt` (number, required) 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: This field is marked as NOT NULL in the database and therefore required by the API. - `data.coB_Hold` (number,null) Used in COB calculations (Dupe or Non-Dupe) to determine the COB_Amt to be applied. - `data.coB_Mem_Resp` (number,null) Used in COB calculations (Dupe or Non-Dupe) to determine the COB_Amt to be applied. - `data.coB_Savings` (number,null) Used in COB calculations (Dupe or Non-Dupe) to determine the COB_Amt to be applied. - `data.coB_Savings_Used` (number,null) Used in COB calculations (Dupe or Non-Dupe) to determine the COB_Amt to be applied. - `data.calendar_Year` (string,null) Used for Flex Claims to indicate the calendar year this claim applies. - `data.capitation_Claim` (boolean, required) 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: This field is marked as NOT NULL in the database and therefore required by the API. - `data.check_ID` (integer,null) No longer in use. - `data.co_Ins_Amt` (number, required) The co-insurance amount applied by adjudication based on benefit definition. Note: This field is marked as NOT NULL in the database and therefore required by the API. - `data.co_Pay_Amt` (number, required) The co-pay amount applied by adjudication based on benefit definition. Note: This field is marked as NOT NULL in the database and therefore required by the API. - `data.currency_ID` (string,null) For currency calculations, this holds the destination currency. - `data.days_Supply` (integer,null) Pharmacy claim information submitted via file submission and used in reporting and interfaces. - `data.ded_Credit_Amt` (number,null) If the service is eligiblity for deductible credits, they would be stored here. - `data.deductible_Amt` (number, required) The deductible amount applied by adjudication based on benefit definition. Note: This field is marked as NOT NULL in the database and therefore required by the API. - `data.detail_Plan_Year` (string,null) Indicates which Plan Year the service line correlates to from GroupPlanYear.Plan_Year - `data.diagnosis_Code` (string,null) The diagnosis pointer for this service line indicating which Diagnostic Codes from the Claim are applicable to this service. - `data.discount_Amt` (number, required) The difference between Billed and Allowed is stored as the Discount Amount. Note: This field is marked as NOT NULL in the database and therefore required by the API. - `data.dispense_As_Written` (integer,null) Pharmacy claim information submitted via file submission and used in reporting and interfaces. - `data.distal` (boolean, required) For dental claims, notes if this surface had services rendered. Note: This field is marked as NOT NULL in the database and therefore required by the API. - `data.drug_Code` (string,null) For RX claims or medical claims that hold a drug code. References DrugCode.Drug_Code. - `data.drug_Quantity` (number,null) Pharmacy claim information submitted via file submission and used in reporting and interfaces. - `data.entry_Date` (string) Date when the record was first added to the system. - `data.entry_User` (string,null) User that first added the record to the system. - `data.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. - `data.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. - `data.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. - `data.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. - `data.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. - `data.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. - `data.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. - `data.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. - `data.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. - `data.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. - `data.error_Procedure` (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. - `data.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. - `data.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. - `data.ex_Code3` (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. - `data.fica` (number, required) The FICA tax amount for disability claims. Note: This field is marked as NOT NULL in the database and therefore required by the API. - `data.facial` (boolean, required) For dental claims, notes if this surface had services rendered. Note: This field is marked as NOT NULL in the database and therefore required by the API. - `data.federal_Amount_To_Tax` (number,null) Based on taxable amount and various configurations, this holds the Federal "To Tax" amount for disability claim. - `data.federal_Tax` (number, required) The calculated Federal tax amount based on the "To Tax" amount. Note: This field is marked as NOT NULL in the database and therefore required by the API. - `data.federal_Tax_Flat` (number,null) A flat federal tax amount applied in addition to the calculated tax amount. - `data.fill_Date` (string,null) Pharmacy claim information submitted via file submission and used in reporting and interfaces. - `data.flex_Description` (string,null) Manually entered description of this flex claim. - `data.formulary_Indicator` (string,null) Pharmacy claim information submitted via file submission and used in reporting and interfaces. - `data.incisal` (boolean, required) For dental claims, notes if this surface had services rendered. Note: This field is marked as NOT NULL in the database and therefore required by the API. - `data.interest` (number, required) If interest is calculated on a claim, it is stored here and applied to payable amount. Note: This field is marked as NOT NULL in the database and therefore required by the API. - `data.labial` (boolean, required) For dental claims, notes if this surface had services rendered. Note: This field is marked as NOT NULL in the database and therefore required by the API. - `data.life_Benefit` (string,null) The Life Benefit to be applied for Life claims processing. - `data.life_Benefit_Volume` (number,null) The Life Benefit calculated volume based on benefit definition. - `data.line_Control_Number` (string,null) Number added manually to claims and from 837 files and sent outbound on 835 files. - `data.lingual` (boolean, required) For dental claims, notes if this surface had services rendered. Note: This field is marked as NOT NULL in the database and therefore required by the API. - `data.local_Tax` (number,null) If a locality tax is applicable it would be housed here. Note: The database will apply a default value of 0 for this field if a value is not provided. - `data.mail_Order_Indicator` (string,null) Pharmacy claim information submitted via file submission and used in reporting and interfaces. - `data.medicare_Amount_To_Tax` (number,null) Based on taxable amount and various configurations, this holds the Medicare "To Tax" amount for disability claim. - `data.medicare_Tax` (number,null) The calculated Medicare tax amount based on the "To Tax" amount. - `data.mesial` (boolean, required) For dental claims, notes if this surface had services rendered. Note: This field is marked as NOT NULL in the database and therefore required by the API. - `data.minutes_Per_Unit` (number,null) This is for anesthesia, each Unit of anesthesia is equal to a specific amount of Minutes. - `data.modifier` (string,null) The modifier applied to this service. - `data.modifier_2` (string,null) The modifier applied to this service. - `data.modifier_3` (string,null) The modifier applied to this service. - `data.modifier_4` (string,null) The modifier applied to this service. - `data.modifier_Units` (number,null) The number of the units from this detail line that comes from the Modifier. This determines pricing for the line. - `data.not_Covered_Amt` (number, required) For not covered services, or partially not covered services, this reflects that deduction. Note: This field is marked as NOT NULL in the database and therefore required by the API. - `data.occlusal` (boolean, required) For dental claims, notes if this surface had services rendered. Note: This field is marked as NOT NULL in the database and therefore required by the API. - `data.oral_Cavity_Designation_Code_1` (string,null) For dental claims this holds the oral cavity designation sent on the 837D. - `data.oral_Cavity_Designation_Code_2` (string,null) For dental claims this holds the oral cavity designation sent on the 837D. - `data.oral_Cavity_Designation_Code_3` (string,null) For dental claims this holds the oral cavity designation sent on the 837D. - `data.oral_Cavity_Designation_Code_4` (string,null) For dental claims this holds the oral cavity designation sent on the 837D. - `data.oral_Cavity_Designation_Code_5` (string,null) For dental claims this holds the oral cavity designation sent on the 837D. - `data.other_Deduction_Amount` (number,null) Pharmacy claim information submitted via file submission and used in reporting and interfaces. - `data.override_Benefit_Code` (boolean, required) This flag indicates if the benefit code has been overridden. Note: This field is marked as NOT NULL in the database and therefore required by the API. - `data.override_COB_Amt` (boolean, required) 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: This field is marked as NOT NULL in the database and therefore required by the API. - `data.override_Co_Ins_Amt` (boolean, required) 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: This field is marked as NOT NULL in the database and therefore required by the API. - `data.override_Co_Pay_Amt` (boolean, required) 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: This field is marked as NOT NULL in the database and therefore required by the API. - `data.override_Ded_Credit_Amt` (boolean, required) 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: This field is marked as NOT NULL in the database and therefore required by the API. - `data.override_Deductible_Amt` (boolean, required) 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: This field is marked as NOT NULL in the database and therefore required by the API. - `data.override_Federal_Tax` (boolean, required) 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: This field is marked as NOT NULL in the database and therefore required by the API. - `data.override_Local_Tax` (boolean, required) 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: This field is marked as NOT NULL in the database and therefore required by the API. - `data.override_Medicare_Tax` (boolean, required) 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: This field is marked as NOT NULL in the database and therefore required by the API. - `data.override_Not_Covered_Amt` (boolean, required) 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: This field is marked as NOT NULL in the database and therefore required by the API. - `data.override_Plan_Price` (boolean, required) 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: This field is marked as NOT NULL in the database and therefore required by the API. - `data.override_Social_Security` (boolean, required) 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: This field is marked as NOT NULL in the database and therefore required by the API. - `data.override_State_Tax` (boolean, required) 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: This field is marked as NOT NULL in the database and therefore required by the API. - `data.override_With_Hold_Amt` (boolean, required) 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: This field is marked as NOT NULL in the database and therefore required by the API. - `data.ppO_Price_Plan_Price_Diff` (number,null) Information field used in custom processing and reporting. - `data.paid_Amt` (number, required) The final paid amount for this service line based on allowed amount (Plan_Price) minus all applicable deductions. Note: This field is marked as NOT NULL in the database and therefore required by the API. - `data.partial_Loss` (number, required) The partial loss amount for disability claims. Note: This field is marked as NOT NULL in the database and therefore required by the API. - `data.payor_ID` (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. - `data.pharmacy_Name` (string,null) Pharmacy claim information submitted via file submission and used in reporting and interfaces. - `data.place_Of_Service` (string,null) The place of service for the services being rendered on this service line. - `data.plan_Price` (number, required) The allowed amount for this service based on fee schedule, pricing, repricing, etc. Note: This field is marked as NOT NULL in the database and therefore required by the API. - `data.premium_Deduction` (number, required) The premium deduction amount for disability claims. Note: This field is marked as NOT NULL in the database and therefore required by the API. - `data.prescriber_ID` (string,null) Pharmacy claim information submitted via file submission and used in reporting and interfaces. - `data.prescription_Date` (string,null) Pharmacy claim information submitted via file submission and used in reporting and interfaces. - `data.prescription_Number` (string,null) Pharmacy claim information submitted via file submission and used in reporting and interfaces. - `data.pricing_Method` (string,null) For reprice claims (typically submitted via 837), this notes the reprice method used to reprice this service line. - `data.pricing_Rate` (number,null) The rate associated with the reprice method (Pricing_Method). - `data.principal` (number, required) For life claims, this holds the principal amount for reporting. Note: This field is marked as NOT NULL in the database and therefore required by the API. - `data.procedure_Code` (string,null) The service being rendered on this claim. - `data.procedure_Code2` (string,null) The secondary service being rendered on this claim. - `data.procedure_Code_Units` (number,null) The number of th eunits from this detail line that comes from the Prtocedure Code. This determines pricing for the line. - `data.qualifying_Payment_Amount` (number,null) QPA (Qualified Payment Amount) values received in upcoming EDI transactions for the NSA (No Surprise Act) mandate. - `data.reason_Code` (integer,null) No longer in use. - `data.refill_Indicator` (integer,null) Pharmacy claim information submitted via file submission and used in reporting and interfaces. - `data.repriced_Savings_Amount` (number,null) Holds the submitted reprice savings amount for services that include this amount in the pricing calculation. - `data.root` (boolean, required) For dental claims, notes if this surface had services rendered. Note: This field is marked as NOT NULL in the database and therefore required by the API. - `data.service_Date` (string,null) The start date of the services being rendered. - `data.service_Thru` (string,null) The end date of the services being rendered. - `data.socSec_Amount_To_Tax` (number,null) Based on taxable amount and various configurations, this holds the Social Security "To Tax" amount for disability claim. - `data.social_Security` (number, required) The calculated Social Security tax amount based on the "To Tax" amount. Note: This field is marked as NOT NULL in the database and therefore required by the API. - `data.state_Amount_To_Tax` (number,null) Based on taxable amount and various configurations, this holds the State "To Tax" amount for disability claim. - `data.state_Tax` (number, required) The calculated State tax amount based on the "To Tax" amount. Note: This field is marked as NOT NULL in the database and therefore required by the API. - `data.state_Tax_Flat` (number,null) A flat state tax amount applied in addition to the calculated tax amount. - `data.state_Tax_State` (string,null) When state taxes are calculated, this indicates the state the tax amount was calculated against. - `data.status_Code` (string,null) Holds the individaul status of this service line based on Ex Codes. A - Payable, D - Denied, E - Pended. - `data.svc_Count` (number,null) The units applied to this service. - `data.taxable_Amount` (number,null) This holds the starting taxable amount based on pre-tax and pre-gross deductions applied to this service. - `data.tooth_Number` (integer,null) For dental claims, this identifies the tooth, quadrant or arch being worked for this service. - `data.ucR_Price` (number, required) No longer in use. Note: This field is marked as NOT NULL in the database and therefore required by the API. - `data.unit_Dose` (integer,null) Pharmacy claim information submitted via file submission and used in reporting and interfaces. - `data.unit_Of_Measure` (string,null) Pharmacy claim information submitted via file submission and used in reporting and interfaces. - `data.update_Date` (string) Date when the record was last updated in the system. - `data.update_User` (string,null) User that last updated the record in the system. - `data.with_Hold_Amt` (number, required) For plans that allow withhold, this amount is used to track that amount. Note: This field is marked as NOT NULL in the database and therefore required by the API. - `data.rx_CoPay_Assist_Amt` (number,null) - `data.rx_Penalty_Amt` (number,null) - `error` (object) - `error.detail` (string,null) A human-readable explanation specific to this occurrence of the problem. - `error.instance` (string,null) A URI reference that identifies the specific occurrence of the problem.It may or may not yield further information if dereferenced. - `error.status` (integer) The HTTP status code([RFC7231], Section 6) generated by the origin server for this occurrence of the problem. - `error.title` (string,null) A short, human-readable summary of the problem type.It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization(e.g., using proactive content negotiation; see[RFC7231], Section 3.4). - `error.type` (string,null) A URI reference [RFC3986] that identifies the problem type. This specification encourages that, when dereferenced, it provide human-readable documentation for the problem type (e.g., using HTML [W3C.REC-html5-20141028]). When this member is not present, its value is assumed to be "about:blank". - `debug` (object) - `debug.activityID` (string, required) ## Response 401 fields