APIs for VBASoftware
VBASoftware (v1)
- application/json
- text/json
- application/*+json
The user for which this request is executed on behalf of.
The current Subscriber_ID that will be changed.
- VBAPI VBASoftwarehttps://vbapi.vbasoftware.com/vbasoftware/subscribers/{subscriberID}/change-id
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://vbapi.vbasoftware.com/vbasoftware/subscribers/{subscriberID}/change-id' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-H 'vbasoftware-database: string' \
-H 'x-api-key: YOUR_API_KEY_HERE' \
-d '{
"user_ID": "string",
"current_Subscriber_ID": "string",
"new_Subscriber_ID": "string"
}'- application/json
- text/json
- application/*+json
The user for which this request is executed on behalf of.
The Subscirber ID of the Member being disenrolled. You can get the Subscriber ID via the SearchConfig process using ENROLLMENT searchConfigId (https://vbapi-docs.vbasoftware.com/developer-portal/search/).
The Member Sequence of the Member being disenrolled. If this is a Subscriber Disenroll, the Member Sequence provided is the Insured Member Sequence. You can get the Member Seq via the SearchConfig process using ENROLLMENT searchConfigId (https://vbapi-docs.vbasoftware.com/developer-portal/search/).
The Group ID of the current Subenrollment record (the members current or most recent enrollment). You can use the List SubEnrollment API (https://vbapi.vbasoftware.com/vbasoftware/subscribers/{subscriberID}/enrollments) to get the values you need.
The Division ID of the current Subenrollment record (the members current or most recent enrollment). You can use the List SubEnrollment API (https://vbapi.vbasoftware.com/vbasoftware/subscribers/{subscriberID}/enrollments) to get the values you need.
The Group Coverage Start of the current Subenrollment record (the members current or most recent enrollment). You can use the List SubEnrollment API (https://vbapi.vbasoftware.com/vbasoftware/subscribers/{subscriberID}/enrollments) to get the values you need. This is only required on Subscriber/Member Disenrolls, for Group/Division Disenroll, this can be blank.
The Start Date of the current Subenrollment record (the members current or most recent enrollment). You can use the List SubEnrollment API (https://vbapi.vbasoftware.com/vbasoftware/subscribers/{subscriberID}/enrollments) to get the values you need. This is only required on Subscriber/Member Disenrolls, for Group/Division Disenroll, this can be blank.
Term Date is an informational field used in some reports. It doesn't impact the process but is often populated with the same value as the Disenroll Date.
The Subscriber value is a flag indicating if the member being disenrolled is the Insured. Send 1 if this is the Subscriber, send 0 if this is a Spouse/Dependent/Other. This is only required on Subscriber/Member Disenrolls, for Group/Division Disenroll, this can be blank.
Reason ID is the reson for this disenroll. You can get a list of valid Reason IDs from the List Reasons API (https://vbapi.vbasoftware.com/vbasoftware/reasons).
When not using the PremRates list of PremRate_Key values, this indicates the COBRA Premium for some reports.
The DisenrollFamily indicator lets the Disenroll process know exactly how to perform the Disenroll. You can get a list of valid DisenrollFamily values from the List Disenrollment Family Options API (https://vbapi.vbasoftware.com/vbasoftware/disenroll-family-options).
The TerminateAuth flag lets us know if Auths approved or requested beyond the Disenroll Date should be cancelled.
The DisenrollFuture indicator will tell us how to handle any future enrollments beyond the Disenroll Date related to this disenroll. The valid values are: 2 - Disenroll Future Enrollments 3 - Do Not Disenroll any Future Enrollments
The list of COBRA Rates associated with this Disenroll process.
- VBAPI VBASoftwarehttps://vbapi.vbasoftware.com/vbasoftware/subscribers/{subscriberID}/members/{memberSeq}/disenroll
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://vbapi.vbasoftware.com/vbasoftware/subscribers/{subscriberID}/members/{memberSeq}/disenroll' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-H 'vbasoftware-database: string' \
-H 'x-api-key: YOUR_API_KEY_HERE' \
-d '{
"user_ID": "string",
"subscriber_ID": "string",
"member_Seq": "st",
"group_ID": "string",
"division_ID": "string",
"group_Coverage_Start": "2019-08-24T14:15:22Z",
"start_Date": "2019-08-24T14:15:22Z",
"disenroll_Date": "2019-08-24T14:15:22Z",
"term_Date": "2019-08-24T14:15:22Z",
"subscriber": true,
"reason_ID": 0,
"premium": 0.1,
"disenrollFamily": 0,
"terminateAuth": true,
"disenrollFuture": 0,
"premRates": [
0
],
"premInvoiceAdjustments": [
{
"invoiceAdjustment_Key": 0,
"adjustment_Amount": 0.1,
"adjustment_Comment": "string",
"adjustment_PremRate_Key": 0,
"adjustment_Reason": 0,
"adjustment_Received": 0.1,
"auto_Adjust": true,
"avoid_Retro": true,
"division_ID": "string",
"effective_Date": "2019-08-24T14:15:22Z",
"entry_Date": "2019-08-24T14:15:22Z",
"entry_User": "string",
"group_ID": "string",
"invoice_Key": 0,
"min_Max_Adjust": true,
"negative_Adjustment": true,
"premRate_Key": 0,
"retro_Adjustment_Invoice_Key": 0,
"selfAdmin_Adj": true,
"subscriber_ID": "string",
"update_Date": "2019-08-24T14:15:22Z",
"update_User": "string",
"use_Premium": true,
"volume": 0.1
}
]
}'No response example- VBAPI VBASoftwarehttps://vbapi.vbasoftware.com/vbasoftware/subscribers/{subscriberID}/as-of-date/{asOfDate}/disenroll-adjustments
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://vbapi.vbasoftware.com/vbasoftware/subscribers/{subscriberID}/as-of-date/{asOfDate}/disenroll-adjustments' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'vbasoftware-database: string' \
-H 'x-api-key: YOUR_API_KEY_HERE'No response example