# Create ClaimBatchDetail

Creates a new ClaimBatchDetail

Endpoint: POST /claim-batches/{batchNumber}/claims/{batchClaim}/details
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

## Request fields (application/json):

  - `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.

  - `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.

  - `claim_Seq` (string, required)
    In combination with Adjustment_Seq, creates a unique sequence for each service line on this claim.

  - `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.

  - `ansI_Code` (string,null)
    No longer in use.

  - `apC_Code` (string,null)
    The APC code applied to this service if identified for calculation during adjudication.

  - `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.

  - `adjusted_From_Adjustment_Line` (string,null)
    References the Adjustment_Seq value on the original claim that this claim is adjusting.

  - `adjusted_From_Line` (string,null)
    References the Claim_Seq value on the original claim that this claim is adjusting.

  - `auth_Number` (string,null)
    The Auth Number for services that require authorization. References Auth.Auth_Number.

  - `auth_Penalty` (number,null)
    If an Auth Penalty is applied during adjudication, that is housed here.

  - `auth_Required` (string,null)
    Notes that this service lines required authorization.

  - `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.

  - `benefit_Rate_Applied` (number,null)
    Benefit Rate being applied to this detail line.

  - `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.

  - `brand_Indicator` (string,null)
    Pharmacy claim information submitted via file submission and used in reporting and interfaces.

  - `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.

  - `cliA_Number` (string,null)
    No longer in use.

  - `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.

  - `coB_Hold` (number,null)
    Used in COB calculations (Dupe or Non-Dupe) to determine the COB_Amt to be applied.

  - `coB_Mem_Resp` (number,null)
    Used in COB calculations (Dupe or Non-Dupe) to determine the COB_Amt to be applied.

  - `coB_Savings` (number,null)
    Used in COB calculations (Dupe or Non-Dupe) to determine the COB_Amt to be applied.

  - `coB_Savings_Used` (number,null)
    Used in COB calculations (Dupe or Non-Dupe) to determine the COB_Amt to be applied.

  - `calendar_Year` (string,null)
    Used for Flex Claims to indicate the calendar year this claim applies.

  - `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.

  - `check_ID` (integer,null)
    No longer in use.

  - `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.

  - `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.

  - `currency_ID` (string,null)
    For currency calculations, this holds the destination currency.

  - `days_Supply` (integer,null)
    Pharmacy claim information submitted via file submission and used in reporting and interfaces.

  - `ded_Credit_Amt` (number,null)
    If the service is eligiblity for deductible credits, they would be stored here.

  - `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.

  - `detail_Plan_Year` (string,null)
    Indicates which Plan Year the service line correlates to from GroupPlanYear.Plan_Year

  - `diagnosis_Code` (string,null)
    The diagnosis pointer for this service line indicating which Diagnostic Codes from the Claim are applicable to this service.

  - `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.

  - `dispense_As_Written` (integer,null)
    Pharmacy claim information submitted via file submission and used in reporting and interfaces.

  - `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.

  - `drug_Code` (string,null)
    For RX claims or medical claims that hold a drug code. References DrugCode.Drug_Code.

  - `drug_Quantity` (number,null)
    Pharmacy claim information submitted via file submission and used in reporting and interfaces.

  - `entry_Date` (string)
    Date when the record was first added to the system.

  - `entry_User` (string,null)
    User that first added the record to the system.

  - `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.

  - `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.

  - `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.

  - `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.

  - `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.

  - `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.

  - `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.

  - `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.

  - `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.

  - `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.

  - `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.

  - `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.

  - `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.

  - `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.

  - `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.

  - `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.

  - `federal_Amount_To_Tax` (number,null)
    Based on taxable amount and various configurations, this holds the Federal "To Tax" amount for disability claim.

  - `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.

  - `federal_Tax_Flat` (number,null)
    A flat federal tax amount applied in addition to the calculated tax amount.

  - `fill_Date` (string,null)
    Pharmacy claim information submitted via file submission and used in reporting and interfaces.

  - `flex_Description` (string,null)
    Manually entered description of this flex claim.

  - `formulary_Indicator` (string,null)
    Pharmacy claim information submitted via file submission and used in reporting and interfaces.

  - `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.

  - `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.

  - `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.

  - `life_Benefit` (string,null)
    The Life Benefit to be applied for Life claims processing.

  - `life_Benefit_Volume` (number,null)
    The Life Benefit calculated volume based on benefit definition.

  - `line_Control_Number` (string,null)
    Number added manually to claims and from 837 files and sent outbound on 835 files.

  - `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.

  - `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.

  - `mail_Order_Indicator` (string,null)
    Pharmacy claim information submitted via file submission and used in reporting and interfaces.

  - `medicare_Amount_To_Tax` (number,null)
    Based on taxable amount and various configurations, this holds the Medicare "To Tax" amount for disability claim.

  - `medicare_Tax` (number,null)
    The calculated Medicare tax amount based on the "To Tax" amount.

  - `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.

  - `minutes_Per_Unit` (number,null)
    This is for anesthesia, each Unit of anesthesia is equal to a specific amount of Minutes.

  - `modifier` (string,null)
    The modifier applied to this service.

  - `modifier_2` (string,null)
    The modifier applied to this service.

  - `modifier_3` (string,null)
    The modifier applied to this service.

  - `modifier_4` (string,null)
    The modifier applied to this service.

  - `modifier_Units` (number,null)
    The number of the units from this detail line that comes from the Modifier. This determines pricing for the line.

  - `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.

  - `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.

  - `oral_Cavity_Designation_Code_1` (string,null)
    For dental claims this holds the oral cavity designation sent on the 837D.

  - `oral_Cavity_Designation_Code_2` (string,null)
    For dental claims this holds the oral cavity designation sent on the 837D.

  - `oral_Cavity_Designation_Code_3` (string,null)
    For dental claims this holds the oral cavity designation sent on the 837D.

  - `oral_Cavity_Designation_Code_4` (string,null)
    For dental claims this holds the oral cavity designation sent on the 837D.

  - `oral_Cavity_Designation_Code_5` (string,null)
    For dental claims this holds the oral cavity designation sent on the 837D.

  - `other_Deduction_Amount` (number,null)
    Pharmacy claim information submitted via file submission and used in reporting and interfaces.

  - `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.

  - `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.

  - `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.

  - `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.

  - `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.

  - `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.

  - `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.

  - `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.

  - `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.

  - `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.

  - `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.

  - `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.

  - `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.

  - `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.

  - `ppO_Price_Plan_Price_Diff` (number,null)
    Information field used in custom processing and reporting.

  - `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.

  - `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.

  - `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.

  - `pharmacy_Name` (string,null)
    Pharmacy claim information submitted via file submission and used in reporting and interfaces.

  - `place_Of_Service` (string,null)
    The place of service for the services being rendered on this service line.

  - `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.

  - `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.

  - `prescriber_ID` (string,null)
    Pharmacy claim information submitted via file submission and used in reporting and interfaces.

  - `prescription_Date` (string,null)
    Pharmacy claim information submitted via file submission and used in reporting and interfaces.

  - `prescription_Number` (string,null)
    Pharmacy claim information submitted via file submission and used in reporting and interfaces.

  - `pricing_Method` (string,null)
    For reprice claims (typically submitted via 837), this notes the reprice method used to reprice this service line.

  - `pricing_Rate` (number,null)
    The rate associated with the reprice method (Pricing_Method).

  - `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.

  - `procedure_Code` (string,null)
    The service being rendered on this claim.

  - `procedure_Code2` (string,null)
    The secondary service being rendered on this claim.

  - `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.

  - `qualifying_Payment_Amount` (number,null)
    QPA (Qualified Payment Amount) values received in upcoming EDI transactions for the NSA (No Surprise Act) mandate.

  - `reason_Code` (integer,null)
    No longer in use.

  - `refill_Indicator` (integer,null)
    Pharmacy claim information submitted via file submission and used in reporting and interfaces.

  - `repriced_Savings_Amount` (number,null)
    Holds the submitted reprice savings amount for services that include this amount in the pricing calculation.

  - `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.

  - `service_Date` (string,null)
    The start date of the services being rendered.

  - `service_Thru` (string,null)
    The end date of the services being rendered.

  - `socSec_Amount_To_Tax` (number,null)
    Based on taxable amount and various configurations, this holds the Social Security "To Tax" amount for disability claim.

  - `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.

  - `state_Amount_To_Tax` (number,null)
    Based on taxable amount and various configurations, this holds the State "To Tax" amount for disability claim.

  - `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.

  - `state_Tax_Flat` (number,null)
    A flat state tax amount applied in addition to the calculated tax amount.

  - `state_Tax_State` (string,null)
    When state taxes are calculated, this indicates the state the tax amount was calculated against.

  - `status_Code` (string,null)
    Holds the individaul status of this service line based on Ex Codes. A - Payable, D - Denied, E - Pended.

  - `svc_Count` (number,null)
    The units applied to this service.

  - `taxable_Amount` (number,null)
    This holds the starting taxable amount based on pre-tax and pre-gross deductions applied to this service.

  - `tooth_Number` (integer,null)
    For dental claims, this identifies the tooth, quadrant or arch being worked for this service.

  - `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.

  - `unit_Dose` (integer,null)
    Pharmacy claim information submitted via file submission and used in reporting and interfaces.

  - `unit_Of_Measure` (string,null)
    Pharmacy claim information submitted via file submission and used in reporting and interfaces.

  - `update_Date` (string)
    Date when the record was last updated in the system.

  - `update_User` (string,null)
    User that last updated the record in the system.

  - `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.

  - `rx_CoPay_Assist_Amt` (number,null)

  - `rx_Penalty_Amt` (number,null)

## Response 200 fields (text/plain):

  - `data` (object)

  - `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