Claim PreBatch Details

Create ClaimPreBatchDetail

Creates a new ClaimPreBatchDetail

SecurityapiKeyAuth and bearerAuth

Request

header Parameters

vbasoftware-database

required

string

Target database

Request Body schema:
application/json
required

claimPreBatchDetail_Key required	integer <int32> Archive storage table for tracking initial entry of Claim information. Not to be used externally. 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.
ansI_Code	string or null <= 8 characters Archive storage table for tracking initial entry of Claim information. Not to be used externally.
apC_Code	string or null <= 8 characters Archive storage table for tracking initial entry of Claim information. Not to be used externally.
adjusted_From_Adjustment_Line	string or null <= 3 characters Archive storage table for tracking initial entry of Claim information. Not to be used externally.
adjusted_From_Line	string or null <= 2 characters Archive storage table for tracking initial entry of Claim information. Not to be used externally.
adjustment_Seq required	string [ 1 .. 3 ] characters Archive storage table for tracking initial entry of Claim information. Not to be used externally.
auth_Number	string or null <= 20 characters Archive storage table for tracking initial entry of Claim information. Not to be used externally.
auth_Required	string or null <= 1 characters Archive storage table for tracking initial entry of Claim information. Not to be used externally.
batch_Claim required	integer <int32> Archive storage table for tracking initial entry of Claim information. Not to be used externally. 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.
batch_Number required	integer <int32> Archive storage table for tracking initial entry of Claim information. Not to be used externally. 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.
benefit_Code	string or null <= 10 characters Archive storage table for tracking initial entry of Claim information. Not to be used externally.
benefit_Rate_Applied	number or null <double> Benefit Rate being applied to this detail line.
billed_Price required	number <double> Archive storage table for tracking initial entry of Claim information. Not to be used externally. 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.
brand_Indicator	string or null <= 1 characters Archive storage table for tracking initial entry of Claim information. Not to be used externally.
buccal required	boolean Archive storage table for tracking initial entry of Claim information. Not to be used externally. 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.
coB_Amt required	number <double> Archive storage table for tracking initial entry of Claim information. Not to be used externally. 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.
coB_Hold	number or null <double> Archive storage table for tracking initial entry of Claim information. Not to be used externally.
coB_Mem_Resp	number or null <double> Archive storage table for tracking initial entry of Claim information. Not to be used externally.
claim_Seq required	string [ 1 .. 2 ] characters Archive storage table for tracking initial entry of Claim information. Not to be used externally.
co_Ins_Amt required	number <double> Archive storage table for tracking initial entry of Claim information. Not to be used externally. 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.
co_Pay_Amt required	number <double> Archive storage table for tracking initial entry of Claim information. Not to be used externally. 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.
days_Supply	integer or null <int32> Archive storage table for tracking initial entry of Claim information. Not to be used externally.
deductible_Amt required	number <double> Archive storage table for tracking initial entry of Claim information. Not to be used externally. 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.
diagnosis_Code	string or null <= 8 characters Archive storage table for tracking initial entry of Claim information. Not to be used externally.
discount_Amt required	number <double> Archive storage table for tracking initial entry of Claim information. Not to be used externally. 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.
dispense_As_Written	integer or null <int32> Archive storage table for tracking initial entry of Claim information. Not to be used externally.
distal required	boolean Archive storage table for tracking initial entry of Claim information. Not to be used externally. 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.
drug_Code	string or null <= 20 characters Archive storage table for tracking initial entry of Claim information. Not to be used externally.
drug_Quantity	number or null <double> Archive storage table for tracking initial entry of Claim information. Not to be used externally.
entry_Date	string <date-time> Archive storage table for tracking initial entry of Claim information. Not to be used externally.
entry_User	string or null <= 20 characters Archive storage table for tracking initial entry of Claim information. Not to be used externally.
ex_Code	string or null <= 6 characters Archive storage table for tracking initial entry of Claim information. Not to be used externally.
ex_Code2	string or null <= 6 characters Archive storage table for tracking initial entry of Claim information. Not to be used externally.
ex_Code3	string or null <= 6 characters Archive storage table for tracking initial entry of Claim information. Not to be used externally.
fica required	number <double> Archive storage table for tracking initial entry of Claim information. Not to be used externally. 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.
facial required	boolean Archive storage table for tracking initial entry of Claim information. Not to be used externally. 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.
federal_Amount_To_Tax	number or null <double> Archive storage table for tracking initial entry of Claim information. Not to be used externally.
federal_Tax required	number <double> Archive storage table for tracking initial entry of Claim information. Not to be used externally. 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.
federal_Tax_Flat	number or null <double> Archive storage table for tracking initial entry of Claim information. Not to be used externally.
fill_Date	string or null <date-time> Archive storage table for tracking initial entry of Claim information. Not to be used externally.
formulary_Indicator	string or null <= 1 characters Archive storage table for tracking initial entry of Claim information. Not to be used externally.
incisal required	boolean Archive storage table for tracking initial entry of Claim information. Not to be used externally. 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.
interest required	number <double> Archive storage table for tracking initial entry of Claim information. Not to be used externally. 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.
labial required	boolean Archive storage table for tracking initial entry of Claim information. Not to be used externally. 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.
line_Control_Number	string or null <= 64 characters Number added manually to claims and from 837 files and sent outbound on 835 files.
lingual required	boolean Archive storage table for tracking initial entry of Claim information. Not to be used externally. 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.
local_Tax	number or null <double> Archive storage table for tracking initial entry of Claim information. Not to be used externally.
mail_Order_Indicator	string or null <= 1 characters Archive storage table for tracking initial entry of Claim information. Not to be used externally.
medicare_Amount_To_Tax	number or null <double> Archive storage table for tracking initial entry of Claim information. Not to be used externally.
medicare_Tax	number or null <double> Archive storage table for tracking initial entry of Claim information. Not to be used externally.
mesial required	boolean Archive storage table for tracking initial entry of Claim information. Not to be used externally. 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.
modifier	string or null <= 8 characters Archive storage table for tracking initial entry of Claim information. Not to be used externally.
modifier_2	string or null <= 8 characters Archive storage table for tracking initial entry of Claim information. Not to be used externally.
modifier_3	string or null <= 8 characters Archive storage table for tracking initial entry of Claim information. Not to be used externally.
modifier_4	string or null <= 8 characters Archive storage table for tracking initial entry of Claim information. Not to be used externally.
not_Covered_Amt required	number <double> Archive storage table for tracking initial entry of Claim information. Not to be used externally. 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.
occlusal required	boolean Archive storage table for tracking initial entry of Claim information. Not to be used externally. 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.
oral_Cavity_Designation_Code_1	string or null <= 3 characters Archive storage table for tracking initial entry of Claim information. Not to be used externally.
oral_Cavity_Designation_Code_2	string or null <= 3 characters Archive storage table for tracking initial entry of Claim information. Not to be used externally.
oral_Cavity_Designation_Code_3	string or null <= 3 characters Archive storage table for tracking initial entry of Claim information. Not to be used externally.
oral_Cavity_Designation_Code_4	string or null <= 3 characters Archive storage table for tracking initial entry of Claim information. Not to be used externally.
oral_Cavity_Designation_Code_5	string or null <= 3 characters Archive storage table for tracking initial entry of Claim information. Not to be used externally.
other_Deduction_Amount	number or null <double> Archive storage table for tracking initial entry of Claim information. Not to be used externally.
paid_Amt required	number <double> Archive storage table for tracking initial entry of Claim information. Not to be used externally. 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.
partial_Loss required	number <double> Archive storage table for tracking initial entry of Claim information. Not to be used externally. 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.
pharmacy_Name	string or null <= 128 characters Archive storage table for tracking initial entry of Claim information. Not to be used externally.
place_Of_Service	string or null <= 5 characters Archive storage table for tracking initial entry of Claim information. Not to be used externally.
plan_Price required	number <double> Archive storage table for tracking initial entry of Claim information. Not to be used externally. 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.
premium_Deduction required	number <double> Archive storage table for tracking initial entry of Claim information. Not to be used externally. 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.
prescriber_ID	string or null <= 32 characters Archive storage table for tracking initial entry of Claim information. Not to be used externally.
prescription_Date	string or null <date-time> Archive storage table for tracking initial entry of Claim information. Not to be used externally.
prescription_Number	string or null <= 50 characters Archive storage table for tracking initial entry of Claim information. Not to be used externally.
principal required	number <double> Archive storage table for tracking initial entry of Claim information. Not to be used externally. 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.
procedure_Code	string or null <= 8 characters Archive storage table for tracking initial entry of Claim information. Not to be used externally.
procedure_Code2	string or null <= 8 characters Archive storage table for tracking initial entry of Claim information. Not to be used externally.
qualifying_Payment_Amount	number or null <double> QPA (Qualified Payment Amount) values received in upcoming EDI transactions for the NSA (No Surprise Act) mandate.
reason_Code	integer or null <int32> Archive storage table for tracking initial entry of Claim information. Not to be used externally.
refill_Indicator	integer or null <int32> Archive storage table for tracking initial entry of Claim information. Not to be used externally.
root required	boolean Archive storage table for tracking initial entry of Claim information. Not to be used externally. 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.
service_Date	string or null <date-time> Archive storage table for tracking initial entry of Claim information. Not to be used externally.
service_Thru	string or null <date-time> Archive storage table for tracking initial entry of Claim information. Not to be used externally.
socSec_Amount_To_Tax	number or null <double> Archive storage table for tracking initial entry of Claim information. Not to be used externally.
social_Security required	number <double> Archive storage table for tracking initial entry of Claim information. Not to be used externally. 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.
state_Amount_To_Tax	number or null <double> Archive storage table for tracking initial entry of Claim information. Not to be used externally.
state_Tax required	number <double> Archive storage table for tracking initial entry of Claim information. Not to be used externally. 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.
state_Tax_Flat	number or null <double> Archive storage table for tracking initial entry of Claim information. Not to be used externally.
state_Tax_State	string or null <= 2 characters Archive storage table for tracking initial entry of Claim information. Not to be used externally.
status_Code	string or null <= 1 characters Archive storage table for tracking initial entry of Claim information. Not to be used externally.
svc_Count	number or null <double> Archive storage table for tracking initial entry of Claim information. Not to be used externally.
taxable_Amount	number or null <double> Archive storage table for tracking initial entry of Claim information. Not to be used externally.
tooth_Number	integer or null <int32> Archive storage table for tracking initial entry of Claim information. Not to be used externally.
ucR_Price required	number <double> Archive storage table for tracking initial entry of Claim information. Not to be used externally. 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.
unit_Dose	integer or null <int32> Archive storage table for tracking initial entry of Claim information. Not to be used externally.
update_Date	string <date-time> Archive storage table for tracking initial entry of Claim information. Not to be used externally.
update_User	string or null <= 20 characters Archive storage table for tracking initial entry of Claim information. Not to be used externally.
with_Hold_Amt required	number <double> Archive storage table for tracking initial entry of Claim information. Not to be used externally. 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.

Responses

200

Success

401

Unauthorized

post/claim-prebatch-details

Request samples

Payload
C#
JavaScript
curl
Java

{"claimPreBatchDetail_Key": 0,
"ansI_Code": "string",
"apC_Code": "string",
"adjusted_From_Adjustment_Line": "str",
"adjusted_From_Line": "st",
"adjustment_Seq": "str",
"auth_Number": "string",
"auth_Required": "s",
"batch_Claim": 0,
"batch_Number": 0,
"benefit_Code": "string",
"benefit_Rate_Applied": 0.1,
"billed_Price": 0.1,
"brand_Indicator": "s",
"buccal": true,
"coB_Amt": 0.1,
"coB_Hold": 0.1,
"coB_Mem_Resp": 0.1,
"claim_Seq": "st",
"co_Ins_Amt": 0.1,
"co_Pay_Amt": 0.1,
"days_Supply": 0,
"deductible_Amt": 0.1,
"diagnosis_Code": "string",
"discount_Amt": 0.1,
"dispense_As_Written": 0,
"distal": true,
"drug_Code": "string",
"drug_Quantity": 0.1,
"entry_Date": "2019-08-24T14:15:22Z",
"entry_User": "string",
"ex_Code": "string",
"ex_Code2": "string",
"ex_Code3": "string",
"fica": 0.1,
"facial": true,
"federal_Amount_To_Tax": 0.1,
"federal_Tax": 0.1,
"federal_Tax_Flat": 0.1,
"fill_Date": "2019-08-24T14:15:22Z",
"formulary_Indicator": "s",
"incisal": true,
"interest": 0.1,
"labial": true,
"line_Control_Number": "string",
"lingual": true,
"local_Tax": 0.1,
"mail_Order_Indicator": "s",
"medicare_Amount_To_Tax": 0.1,
"medicare_Tax": 0.1,
"mesial": true,
"modifier": "string",
"modifier_2": "string",
"modifier_3": "string",
"modifier_4": "string",
"not_Covered_Amt": 0.1,
"occlusal": true,
"oral_Cavity_Designation_Code_1": "str",
"oral_Cavity_Designation_Code_2": "str",
"oral_Cavity_Designation_Code_3": "str",
"oral_Cavity_Designation_Code_4": "str",
"oral_Cavity_Designation_Code_5": "str",
"other_Deduction_Amount": 0.1,
"paid_Amt": 0.1,
"partial_Loss": 0.1,
"pharmacy_Name": "string",
"place_Of_Service": "strin",
"plan_Price": 0.1,
"premium_Deduction": 0.1,
"prescriber_ID": "string",
"prescription_Date": "2019-08-24T14:15:22Z",
"prescription_Number": "string",
"principal": 0.1,
"procedure_Code": "string",
"procedure_Code2": "string",
"qualifying_Payment_Amount": 0.1,
"reason_Code": 0,
"refill_Indicator": 0,
"root": true,
"service_Date": "2019-08-24T14:15:22Z",
"service_Thru": "2019-08-24T14:15:22Z",
"socSec_Amount_To_Tax": 0.1,
"social_Security": 0.1,
"state_Amount_To_Tax": 0.1,
"state_Tax": 0.1,
"state_Tax_Flat": 0.1,
"state_Tax_State": "st",
"status_Code": "s",
"svc_Count": 0.1,
"taxable_Amount": 0.1,
"tooth_Number": 0,
"ucR_Price": 0.1,
"unit_Dose": 0,
"update_Date": "2019-08-24T14:15:22Z",
"update_User": "string",
"with_Hold_Amt": 0.1
}

Response samples

{"data": {"claimPreBatchDetail_Key": 0,
"ansI_Code": "string",
"apC_Code": "string",
"adjusted_From_Adjustment_Line": "str",
"adjusted_From_Line": "st",
"adjustment_Seq": "str",
"auth_Number": "string",
"auth_Required": "s",
"batch_Claim": 0,
"batch_Number": 0,
"benefit_Code": "string",
"benefit_Rate_Applied": 0.1,
"billed_Price": 0.1,
"brand_Indicator": "s",
"buccal": true,
"coB_Amt": 0.1,
"coB_Hold": 0.1,
"coB_Mem_Resp": 0.1,
"claim_Seq": "st",
"co_Ins_Amt": 0.1,
"co_Pay_Amt": 0.1,
"days_Supply": 0,
"deductible_Amt": 0.1,
"diagnosis_Code": "string",
"discount_Amt": 0.1,
"dispense_As_Written": 0,
"distal": true,
"drug_Code": "string",
"drug_Quantity": 0.1,
"entry_Date": "2019-08-24T14:15:22Z",
"entry_User": "string",
"ex_Code": "string",
"ex_Code2": "string",
"ex_Code3": "string",
"fica": 0.1,
"facial": true,
"federal_Amount_To_Tax": 0.1,
"federal_Tax": 0.1,
"federal_Tax_Flat": 0.1,
"fill_Date": "2019-08-24T14:15:22Z",
"formulary_Indicator": "s",
"incisal": true,
"interest": 0.1,
"labial": true,
"line_Control_Number": "string",
"lingual": true,
"local_Tax": 0.1,
"mail_Order_Indicator": "s",
"medicare_Amount_To_Tax": 0.1,
"medicare_Tax": 0.1,
"mesial": true,
"modifier": "string",
"modifier_2": "string",
"modifier_3": "string",
"modifier_4": "string",
"not_Covered_Amt": 0.1,
"occlusal": true,
"oral_Cavity_Designation_Code_1": "str",
"oral_Cavity_Designation_Code_2": "str",
"oral_Cavity_Designation_Code_3": "str",
"oral_Cavity_Designation_Code_4": "str",
"oral_Cavity_Designation_Code_5": "str",
"other_Deduction_Amount": 0.1,
"paid_Amt": 0.1,
"partial_Loss": 0.1,
"pharmacy_Name": "string",
"place_Of_Service": "strin",
"plan_Price": 0.1,
"premium_Deduction": 0.1,
"prescriber_ID": "string",
"prescription_Date": "2019-08-24T14:15:22Z",
"prescription_Number": "string",
"principal": 0.1,
"procedure_Code": "string",
"procedure_Code2": "string",
"qualifying_Payment_Amount": 0.1,
"reason_Code": 0,
"refill_Indicator": 0,
"root": true,
"service_Date": "2019-08-24T14:15:22Z",
"service_Thru": "2019-08-24T14:15:22Z",
"socSec_Amount_To_Tax": 0.1,
"social_Security": 0.1,
"state_Amount_To_Tax": 0.1,
"state_Tax": 0.1,
"state_Tax_Flat": 0.1,
"state_Tax_State": "st",
"status_Code": "s",
"svc_Count": 0.1,
"taxable_Amount": 0.1,
"tooth_Number": 0,
"ucR_Price": 0.1,
"unit_Dose": 0,
"update_Date": "2019-08-24T14:15:22Z",
"update_User": "string",
"with_Hold_Amt": 0.1
},
"error": {"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"debug": {"activityID": "string"
}
}

List ClaimPreBatchDetail

Lists all ClaimPreBatchDetail

SecurityapiKeyAuth and bearerAuth

Request

query Parameters

page	integer <int32> Default: 1 Page
pageSize	integer <int32> Default: 100 Page Size
sortBy	string Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., 'Property1:desc,Property2:asc,Property3:asc' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.

header Parameters

vbasoftware-database

required

string

Target database

Responses

200

Success

401

Unauthorized

get/claim-prebatch-details

Request samples

C#
JavaScript
curl
Java

Response samples

No sample

Get ClaimPreBatchDetail

Gets ClaimPreBatchDetail

SecurityapiKeyAuth and bearerAuth

Request

path Parameters

ClaimPreBatchDetail_Key

required

integer <int32>

ClaimPreBatchDetail Key

header Parameters

vbasoftware-database

required

string

Target database

Responses

200

Success

401

Unauthorized

get/claim-prebatch-details/{ClaimPreBatchDetail_Key}

Request samples

C#
JavaScript
curl
Java

Response samples

No sample

Update ClaimPreBatchDetail

Updates a specific ClaimPreBatchDetail.

SecurityapiKeyAuth and bearerAuth

Request

path Parameters

ClaimPreBatchDetail_Key

required

integer <int32>

ClaimPreBatchDetail Key

header Parameters

vbasoftware-database

required

string

Target database

Request Body schema:
application/json
required

claimPreBatchDetail_Key required	integer <int32> Archive storage table for tracking initial entry of Claim information. Not to be used externally. 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.
ansI_Code	string or null <= 8 characters Archive storage table for tracking initial entry of Claim information. Not to be used externally.
apC_Code	string or null <= 8 characters Archive storage table for tracking initial entry of Claim information. Not to be used externally.
adjusted_From_Adjustment_Line	string or null <= 3 characters Archive storage table for tracking initial entry of Claim information. Not to be used externally.
adjusted_From_Line	string or null <= 2 characters Archive storage table for tracking initial entry of Claim information. Not to be used externally.
adjustment_Seq required	string [ 1 .. 3 ] characters Archive storage table for tracking initial entry of Claim information. Not to be used externally.
auth_Number	string or null <= 20 characters Archive storage table for tracking initial entry of Claim information. Not to be used externally.
auth_Required	string or null <= 1 characters Archive storage table for tracking initial entry of Claim information. Not to be used externally.
batch_Claim required	integer <int32> Archive storage table for tracking initial entry of Claim information. Not to be used externally. 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.
batch_Number required	integer <int32> Archive storage table for tracking initial entry of Claim information. Not to be used externally. 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.
benefit_Code	string or null <= 10 characters Archive storage table for tracking initial entry of Claim information. Not to be used externally.
benefit_Rate_Applied	number or null <double> Benefit Rate being applied to this detail line.
billed_Price required	number <double> Archive storage table for tracking initial entry of Claim information. Not to be used externally. 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.
brand_Indicator	string or null <= 1 characters Archive storage table for tracking initial entry of Claim information. Not to be used externally.
buccal required	boolean Archive storage table for tracking initial entry of Claim information. Not to be used externally. 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.
coB_Amt required	number <double> Archive storage table for tracking initial entry of Claim information. Not to be used externally. 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.
coB_Hold	number or null <double> Archive storage table for tracking initial entry of Claim information. Not to be used externally.
coB_Mem_Resp	number or null <double> Archive storage table for tracking initial entry of Claim information. Not to be used externally.
claim_Seq required	string [ 1 .. 2 ] characters Archive storage table for tracking initial entry of Claim information. Not to be used externally.
co_Ins_Amt required	number <double> Archive storage table for tracking initial entry of Claim information. Not to be used externally. 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.
co_Pay_Amt required	number <double> Archive storage table for tracking initial entry of Claim information. Not to be used externally. 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.
days_Supply	integer or null <int32> Archive storage table for tracking initial entry of Claim information. Not to be used externally.
deductible_Amt required	number <double> Archive storage table for tracking initial entry of Claim information. Not to be used externally. 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.
diagnosis_Code	string or null <= 8 characters Archive storage table for tracking initial entry of Claim information. Not to be used externally.
discount_Amt required	number <double> Archive storage table for tracking initial entry of Claim information. Not to be used externally. 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.
dispense_As_Written	integer or null <int32> Archive storage table for tracking initial entry of Claim information. Not to be used externally.
distal required	boolean Archive storage table for tracking initial entry of Claim information. Not to be used externally. 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.
drug_Code	string or null <= 20 characters Archive storage table for tracking initial entry of Claim information. Not to be used externally.
drug_Quantity	number or null <double> Archive storage table for tracking initial entry of Claim information. Not to be used externally.
entry_Date	string <date-time> Archive storage table for tracking initial entry of Claim information. Not to be used externally.
entry_User	string or null <= 20 characters Archive storage table for tracking initial entry of Claim information. Not to be used externally.
ex_Code	string or null <= 6 characters Archive storage table for tracking initial entry of Claim information. Not to be used externally.
ex_Code2	string or null <= 6 characters Archive storage table for tracking initial entry of Claim information. Not to be used externally.
ex_Code3	string or null <= 6 characters Archive storage table for tracking initial entry of Claim information. Not to be used externally.
fica required	number <double> Archive storage table for tracking initial entry of Claim information. Not to be used externally. 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.
facial required	boolean Archive storage table for tracking initial entry of Claim information. Not to be used externally. 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.
federal_Amount_To_Tax	number or null <double> Archive storage table for tracking initial entry of Claim information. Not to be used externally.
federal_Tax required	number <double> Archive storage table for tracking initial entry of Claim information. Not to be used externally. 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.
federal_Tax_Flat	number or null <double> Archive storage table for tracking initial entry of Claim information. Not to be used externally.
fill_Date	string or null <date-time> Archive storage table for tracking initial entry of Claim information. Not to be used externally.
formulary_Indicator	string or null <= 1 characters Archive storage table for tracking initial entry of Claim information. Not to be used externally.
incisal required	boolean Archive storage table for tracking initial entry of Claim information. Not to be used externally. 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.
interest required	number <double> Archive storage table for tracking initial entry of Claim information. Not to be used externally. 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.
labial required	boolean Archive storage table for tracking initial entry of Claim information. Not to be used externally. 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.
line_Control_Number	string or null <= 64 characters Number added manually to claims and from 837 files and sent outbound on 835 files.
lingual required	boolean Archive storage table for tracking initial entry of Claim information. Not to be used externally. 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.
local_Tax	number or null <double> Archive storage table for tracking initial entry of Claim information. Not to be used externally.
mail_Order_Indicator	string or null <= 1 characters Archive storage table for tracking initial entry of Claim information. Not to be used externally.
medicare_Amount_To_Tax	number or null <double> Archive storage table for tracking initial entry of Claim information. Not to be used externally.
medicare_Tax	number or null <double> Archive storage table for tracking initial entry of Claim information. Not to be used externally.
mesial required	boolean Archive storage table for tracking initial entry of Claim information. Not to be used externally. 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.
modifier	string or null <= 8 characters Archive storage table for tracking initial entry of Claim information. Not to be used externally.
modifier_2	string or null <= 8 characters Archive storage table for tracking initial entry of Claim information. Not to be used externally.
modifier_3	string or null <= 8 characters Archive storage table for tracking initial entry of Claim information. Not to be used externally.
modifier_4	string or null <= 8 characters Archive storage table for tracking initial entry of Claim information. Not to be used externally.
not_Covered_Amt required	number <double> Archive storage table for tracking initial entry of Claim information. Not to be used externally. 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.
occlusal required	boolean Archive storage table for tracking initial entry of Claim information. Not to be used externally. 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.
oral_Cavity_Designation_Code_1	string or null <= 3 characters Archive storage table for tracking initial entry of Claim information. Not to be used externally.
oral_Cavity_Designation_Code_2	string or null <= 3 characters Archive storage table for tracking initial entry of Claim information. Not to be used externally.
oral_Cavity_Designation_Code_3	string or null <= 3 characters Archive storage table for tracking initial entry of Claim information. Not to be used externally.
oral_Cavity_Designation_Code_4	string or null <= 3 characters Archive storage table for tracking initial entry of Claim information. Not to be used externally.
oral_Cavity_Designation_Code_5	string or null <= 3 characters Archive storage table for tracking initial entry of Claim information. Not to be used externally.
other_Deduction_Amount	number or null <double> Archive storage table for tracking initial entry of Claim information. Not to be used externally.
paid_Amt required	number <double> Archive storage table for tracking initial entry of Claim information. Not to be used externally. 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.
partial_Loss required	number <double> Archive storage table for tracking initial entry of Claim information. Not to be used externally. 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.
pharmacy_Name	string or null <= 128 characters Archive storage table for tracking initial entry of Claim information. Not to be used externally.
place_Of_Service	string or null <= 5 characters Archive storage table for tracking initial entry of Claim information. Not to be used externally.
plan_Price required	number <double> Archive storage table for tracking initial entry of Claim information. Not to be used externally. 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.
premium_Deduction required	number <double> Archive storage table for tracking initial entry of Claim information. Not to be used externally. 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.
prescriber_ID	string or null <= 32 characters Archive storage table for tracking initial entry of Claim information. Not to be used externally.
prescription_Date	string or null <date-time> Archive storage table for tracking initial entry of Claim information. Not to be used externally.
prescription_Number	string or null <= 50 characters Archive storage table for tracking initial entry of Claim information. Not to be used externally.
principal required	number <double> Archive storage table for tracking initial entry of Claim information. Not to be used externally. 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.
procedure_Code	string or null <= 8 characters Archive storage table for tracking initial entry of Claim information. Not to be used externally.
procedure_Code2	string or null <= 8 characters Archive storage table for tracking initial entry of Claim information. Not to be used externally.
qualifying_Payment_Amount	number or null <double> QPA (Qualified Payment Amount) values received in upcoming EDI transactions for the NSA (No Surprise Act) mandate.
reason_Code	integer or null <int32> Archive storage table for tracking initial entry of Claim information. Not to be used externally.
refill_Indicator	integer or null <int32> Archive storage table for tracking initial entry of Claim information. Not to be used externally.
root required	boolean Archive storage table for tracking initial entry of Claim information. Not to be used externally. 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.
service_Date	string or null <date-time> Archive storage table for tracking initial entry of Claim information. Not to be used externally.
service_Thru	string or null <date-time> Archive storage table for tracking initial entry of Claim information. Not to be used externally.
socSec_Amount_To_Tax	number or null <double> Archive storage table for tracking initial entry of Claim information. Not to be used externally.
social_Security required	number <double> Archive storage table for tracking initial entry of Claim information. Not to be used externally. 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.
state_Amount_To_Tax	number or null <double> Archive storage table for tracking initial entry of Claim information. Not to be used externally.
state_Tax required	number <double> Archive storage table for tracking initial entry of Claim information. Not to be used externally. 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.
state_Tax_Flat	number or null <double> Archive storage table for tracking initial entry of Claim information. Not to be used externally.
state_Tax_State	string or null <= 2 characters Archive storage table for tracking initial entry of Claim information. Not to be used externally.
status_Code	string or null <= 1 characters Archive storage table for tracking initial entry of Claim information. Not to be used externally.
svc_Count	number or null <double> Archive storage table for tracking initial entry of Claim information. Not to be used externally.
taxable_Amount	number or null <double> Archive storage table for tracking initial entry of Claim information. Not to be used externally.
tooth_Number	integer or null <int32> Archive storage table for tracking initial entry of Claim information. Not to be used externally.
ucR_Price required	number <double> Archive storage table for tracking initial entry of Claim information. Not to be used externally. 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.
unit_Dose	integer or null <int32> Archive storage table for tracking initial entry of Claim information. Not to be used externally.
update_Date	string <date-time> Archive storage table for tracking initial entry of Claim information. Not to be used externally.
update_User	string or null <= 20 characters Archive storage table for tracking initial entry of Claim information. Not to be used externally.
with_Hold_Amt required	number <double> Archive storage table for tracking initial entry of Claim information. Not to be used externally. 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.

Responses

200

Success

401

Unauthorized

put/claim-prebatch-details/{ClaimPreBatchDetail_Key}

Request samples

Payload
C#
JavaScript
curl
Java

{"claimPreBatchDetail_Key": 0,
"ansI_Code": "string",
"apC_Code": "string",
"adjusted_From_Adjustment_Line": "str",
"adjusted_From_Line": "st",
"adjustment_Seq": "str",
"auth_Number": "string",
"auth_Required": "s",
"batch_Claim": 0,
"batch_Number": 0,
"benefit_Code": "string",
"benefit_Rate_Applied": 0.1,
"billed_Price": 0.1,
"brand_Indicator": "s",
"buccal": true,
"coB_Amt": 0.1,
"coB_Hold": 0.1,
"coB_Mem_Resp": 0.1,
"claim_Seq": "st",
"co_Ins_Amt": 0.1,
"co_Pay_Amt": 0.1,
"days_Supply": 0,
"deductible_Amt": 0.1,
"diagnosis_Code": "string",
"discount_Amt": 0.1,
"dispense_As_Written": 0,
"distal": true,
"drug_Code": "string",
"drug_Quantity": 0.1,
"entry_Date": "2019-08-24T14:15:22Z",
"entry_User": "string",
"ex_Code": "string",
"ex_Code2": "string",
"ex_Code3": "string",
"fica": 0.1,
"facial": true,
"federal_Amount_To_Tax": 0.1,
"federal_Tax": 0.1,
"federal_Tax_Flat": 0.1,
"fill_Date": "2019-08-24T14:15:22Z",
"formulary_Indicator": "s",
"incisal": true,
"interest": 0.1,
"labial": true,
"line_Control_Number": "string",
"lingual": true,
"local_Tax": 0.1,
"mail_Order_Indicator": "s",
"medicare_Amount_To_Tax": 0.1,
"medicare_Tax": 0.1,
"mesial": true,
"modifier": "string",
"modifier_2": "string",
"modifier_3": "string",
"modifier_4": "string",
"not_Covered_Amt": 0.1,
"occlusal": true,
"oral_Cavity_Designation_Code_1": "str",
"oral_Cavity_Designation_Code_2": "str",
"oral_Cavity_Designation_Code_3": "str",
"oral_Cavity_Designation_Code_4": "str",
"oral_Cavity_Designation_Code_5": "str",
"other_Deduction_Amount": 0.1,
"paid_Amt": 0.1,
"partial_Loss": 0.1,
"pharmacy_Name": "string",
"place_Of_Service": "strin",
"plan_Price": 0.1,
"premium_Deduction": 0.1,
"prescriber_ID": "string",
"prescription_Date": "2019-08-24T14:15:22Z",
"prescription_Number": "string",
"principal": 0.1,
"procedure_Code": "string",
"procedure_Code2": "string",
"qualifying_Payment_Amount": 0.1,
"reason_Code": 0,
"refill_Indicator": 0,
"root": true,
"service_Date": "2019-08-24T14:15:22Z",
"service_Thru": "2019-08-24T14:15:22Z",
"socSec_Amount_To_Tax": 0.1,
"social_Security": 0.1,
"state_Amount_To_Tax": 0.1,
"state_Tax": 0.1,
"state_Tax_Flat": 0.1,
"state_Tax_State": "st",
"status_Code": "s",
"svc_Count": 0.1,
"taxable_Amount": 0.1,
"tooth_Number": 0,
"ucR_Price": 0.1,
"unit_Dose": 0,
"update_Date": "2019-08-24T14:15:22Z",
"update_User": "string",
"with_Hold_Amt": 0.1
}

Response samples

{"data": {"claimPreBatchDetail_Key": 0,
"ansI_Code": "string",
"apC_Code": "string",
"adjusted_From_Adjustment_Line": "str",
"adjusted_From_Line": "st",
"adjustment_Seq": "str",
"auth_Number": "string",
"auth_Required": "s",
"batch_Claim": 0,
"batch_Number": 0,
"benefit_Code": "string",
"benefit_Rate_Applied": 0.1,
"billed_Price": 0.1,
"brand_Indicator": "s",
"buccal": true,
"coB_Amt": 0.1,
"coB_Hold": 0.1,
"coB_Mem_Resp": 0.1,
"claim_Seq": "st",
"co_Ins_Amt": 0.1,
"co_Pay_Amt": 0.1,
"days_Supply": 0,
"deductible_Amt": 0.1,
"diagnosis_Code": "string",
"discount_Amt": 0.1,
"dispense_As_Written": 0,
"distal": true,
"drug_Code": "string",
"drug_Quantity": 0.1,
"entry_Date": "2019-08-24T14:15:22Z",
"entry_User": "string",
"ex_Code": "string",
"ex_Code2": "string",
"ex_Code3": "string",
"fica": 0.1,
"facial": true,
"federal_Amount_To_Tax": 0.1,
"federal_Tax": 0.1,
"federal_Tax_Flat": 0.1,
"fill_Date": "2019-08-24T14:15:22Z",
"formulary_Indicator": "s",
"incisal": true,
"interest": 0.1,
"labial": true,
"line_Control_Number": "string",
"lingual": true,
"local_Tax": 0.1,
"mail_Order_Indicator": "s",
"medicare_Amount_To_Tax": 0.1,
"medicare_Tax": 0.1,
"mesial": true,
"modifier": "string",
"modifier_2": "string",
"modifier_3": "string",
"modifier_4": "string",
"not_Covered_Amt": 0.1,
"occlusal": true,
"oral_Cavity_Designation_Code_1": "str",
"oral_Cavity_Designation_Code_2": "str",
"oral_Cavity_Designation_Code_3": "str",
"oral_Cavity_Designation_Code_4": "str",
"oral_Cavity_Designation_Code_5": "str",
"other_Deduction_Amount": 0.1,
"paid_Amt": 0.1,
"partial_Loss": 0.1,
"pharmacy_Name": "string",
"place_Of_Service": "strin",
"plan_Price": 0.1,
"premium_Deduction": 0.1,
"prescriber_ID": "string",
"prescription_Date": "2019-08-24T14:15:22Z",
"prescription_Number": "string",
"principal": 0.1,
"procedure_Code": "string",
"procedure_Code2": "string",
"qualifying_Payment_Amount": 0.1,
"reason_Code": 0,
"refill_Indicator": 0,
"root": true,
"service_Date": "2019-08-24T14:15:22Z",
"service_Thru": "2019-08-24T14:15:22Z",
"socSec_Amount_To_Tax": 0.1,
"social_Security": 0.1,
"state_Amount_To_Tax": 0.1,
"state_Tax": 0.1,
"state_Tax_Flat": 0.1,
"state_Tax_State": "st",
"status_Code": "s",
"svc_Count": 0.1,
"taxable_Amount": 0.1,
"tooth_Number": 0,
"ucR_Price": 0.1,
"unit_Dose": 0,
"update_Date": "2019-08-24T14:15:22Z",
"update_User": "string",
"with_Hold_Amt": 0.1
},
"error": {"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"debug": {"activityID": "string"
}
}

Delete ClaimPreBatchDetail

Deletes an ClaimPreBatchDetail

SecurityapiKeyAuth and bearerAuth

Request

path Parameters

ClaimPreBatchDetail_Key

required

integer <int32>

ClaimPreBatchDetail Key

header Parameters

vbasoftware-database

required

string

Target database

Responses

204

Success

401

Unauthorized

delete/claim-prebatch-details/{ClaimPreBatchDetail_Key}

Request samples

C#
JavaScript
curl
Java

Create or Update Batch ClaimPreBatchDetail

Create or Update multiple ClaimPreBatchDetail at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.

SecurityapiKeyAuth and bearerAuth

Request

header Parameters

vbasoftware-database

required

string

Target database

Request Body schema:
application/json
required

Array

claimPreBatchDetail_Key required	integer <int32> Archive storage table for tracking initial entry of Claim information. Not to be used externally. 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.
ansI_Code	string or null <= 8 characters Archive storage table for tracking initial entry of Claim information. Not to be used externally.
apC_Code	string or null <= 8 characters Archive storage table for tracking initial entry of Claim information. Not to be used externally.
adjusted_From_Adjustment_Line	string or null <= 3 characters Archive storage table for tracking initial entry of Claim information. Not to be used externally.
adjusted_From_Line	string or null <= 2 characters Archive storage table for tracking initial entry of Claim information. Not to be used externally.
adjustment_Seq required	string [ 1 .. 3 ] characters Archive storage table for tracking initial entry of Claim information. Not to be used externally.
auth_Number	string or null <= 20 characters Archive storage table for tracking initial entry of Claim information. Not to be used externally.
auth_Required	string or null <= 1 characters Archive storage table for tracking initial entry of Claim information. Not to be used externally.
batch_Claim required	integer <int32> Archive storage table for tracking initial entry of Claim information. Not to be used externally. 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.
batch_Number required	integer <int32> Archive storage table for tracking initial entry of Claim information. Not to be used externally. 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.
benefit_Code	string or null <= 10 characters Archive storage table for tracking initial entry of Claim information. Not to be used externally.
benefit_Rate_Applied	number or null <double> Benefit Rate being applied to this detail line.
billed_Price required	number <double> Archive storage table for tracking initial entry of Claim information. Not to be used externally. 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.
brand_Indicator	string or null <= 1 characters Archive storage table for tracking initial entry of Claim information. Not to be used externally.
buccal required	boolean Archive storage table for tracking initial entry of Claim information. Not to be used externally. 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.
coB_Amt required	number <double> Archive storage table for tracking initial entry of Claim information. Not to be used externally. 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.
coB_Hold	number or null <double> Archive storage table for tracking initial entry of Claim information. Not to be used externally.
coB_Mem_Resp	number or null <double> Archive storage table for tracking initial entry of Claim information. Not to be used externally.
claim_Seq required	string [ 1 .. 2 ] characters Archive storage table for tracking initial entry of Claim information. Not to be used externally.
co_Ins_Amt required	number <double> Archive storage table for tracking initial entry of Claim information. Not to be used externally. 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.
co_Pay_Amt required	number <double> Archive storage table for tracking initial entry of Claim information. Not to be used externally. 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.
days_Supply	integer or null <int32> Archive storage table for tracking initial entry of Claim information. Not to be used externally.
deductible_Amt required	number <double> Archive storage table for tracking initial entry of Claim information. Not to be used externally. 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.
diagnosis_Code	string or null <= 8 characters Archive storage table for tracking initial entry of Claim information. Not to be used externally.
discount_Amt required	number <double> Archive storage table for tracking initial entry of Claim information. Not to be used externally. 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.
dispense_As_Written	integer or null <int32> Archive storage table for tracking initial entry of Claim information. Not to be used externally.
distal required	boolean Archive storage table for tracking initial entry of Claim information. Not to be used externally. 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.
drug_Code	string or null <= 20 characters Archive storage table for tracking initial entry of Claim information. Not to be used externally.
drug_Quantity	number or null <double> Archive storage table for tracking initial entry of Claim information. Not to be used externally.
entry_Date	string <date-time> Archive storage table for tracking initial entry of Claim information. Not to be used externally.
entry_User	string or null <= 20 characters Archive storage table for tracking initial entry of Claim information. Not to be used externally.
ex_Code	string or null <= 6 characters Archive storage table for tracking initial entry of Claim information. Not to be used externally.
ex_Code2	string or null <= 6 characters Archive storage table for tracking initial entry of Claim information. Not to be used externally.
ex_Code3	string or null <= 6 characters Archive storage table for tracking initial entry of Claim information. Not to be used externally.
fica required	number <double> Archive storage table for tracking initial entry of Claim information. Not to be used externally. 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.
facial required	boolean Archive storage table for tracking initial entry of Claim information. Not to be used externally. 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.
federal_Amount_To_Tax	number or null <double> Archive storage table for tracking initial entry of Claim information. Not to be used externally.
federal_Tax required	number <double> Archive storage table for tracking initial entry of Claim information. Not to be used externally. 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.
federal_Tax_Flat	number or null <double> Archive storage table for tracking initial entry of Claim information. Not to be used externally.
fill_Date	string or null <date-time> Archive storage table for tracking initial entry of Claim information. Not to be used externally.
formulary_Indicator	string or null <= 1 characters Archive storage table for tracking initial entry of Claim information. Not to be used externally.
incisal required	boolean Archive storage table for tracking initial entry of Claim information. Not to be used externally. 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.
interest required	number <double> Archive storage table for tracking initial entry of Claim information. Not to be used externally. 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.
labial required	boolean Archive storage table for tracking initial entry of Claim information. Not to be used externally. 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.
line_Control_Number	string or null <= 64 characters Number added manually to claims and from 837 files and sent outbound on 835 files.
lingual required	boolean Archive storage table for tracking initial entry of Claim information. Not to be used externally. 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.
local_Tax	number or null <double> Archive storage table for tracking initial entry of Claim information. Not to be used externally.
mail_Order_Indicator	string or null <= 1 characters Archive storage table for tracking initial entry of Claim information. Not to be used externally.
medicare_Amount_To_Tax	number or null <double> Archive storage table for tracking initial entry of Claim information. Not to be used externally.
medicare_Tax	number or null <double> Archive storage table for tracking initial entry of Claim information. Not to be used externally.
mesial required	boolean Archive storage table for tracking initial entry of Claim information. Not to be used externally. 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.
modifier	string or null <= 8 characters Archive storage table for tracking initial entry of Claim information. Not to be used externally.
modifier_2	string or null <= 8 characters Archive storage table for tracking initial entry of Claim information. Not to be used externally.
modifier_3	string or null <= 8 characters Archive storage table for tracking initial entry of Claim information. Not to be used externally.
modifier_4	string or null <= 8 characters Archive storage table for tracking initial entry of Claim information. Not to be used externally.
not_Covered_Amt required	number <double> Archive storage table for tracking initial entry of Claim information. Not to be used externally. 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.
occlusal required	boolean Archive storage table for tracking initial entry of Claim information. Not to be used externally. 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.
oral_Cavity_Designation_Code_1	string or null <= 3 characters Archive storage table for tracking initial entry of Claim information. Not to be used externally.
oral_Cavity_Designation_Code_2	string or null <= 3 characters Archive storage table for tracking initial entry of Claim information. Not to be used externally.
oral_Cavity_Designation_Code_3	string or null <= 3 characters Archive storage table for tracking initial entry of Claim information. Not to be used externally.
oral_Cavity_Designation_Code_4	string or null <= 3 characters Archive storage table for tracking initial entry of Claim information. Not to be used externally.
oral_Cavity_Designation_Code_5	string or null <= 3 characters Archive storage table for tracking initial entry of Claim information. Not to be used externally.
other_Deduction_Amount	number or null <double> Archive storage table for tracking initial entry of Claim information. Not to be used externally.
paid_Amt required	number <double> Archive storage table for tracking initial entry of Claim information. Not to be used externally. 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.
partial_Loss required	number <double> Archive storage table for tracking initial entry of Claim information. Not to be used externally. 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.
pharmacy_Name	string or null <= 128 characters Archive storage table for tracking initial entry of Claim information. Not to be used externally.
place_Of_Service	string or null <= 5 characters Archive storage table for tracking initial entry of Claim information. Not to be used externally.
plan_Price required	number <double> Archive storage table for tracking initial entry of Claim information. Not to be used externally. 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.
premium_Deduction required	number <double> Archive storage table for tracking initial entry of Claim information. Not to be used externally. 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.
prescriber_ID	string or null <= 32 characters Archive storage table for tracking initial entry of Claim information. Not to be used externally.
prescription_Date	string or null <date-time> Archive storage table for tracking initial entry of Claim information. Not to be used externally.
prescription_Number	string or null <= 50 characters Archive storage table for tracking initial entry of Claim information. Not to be used externally.
principal required	number <double> Archive storage table for tracking initial entry of Claim information. Not to be used externally. 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.
procedure_Code	string or null <= 8 characters Archive storage table for tracking initial entry of Claim information. Not to be used externally.
procedure_Code2	string or null <= 8 characters Archive storage table for tracking initial entry of Claim information. Not to be used externally.
qualifying_Payment_Amount	number or null <double> QPA (Qualified Payment Amount) values received in upcoming EDI transactions for the NSA (No Surprise Act) mandate.
reason_Code	integer or null <int32> Archive storage table for tracking initial entry of Claim information. Not to be used externally.
refill_Indicator	integer or null <int32> Archive storage table for tracking initial entry of Claim information. Not to be used externally.
root required	boolean Archive storage table for tracking initial entry of Claim information. Not to be used externally. 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.
service_Date	string or null <date-time> Archive storage table for tracking initial entry of Claim information. Not to be used externally.
service_Thru	string or null <date-time> Archive storage table for tracking initial entry of Claim information. Not to be used externally.
socSec_Amount_To_Tax	number or null <double> Archive storage table for tracking initial entry of Claim information. Not to be used externally.
social_Security required	number <double> Archive storage table for tracking initial entry of Claim information. Not to be used externally. 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.
state_Amount_To_Tax	number or null <double> Archive storage table for tracking initial entry of Claim information. Not to be used externally.
state_Tax required	number <double> Archive storage table for tracking initial entry of Claim information. Not to be used externally. 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.
state_Tax_Flat	number or null <double> Archive storage table for tracking initial entry of Claim information. Not to be used externally.
state_Tax_State	string or null <= 2 characters Archive storage table for tracking initial entry of Claim information. Not to be used externally.
status_Code	string or null <= 1 characters Archive storage table for tracking initial entry of Claim information. Not to be used externally.
svc_Count	number or null <double> Archive storage table for tracking initial entry of Claim information. Not to be used externally.
taxable_Amount	number or null <double> Archive storage table for tracking initial entry of Claim information. Not to be used externally.
tooth_Number	integer or null <int32> Archive storage table for tracking initial entry of Claim information. Not to be used externally.
ucR_Price required	number <double> Archive storage table for tracking initial entry of Claim information. Not to be used externally. 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.
unit_Dose	integer or null <int32> Archive storage table for tracking initial entry of Claim information. Not to be used externally.
update_Date	string <date-time> Archive storage table for tracking initial entry of Claim information. Not to be used externally.
update_User	string or null <= 20 characters Archive storage table for tracking initial entry of Claim information. Not to be used externally.
with_Hold_Amt required	number <double> Archive storage table for tracking initial entry of Claim information. Not to be used externally. 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.

Responses

207

Success

401

Unauthorized

put/claim-prebatch-details-batch

Request samples

Payload
C#
JavaScript
curl
Java

[{"claimPreBatchDetail_Key": 0,
"ansI_Code": "string",
"apC_Code": "string",
"adjusted_From_Adjustment_Line": "str",
"adjusted_From_Line": "st",
"adjustment_Seq": "str",
"auth_Number": "string",
"auth_Required": "s",
"batch_Claim": 0,
"batch_Number": 0,
"benefit_Code": "string",
"benefit_Rate_Applied": 0.1,
"billed_Price": 0.1,
"brand_Indicator": "s",
"buccal": true,
"coB_Amt": 0.1,
"coB_Hold": 0.1,
"coB_Mem_Resp": 0.1,
"claim_Seq": "st",
"co_Ins_Amt": 0.1,
"co_Pay_Amt": 0.1,
"days_Supply": 0,
"deductible_Amt": 0.1,
"diagnosis_Code": "string",
"discount_Amt": 0.1,
"dispense_As_Written": 0,
"distal": true,
"drug_Code": "string",
"drug_Quantity": 0.1,
"entry_Date": "2019-08-24T14:15:22Z",
"entry_User": "string",
"ex_Code": "string",
"ex_Code2": "string",
"ex_Code3": "string",
"fica": 0.1,
"facial": true,
"federal_Amount_To_Tax": 0.1,
"federal_Tax": 0.1,
"federal_Tax_Flat": 0.1,
"fill_Date": "2019-08-24T14:15:22Z",
"formulary_Indicator": "s",
"incisal": true,
"interest": 0.1,
"labial": true,
"line_Control_Number": "string",
"lingual": true,
"local_Tax": 0.1,
"mail_Order_Indicator": "s",
"medicare_Amount_To_Tax": 0.1,
"medicare_Tax": 0.1,
"mesial": true,
"modifier": "string",
"modifier_2": "string",
"modifier_3": "string",
"modifier_4": "string",
"not_Covered_Amt": 0.1,
"occlusal": true,
"oral_Cavity_Designation_Code_1": "str",
"oral_Cavity_Designation_Code_2": "str",
"oral_Cavity_Designation_Code_3": "str",
"oral_Cavity_Designation_Code_4": "str",
"oral_Cavity_Designation_Code_5": "str",
"other_Deduction_Amount": 0.1,
"paid_Amt": 0.1,
"partial_Loss": 0.1,
"pharmacy_Name": "string",
"place_Of_Service": "strin",
"plan_Price": 0.1,
"premium_Deduction": 0.1,
"prescriber_ID": "string",
"prescription_Date": "2019-08-24T14:15:22Z",
"prescription_Number": "string",
"principal": 0.1,
"procedure_Code": "string",
"procedure_Code2": "string",
"qualifying_Payment_Amount": 0.1,
"reason_Code": 0,
"refill_Indicator": 0,
"root": true,
"service_Date": "2019-08-24T14:15:22Z",
"service_Thru": "2019-08-24T14:15:22Z",
"socSec_Amount_To_Tax": 0.1,
"social_Security": 0.1,
"state_Amount_To_Tax": 0.1,
"state_Tax": 0.1,
"state_Tax_Flat": 0.1,
"state_Tax_State": "st",
"status_Code": "s",
"svc_Count": 0.1,
"taxable_Amount": 0.1,
"tooth_Number": 0,
"ucR_Price": 0.1,
"unit_Dose": 0,
"update_Date": "2019-08-24T14:15:22Z",
"update_User": "string",
"with_Hold_Amt": 0.1
}
]

Response samples

{"data": [{"id": [{"key": "string",
"value": "string"
}
],
"status": 0,
"body": "string"
}
],
"error": {"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"debug": {"activityID": "string"
}
}

Claim PreBatch Details

Create ClaimPreBatchDetail

header Parameters

Request Body schema: application/jsontext/jsonapplication/*+jsonapplication/jsonrequired

List ClaimPreBatchDetail

query Parameters

header Parameters

Get ClaimPreBatchDetail

path Parameters

header Parameters

Update ClaimPreBatchDetail

path Parameters

header Parameters

Request Body schema: application/jsontext/jsonapplication/*+jsonapplication/jsonrequired

Delete ClaimPreBatchDetail

path Parameters

header Parameters

Create or Update Batch ClaimPreBatchDetail

header Parameters

Request Body schema: application/jsontext/jsonapplication/*+jsonapplication/jsonrequired

Request Body schema:
application/json
required

Request Body schema:
application/json
required

Request Body schema:
application/json
required