Claim Disabilities

Create ClaimDisability

Creates a new ClaimDisability

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
batch_Number
required
integer <int32>
admit_Date
string or null <date-time>
apply_Extension
integer or null <int32>
apply_Extension_Ex_Code
string or null <= 8 characters
attended_Physician
string or null <date-time>
birth_Date
string or null <date-time>
closure_Effective_Date
string or null <date-time>
delivery_Date
string or null <date-time>
delivery_Type
string or null <= 1 characters
dep_SSDI_End_Date
string or null <date-time>
description
string or null <= 512 characters
diagnostic_Code1
string or null <= 8 characters
diagnostic_Code2
string or null <= 8 characters
diagnostic_Code_Type
string or null <= 16 characters
disability_Pay_Through_Day
integer or null <int32>
disability_Type
string or null <= 1 characters
disabled_By_Physician
string or null <date-time>
discharge_Date
string or null <date-time>
entry_Date
string <date-time>
entry_User
string or null <= 20 characters
ex_Code
string or null <= 8 characters
exceed_Max
required
boolean
exhaust_Date
string or null <date-time>
expected_Typical_Duration
integer or null <int32>
ficA_Percent
number or null <double>
federal_Withheld
number or null <double>
followup_Date
string or null <date-time>
followup_Ex_Code
string or null <= 8 characters
group_ID
string or null <= 20 characters
image_Number_1
string or null <= 64 characters
image_Number_2
string or null <= 64 characters
image_Number_3
string or null <= 64 characters
image_Number_4
string or null <= 64 characters
include_Return_To_Work
required
boolean
include_Waiting_Period
required
boolean
include_Waiting_Period_In_Max
required
boolean
job_Type
string or null <= 6 characters
ltD_Effective_Date
string or null <date-time>
ltD_Packet_Date
string or null <date-time>
last_Day_Worked
string or null <date-time>
last_Physician_Warrant_Date
string or null <date-time>
liability_Injury
integer or null <int32>
mail_To
string or null <= 1 characters
max_Disability_Days
integer or null <int32>
member_Seq
string or null <= 2 characters
overpayment_Deduction
number or null <double>
overpayment_Ex_Code
string or null <= 8 characters
overpayment_Total
number or null <double>
partial_Disability
required
boolean
pay_To
string or null <= 1 characters
payment_Days
integer or null <int32>
payment_Duration
integer or null <int32>
physician_Return_To_Work
string or null <date-time>
plan_ID
string or null <= 20 characters
plan_Type
string or null <= 6 characters
plan_Type_LTD
required
boolean
received_Date
string or null <date-time>
return_To_Work
string or null <date-time>
rollup_Waiting_Period
required
boolean
scd
required
boolean
salary_Cont_Ex_Code
string or null <= 8 characters
salary_Cont_From
string or null <date-time>
salary_Cont_Paid
required
boolean
salary_Cont_Thru
string or null <date-time>
sick_Time_Ex_Code
string or null <= 8 characters
sick_Time_From
string or null <date-time>
sick_Time_Paid
required
boolean
sick_Time_Thru
string or null <date-time>
state_Withheld
number or null <double>
subscriber_ID
string or null <= 20 characters
type_Of_Surgery
string or null <= 6 characters
update_Date
string <date-time>
update_User
string or null <= 20 characters
vacation_Ex_Code
string or null <= 8 characters
vacation_From
string or null <date-time>
vacation_Paid
required
boolean
vacation_Thru
string or null <date-time>
waiting_Period
integer or null <int32>
waiting_Period_Ex_Code
string or null <= 8 characters
waive_Waiting_Period
required
boolean
Responses
200

Success

401

Unauthorized

post/claim-disabilities
Request samples
{
  • "batch_Number": 0,
  • "admit_Date": "2019-08-24T14:15:22Z",
  • "apply_Extension": 0,
  • "apply_Extension_Ex_Code": "string",
  • "attended_Physician": "2019-08-24T14:15:22Z",
  • "birth_Date": "2019-08-24T14:15:22Z",
  • "closure_Effective_Date": "2019-08-24T14:15:22Z",
  • "delivery_Date": "2019-08-24T14:15:22Z",
  • "delivery_Type": "s",
  • "dep_SSDI_End_Date": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "diagnostic_Code1": "string",
  • "diagnostic_Code2": "string",
  • "diagnostic_Code_Type": "string",
  • "disability_Pay_Through_Day": 0,
  • "disability_Type": "s",
  • "disabled_By_Physician": "2019-08-24T14:15:22Z",
  • "discharge_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "ex_Code": "string",
  • "exceed_Max": true,
  • "exhaust_Date": "2019-08-24T14:15:22Z",
  • "expected_Typical_Duration": 0,
  • "ficA_Percent": 0.1,
  • "federal_Withheld": 0.1,
  • "followup_Date": "2019-08-24T14:15:22Z",
  • "followup_Ex_Code": "string",
  • "group_ID": "string",
  • "image_Number_1": "string",
  • "image_Number_2": "string",
  • "image_Number_3": "string",
  • "image_Number_4": "string",
  • "include_Return_To_Work": true,
  • "include_Waiting_Period": true,
  • "include_Waiting_Period_In_Max": true,
  • "job_Type": "string",
  • "ltD_Effective_Date": "2019-08-24T14:15:22Z",
  • "ltD_Packet_Date": "2019-08-24T14:15:22Z",
  • "last_Day_Worked": "2019-08-24T14:15:22Z",
  • "last_Physician_Warrant_Date": "2019-08-24T14:15:22Z",
  • "liability_Injury": 0,
  • "mail_To": "s",
  • "max_Disability_Days": 0,
  • "member_Seq": "st",
  • "overpayment_Deduction": 0.1,
  • "overpayment_Ex_Code": "string",
  • "overpayment_Total": 0.1,
  • "partial_Disability": true,
  • "pay_To": "s",
  • "payment_Days": 0,
  • "payment_Duration": 0,
  • "physician_Return_To_Work": "2019-08-24T14:15:22Z",
  • "plan_ID": "string",
  • "plan_Type": "string",
  • "plan_Type_LTD": true,
  • "received_Date": "2019-08-24T14:15:22Z",
  • "return_To_Work": "2019-08-24T14:15:22Z",
  • "rollup_Waiting_Period": true,
  • "scd": true,
  • "salary_Cont_Ex_Code": "string",
  • "salary_Cont_From": "2019-08-24T14:15:22Z",
  • "salary_Cont_Paid": true,
  • "salary_Cont_Thru": "2019-08-24T14:15:22Z",
  • "sick_Time_Ex_Code": "string",
  • "sick_Time_From": "2019-08-24T14:15:22Z",
  • "sick_Time_Paid": true,
  • "sick_Time_Thru": "2019-08-24T14:15:22Z",
  • "state_Withheld": 0.1,
  • "subscriber_ID": "string",
  • "type_Of_Surgery": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "vacation_Ex_Code": "string",
  • "vacation_From": "2019-08-24T14:15:22Z",
  • "vacation_Paid": true,
  • "vacation_Thru": "2019-08-24T14:15:22Z",
  • "waiting_Period": 0,
  • "waiting_Period_Ex_Code": "string",
  • "waive_Waiting_Period": true
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List ClaimDisability

Lists all ClaimDisability

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-disabilities
Request samples 
Response samples 
No sample
Get ClaimDisability
Gets ClaimDisability


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
batchNumber
required
integer <int32> 
Batch Number


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/claim-disabilities/{batchNumber}
Request samples 
Response samples 
No sample
Update ClaimDisability
Updates a specific ClaimDisability.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
batchNumber
required
integer <int32> 
Batch Number


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
batch_Number
required
integer <int32> 
 
admit_Date
string or null <date-time> 
 
apply_Extension
integer or null <int32> 
 
apply_Extension_Ex_Code
string or null  <= 8 characters 
 
attended_Physician
string or null <date-time> 
 
birth_Date
string or null <date-time> 
 
closure_Effective_Date
string or null <date-time> 
 
delivery_Date
string or null <date-time> 
 
delivery_Type
string or null  <= 1 characters 
 
dep_SSDI_End_Date
string or null <date-time> 
 
description
string or null  <= 512 characters 
 
diagnostic_Code1
string or null  <= 8 characters 
 
diagnostic_Code2
string or null  <= 8 characters 
 
diagnostic_Code_Type
string or null  <= 16 characters 
 
disability_Pay_Through_Day
integer or null <int32> 
 
disability_Type
string or null  <= 1 characters 
 
disabled_By_Physician
string or null <date-time> 
 
discharge_Date
string or null <date-time> 
 
entry_Date
string <date-time> 
 
entry_User
string or null  <= 20 characters 
 
ex_Code
string or null  <= 8 characters 
 
exceed_Max
required
boolean
 
exhaust_Date
string or null <date-time> 
 
expected_Typical_Duration
integer or null <int32> 
 
ficA_Percent
number or null <double> 
 
federal_Withheld
number or null <double> 
 
followup_Date
string or null <date-time> 
 
followup_Ex_Code
string or null  <= 8 characters 
 
group_ID
string or null  <= 20 characters 
 
image_Number_1
string or null  <= 64 characters 
 
image_Number_2
string or null  <= 64 characters 
 
image_Number_3
string or null  <= 64 characters 
 
image_Number_4
string or null  <= 64 characters 
 
include_Return_To_Work
required
boolean
 
include_Waiting_Period
required
boolean
 
include_Waiting_Period_In_Max
required
boolean
 
job_Type
string or null  <= 6 characters 
 
ltD_Effective_Date
string or null <date-time> 
 
ltD_Packet_Date
string or null <date-time> 
 
last_Day_Worked
string or null <date-time> 
 
last_Physician_Warrant_Date
string or null <date-time> 
 
liability_Injury
integer or null <int32> 
 
mail_To
string or null  <= 1 characters 
 
max_Disability_Days
integer or null <int32> 
 
member_Seq
string or null  <= 2 characters 
 
overpayment_Deduction
number or null <double> 
 
overpayment_Ex_Code
string or null  <= 8 characters 
 
overpayment_Total
number or null <double> 
 
partial_Disability
required
boolean
 
pay_To
string or null  <= 1 characters 
 
payment_Days
integer or null <int32> 
 
payment_Duration
integer or null <int32> 
 
physician_Return_To_Work
string or null <date-time> 
 
plan_ID
string or null  <= 20 characters 
 
plan_Type
string or null  <= 6 characters 
 
plan_Type_LTD
required
boolean
 
received_Date
string or null <date-time> 
 
return_To_Work
string or null <date-time> 
 
rollup_Waiting_Period
required
boolean
 
scd
required
boolean
 
salary_Cont_Ex_Code
string or null  <= 8 characters 
 
salary_Cont_From
string or null <date-time> 
 
salary_Cont_Paid
required
boolean
 
salary_Cont_Thru
string or null <date-time> 
 
sick_Time_Ex_Code
string or null  <= 8 characters 
 
sick_Time_From
string or null <date-time> 
 
sick_Time_Paid
required
boolean
 
sick_Time_Thru
string or null <date-time> 
 
state_Withheld
number or null <double> 
 
subscriber_ID
string or null  <= 20 characters 
 
type_Of_Surgery
string or null  <= 6 characters 
 
update_Date
string <date-time> 
 
update_User
string or null  <= 20 characters 
 
vacation_Ex_Code
string or null  <= 8 characters 
 
vacation_From
string or null <date-time> 
 
vacation_Paid
required
boolean
 
vacation_Thru
string or null <date-time> 
 
waiting_Period
integer or null <int32> 
 
waiting_Period_Ex_Code
string or null  <= 8 characters 
 
waive_Waiting_Period
required
boolean
 
Responses 
200
Success


401
Unauthorized


put/claim-disabilities/{batchNumber}
Request samples 
{
  • "batch_Number": 0,
  • "admit_Date": "2019-08-24T14:15:22Z",
  • "apply_Extension": 0,
  • "apply_Extension_Ex_Code": "string",
  • "attended_Physician": "2019-08-24T14:15:22Z",
  • "birth_Date": "2019-08-24T14:15:22Z",
  • "closure_Effective_Date": "2019-08-24T14:15:22Z",
  • "delivery_Date": "2019-08-24T14:15:22Z",
  • "delivery_Type": "s",
  • "dep_SSDI_End_Date": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "diagnostic_Code1": "string",
  • "diagnostic_Code2": "string",
  • "diagnostic_Code_Type": "string",
  • "disability_Pay_Through_Day": 0,
  • "disability_Type": "s",
  • "disabled_By_Physician": "2019-08-24T14:15:22Z",
  • "discharge_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "ex_Code": "string",
  • "exceed_Max": true,
  • "exhaust_Date": "2019-08-24T14:15:22Z",
  • "expected_Typical_Duration": 0,
  • "ficA_Percent": 0.1,
  • "federal_Withheld": 0.1,
  • "followup_Date": "2019-08-24T14:15:22Z",
  • "followup_Ex_Code": "string",
  • "group_ID": "string",
  • "image_Number_1": "string",
  • "image_Number_2": "string",
  • "image_Number_3": "string",
  • "image_Number_4": "string",
  • "include_Return_To_Work": true,
  • "include_Waiting_Period": true,
  • "include_Waiting_Period_In_Max": true,
  • "job_Type": "string",
  • "ltD_Effective_Date": "2019-08-24T14:15:22Z",
  • "ltD_Packet_Date": "2019-08-24T14:15:22Z",
  • "last_Day_Worked": "2019-08-24T14:15:22Z",
  • "last_Physician_Warrant_Date": "2019-08-24T14:15:22Z",
  • "liability_Injury": 0,
  • "mail_To": "s",
  • "max_Disability_Days": 0,
  • "member_Seq": "st",
  • "overpayment_Deduction": 0.1,
  • "overpayment_Ex_Code": "string",
  • "overpayment_Total": 0.1,
  • "partial_Disability": true,
  • "pay_To": "s",
  • "payment_Days": 0,
  • "payment_Duration": 0,
  • "physician_Return_To_Work": "2019-08-24T14:15:22Z",
  • "plan_ID": "string",
  • "plan_Type": "string",
  • "plan_Type_LTD": true,
  • "received_Date": "2019-08-24T14:15:22Z",
  • "return_To_Work": "2019-08-24T14:15:22Z",
  • "rollup_Waiting_Period": true,
  • "scd": true,
  • "salary_Cont_Ex_Code": "string",
  • "salary_Cont_From": "2019-08-24T14:15:22Z",
  • "salary_Cont_Paid": true,
  • "salary_Cont_Thru": "2019-08-24T14:15:22Z",
  • "sick_Time_Ex_Code": "string",
  • "sick_Time_From": "2019-08-24T14:15:22Z",
  • "sick_Time_Paid": true,
  • "sick_Time_Thru": "2019-08-24T14:15:22Z",
  • "state_Withheld": 0.1,
  • "subscriber_ID": "string",
  • "type_Of_Surgery": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "vacation_Ex_Code": "string",
  • "vacation_From": "2019-08-24T14:15:22Z",
  • "vacation_Paid": true,
  • "vacation_Thru": "2019-08-24T14:15:22Z",
  • "waiting_Period": 0,
  • "waiting_Period_Ex_Code": "string",
  • "waive_Waiting_Period": true
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete ClaimDisability
Deletes an ClaimDisability


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
batchNumber
required
integer <int32> 
Batch Number


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/claim-disabilities/{batchNumber}
Request samples 
Create or Update Batch ClaimDisability
Create or Update multiple ClaimDisability 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: 
required
 Array 
batch_Number
required
integer <int32> 
 
admit_Date
string or null <date-time> 
 
apply_Extension
integer or null <int32> 
 
apply_Extension_Ex_Code
string or null  <= 8 characters 
 
attended_Physician
string or null <date-time> 
 
birth_Date
string or null <date-time> 
 
closure_Effective_Date
string or null <date-time> 
 
delivery_Date
string or null <date-time> 
 
delivery_Type
string or null  <= 1 characters 
 
dep_SSDI_End_Date
string or null <date-time> 
 
description
string or null  <= 512 characters 
 
diagnostic_Code1
string or null  <= 8 characters 
 
diagnostic_Code2
string or null  <= 8 characters 
 
diagnostic_Code_Type
string or null  <= 16 characters 
 
disability_Pay_Through_Day
integer or null <int32> 
 
disability_Type
string or null  <= 1 characters 
 
disabled_By_Physician
string or null <date-time> 
 
discharge_Date
string or null <date-time> 
 
entry_Date
string <date-time> 
 
entry_User
string or null  <= 20 characters 
 
ex_Code
string or null  <= 8 characters 
 
exceed_Max
required
boolean
 
exhaust_Date
string or null <date-time> 
 
expected_Typical_Duration
integer or null <int32> 
 
ficA_Percent
number or null <double> 
 
federal_Withheld
number or null <double> 
 
followup_Date
string or null <date-time> 
 
followup_Ex_Code
string or null  <= 8 characters 
 
group_ID
string or null  <= 20 characters 
 
image_Number_1
string or null  <= 64 characters 
 
image_Number_2
string or null  <= 64 characters 
 
image_Number_3
string or null  <= 64 characters 
 
image_Number_4
string or null  <= 64 characters 
 
include_Return_To_Work
required
boolean
 
include_Waiting_Period
required
boolean
 
include_Waiting_Period_In_Max
required
boolean
 
job_Type
string or null  <= 6 characters 
 
ltD_Effective_Date
string or null <date-time> 
 
ltD_Packet_Date
string or null <date-time> 
 
last_Day_Worked
string or null <date-time> 
 
last_Physician_Warrant_Date
string or null <date-time> 
 
liability_Injury
integer or null <int32> 
 
mail_To
string or null  <= 1 characters 
 
max_Disability_Days
integer or null <int32> 
 
member_Seq
string or null  <= 2 characters 
 
overpayment_Deduction
number or null <double> 
 
overpayment_Ex_Code
string or null  <= 8 characters 
 
overpayment_Total
number or null <double> 
 
partial_Disability
required
boolean
 
pay_To
string or null  <= 1 characters 
 
payment_Days
integer or null <int32> 
 
payment_Duration
integer or null <int32> 
 
physician_Return_To_Work
string or null <date-time> 
 
plan_ID
string or null  <= 20 characters 
 
plan_Type
string or null  <= 6 characters 
 
plan_Type_LTD
required
boolean
 
received_Date
string or null <date-time> 
 
return_To_Work
string or null <date-time> 
 
rollup_Waiting_Period
required
boolean
 
scd
required
boolean
 
salary_Cont_Ex_Code
string or null  <= 8 characters 
 
salary_Cont_From
string or null <date-time> 
 
salary_Cont_Paid
required
boolean
 
salary_Cont_Thru
string or null <date-time> 
 
sick_Time_Ex_Code
string or null  <= 8 characters 
 
sick_Time_From
string or null <date-time> 
 
sick_Time_Paid
required
boolean
 
sick_Time_Thru
string or null <date-time> 
 
state_Withheld
number or null <double> 
 
subscriber_ID
string or null  <= 20 characters 
 
type_Of_Surgery
string or null  <= 6 characters 
 
update_Date
string <date-time> 
 
update_User
string or null  <= 20 characters 
 
vacation_Ex_Code
string or null  <= 8 characters 
 
vacation_From
string or null <date-time> 
 
vacation_Paid
required
boolean
 
vacation_Thru
string or null <date-time> 
 
waiting_Period
integer or null <int32> 
 
waiting_Period_Ex_Code
string or null  <= 8 characters 
 
waive_Waiting_Period
required
boolean
 
Responses 
207
Success


401
Unauthorized


put/claim-disabilities-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}