APIs for VBASoftware
/
Delete SubEnrollmentRider
VBASoftware (v1)
Download OpenAPI description
Languages
Servers
VBAPI VBASoftware
https://vbapi.vbasoftware.com/vbasoftware/
Bodyrequired
- application/json
- text/json
- application/*+json
References the SubenrollmentPlan.Subscriber_ID value in the parent table.
References the SubenrollmentPlan.Group_ID value in the parent table.
References the SubenrollmentPlan.Division_ID value in the parent table.
References the SubenrollmentPlan.Group_Coverage_Start value in the parent table.
References the SubenrollmentPlan.Start_Date value in the parent table.
References the SubenrollmentPlan.Plan_ID value in the parent table.
References the SubenrollmentPlan.Plan_Start value in the parent table.
References the BenefitCodes.Benefit_Code value that is flagged as a Rider on this Plan and indicates the optional coverage this member has enrolled in.
By default, billing calculations use the insured demographic information for determing the settings. This value allows another member of the family to be used when determining those calculations.
Indicates the Employee Contribution amount that is used during Diability processing to properly take tax amounts.
Indicates if the Emploee Contribution amount entered is a Pct or flat amount. Note: The database will apply a default value of False for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of False to meet the API requirements and ensure that the functionality occurs as expected.
This is the volume used in intial volume calculations. This number can either be a flat amount or a percentage of the Member's gross salary.
Indicates that the number from the 'Initial Volume' field represents a percentage of the Member's salary. Salaries are found from a Member's 'Financial' detail dropdown. 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.
Billing setting indicating that the employee age is used in all calculations that are age based for this specific Rider. 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.
The 'Gaurantee Issue' option is an alternative to the 'Use Scale' option. It offers a convenient secondary option for min/max when calculating Rider volume. Plan type must include the "Life AD&D" indicator. 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.
This option tells the system to calculate the 'Volume' using the Group volume rules. Checking this box will display an elipsis that when clicked will explain the volume calculation. Plan type must include the "Life AD&D" indicator. 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.
- VBAPI VBASoftwarehttps://vbapi.vbasoftware.com/vbasoftware/subscribers/{subscriberID}/enrollments/{groupID}/{divisionID}/{groupCoverageStart}/{startDate}/plans/{planID}/{planStart}/riders/{benefitCode}/{fromDate}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
'https://vbapi.vbasoftware.com/vbasoftware/subscribers/{subscriberID}/enrollments/{groupID}/{divisionID}/{groupCoverageStart}/{startDate}/plans/{planID}/{planStart}/riders/{benefitCode}/{fromDate}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-H 'vbasoftware-database: string' \
-H 'x-api-key: YOUR_API_KEY_HERE' \
-d '{
"subscriber_ID": "string",
"group_ID": "string",
"division_ID": "string",
"group_Coverage_Start": "2019-08-24T14:15:22Z",
"start_Date": "2019-08-24T14:15:22Z",
"plan_ID": "string",
"plan_Start": "2019-08-24T14:15:22Z",
"benefit_Code": "string",
"from_Date": "2019-08-24T14:15:22Z",
"billing_Member_Seq_Override": "st",
"employee_Contribution": 0.1,
"employee_Contribution_Pct": true,
"entry_Date": "2019-08-24T14:15:22Z",
"entry_User": "string",
"external_ID": "string",
"initial_Volume": 0.1,
"initial_Volume_Salary_Pct": true,
"ltC_Daily_Benefit_Amount": 0.1,
"ltC_Lifetime_Max_Amount": 0.1,
"ltC_Lifetime_Max_Days": 0,
"ltC_Lifetime_Max_Years": 0,
"ltC_Monthly_Benefit_Amount": 0.1,
"new_CommissionAgencyRep_Key": 0,
"original_CommissionAgencyRep_Key": 0,
"thru_Date": "2019-08-24T14:15:22Z",
"update_Date": "2019-08-24T14:15:22Z",
"update_User": "string",
"use_Employee_Age": true,
"use_GI_Volume_Min_Max": true,
"use_Volume_Scale": true,
"volume": 0.1
}'Response
No response example- VBAPI VBASoftwarehttps://vbapi.vbasoftware.com/vbasoftware/subscribers/{subscriberID}/enrollments/{groupID}/{divisionID}/{groupCoverageStart}/{startDate}/plans/{planID}/{planStart}/riders/{benefitCode}/{fromDate}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X DELETE \
'https://vbapi.vbasoftware.com/vbasoftware/subscribers/{subscriberID}/enrollments/{groupID}/{divisionID}/{groupCoverageStart}/{startDate}/plans/{planID}/{planStart}/riders/{benefitCode}/{fromDate}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'vbasoftware-database: string' \
-H 'x-api-key: YOUR_API_KEY_HERE'Body
- application/json
- text/json
- application/*+json
References the SubenrollmentPlan.Subscriber_ID value in the parent table.
References the SubenrollmentPlan.Group_ID value in the parent table.
References the SubenrollmentPlan.Division_ID value in the parent table.
References the SubenrollmentPlan.Group_Coverage_Start value in the parent table.
References the SubenrollmentPlan.Start_Date value in the parent table.
References the SubenrollmentPlan.Plan_ID value in the parent table.
References the SubenrollmentPlan.Plan_Start value in the parent table.
References the BenefitCodes.Benefit_Code value that is flagged as a Rider on this Plan and indicates the optional coverage this member has enrolled in.
By default, billing calculations use the insured demographic information for determing the settings. This value allows another member of the family to be used when determining those calculations.
Indicates the Employee Contribution amount that is used during Diability processing to properly take tax amounts.
Indicates if the Emploee Contribution amount entered is a Pct or flat amount. Note: The database will apply a default value of False for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of False to meet the API requirements and ensure that the functionality occurs as expected.
This is the volume used in intial volume calculations. This number can either be a flat amount or a percentage of the Member's gross salary.
Indicates that the number from the 'Initial Volume' field represents a percentage of the Member's salary. Salaries are found from a Member's 'Financial' detail dropdown. 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.
Billing setting indicating that the employee age is used in all calculations that are age based for this specific Rider. 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.
The 'Gaurantee Issue' option is an alternative to the 'Use Scale' option. It offers a convenient secondary option for min/max when calculating Rider volume. Plan type must include the "Life AD&D" indicator. 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.
This option tells the system to calculate the 'Volume' using the Group volume rules. Checking this box will display an elipsis that when clicked will explain the volume calculation. Plan type must include the "Life AD&D" indicator. 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.
The Member's 'Volume' within the selected Rider benefit on the enrollment. The Member Enrollment 'Volume' has no impact on invoicing.
- VBAPI VBASoftwarehttps://vbapi.vbasoftware.com/vbasoftware/subscribers/{subscriberID}/enrollments/{groupID}/{divisionID}/{groupCoverageStart}/{startDate}/plans/{planID}/{planStart}/riders-batch
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
'https://vbapi.vbasoftware.com/vbasoftware/subscribers/{subscriberID}/enrollments/{groupID}/{divisionID}/{groupCoverageStart}/{startDate}/plans/{planID}/{planStart}/riders-batch' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-H 'vbasoftware-database: string' \
-H 'x-api-key: YOUR_API_KEY_HERE' \
-d '[
{
"subscriber_ID": "string",
"group_ID": "string",
"division_ID": "string",
"group_Coverage_Start": "2019-08-24T14:15:22Z",
"start_Date": "2019-08-24T14:15:22Z",
"plan_ID": "string",
"plan_Start": "2019-08-24T14:15:22Z",
"benefit_Code": "string",
"from_Date": "2019-08-24T14:15:22Z",
"billing_Member_Seq_Override": "st",
"employee_Contribution": 0.1,
"employee_Contribution_Pct": true,
"entry_Date": "2019-08-24T14:15:22Z",
"entry_User": "string",
"external_ID": "string",
"initial_Volume": 0.1,
"initial_Volume_Salary_Pct": true,
"ltC_Daily_Benefit_Amount": 0.1,
"ltC_Lifetime_Max_Amount": 0.1,
"ltC_Lifetime_Max_Days": 0,
"ltC_Lifetime_Max_Years": 0,
"ltC_Monthly_Benefit_Amount": 0.1,
"new_CommissionAgencyRep_Key": 0,
"original_CommissionAgencyRep_Key": 0,
"thru_Date": "2019-08-24T14:15:22Z",
"update_Date": "2019-08-24T14:15:22Z",
"update_User": "string",
"use_Employee_Age": true,
"use_GI_Volume_Min_Max": true,
"use_Volume_Scale": true,
"volume": 0.1
}
]'Response
No response example