Members

List Plan Year by Member

List Plan Years available for a Member from both Group Plan Year and the Member Plan Year if applicable.

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
subscriberID
required
string

Subscriber ID

memberSeq
required
string

Member Seq

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/subscribers/{subscriberID}/members/{memberSeq}/list-plan-year
Request samples 
Response samples 
No sample
Benefit Inquiry Advanced API 
Get a consolidated payload of benefit information, accumulator information, and eligility.


SecurityapiKeyAuth and bearerAuth 
Request 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
subscriber_ID
string or null
 
member_Seq
string or null
 
group_ID
string or null
 
plan_ID
string or null
 
plan_Year
string or null
 
diag_Code
string or null
 
diag_Code_Type
string or null
 
procedure_Code
string or null
 
place_Of_Service
string or null
 
serviceTypes
Array of strings or null
 
taxonomy_Code
string or null
 
as_Of_Date
string <date-time> 
 
Responses 
200
Success


401
Unauthorized


post/enrollment-benefit-inquiry
Request samples 
{
  • "subscriber_ID": "string",
  • "member_Seq": "string",
  • "group_ID": "string",
  • "plan_ID": "string",
  • "plan_Year": "string",
  • "diag_Code": "string",
  • "diag_Code_Type": "string",
  • "procedure_Code": "string",
  • "place_Of_Service": "string",
  • "serviceTypes": [
    ],
  • "taxonomy_Code": "string",
  • "as_Of_Date": "2019-08-24T14:15:22Z"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Auto-Assign Primary Care Physician
Automatically assigns a Primary care Physician to Members based on the Criteria found in the EnrollmentPCPAutoAssign entity passed in the body.


SecurityapiKeyAuth and bearerAuth 
Request 
query Parameters
requestingUserId
string
Requesting User


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
required
object (OptionCriteria) 
 
required
Array of objects (GroupCriteria) 
 
required
Array of objects (NetworkCriteria) 
 
Array of objects or null (SpecialtyCriteria) 
 
Array of objects or null (PracticeTypeCriteria) 
 
Array of objects or null (IDCodeCriteria) 
 
Responses 
204
Success


401
Unauthorized


post/auto-assign-primary-care-physician
Request samples 
{
  • "options": {
    },
  • "groupCriterias": [
    ],
  • "networkCriterias": [
    ],
  • "specialtyCriterias": [
    ],
  • "practiceTypeCriterias": [
    ],
  • "idCodeCriterias": [
    ]
}
List Members with Auto-Assign Primary Care Physician
Get a list of Members that will be automatically assigned a Primary care Physician.


SecurityapiKeyAuth and bearerAuth 
Request 
query Parameters
runDate
string <date-time> 
Run Date


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/auto-assign-primary-care-physician-members
Request samples 
Response samples 
No sample
List Providers that are eligible for PCP Auto-Assign
Get a list of Providers that are eligible for PCP Auto-Assign for the given Networks and Provider Types.


SecurityapiKeyAuth and bearerAuth 
Request 
query Parameters
networks
string
Networks as a comma separated list of strings


 
practiceTypes
string
Practice Types  as a comma separated list of strings


 
expirationDate
string <date-time> 
Expiration Date


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/auto-assign-primary-care-physician-providers
Request samples 
Response samples 
No sample
Create Members
Creates a new Members


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberID
required
string
Subscriber ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
subscriber_ID
required
string  [ 1 .. 9 ] characters 
References the Subscribers.Subscriber_ID value in the parent table.


 
member_Seq
string or null  <= 2 characters 
Sequential identifier assigned to each Member of this family. In combination with Subscriber_ID, creates a unique identifier.
During creation, if you pass a value for this field, the system will attemot to use the value.   If you do not include a value (eg, leave null), the system will generate a value for you.  The generated value will be the total_count_of_members for the subscriber_id + 1.


 
access_Code
string or null  <= 32 characters 
Access code defined by the User.


 
adult_Child
string or null  <= 1 characters 
Designates whether the Member is an adult or child. This may be important in cases where premiums differ between adult and child members.


 
adult_Dependent
required
boolean
This flag identifies the Member has been approved to continue coverage past the 'Cutoff Age' defined at the 'Group level'.


 
adult_Dependent_End
string or null <date-time> 
End date of the Member's approved 'Adult Dependent Status'. Only claims with a date of service up to this date will be allowed to process through adjudication.


 
alternate_ID
string or null  <= 32 characters 
Allows the User to assign an 'Alternate ID' to the Member.


 
birth_Date
string or null <date-time> 
Date of birth of the Member.


 
continue_Coverage
required
boolean
Allows claims to pay past the disenroll date. Below are some examples: (1) A member terminates coverage but is still inpatient. Checking this box, and designating the end of inpatient stay with the 'Thru Date', will allow the claim(s) to pay during this time. The member will still reflect as inactive. (2) A member is on 'Long Term Disability'. Coverage terminates, but payments still need to be made. Same steps as example (1) above.


 
continue_Coverage_End_Date
string or null <date-time> 
End date of the 'Continued Coverage' period.


 
continue_Coverage_Ex_Code
string or null  <= 6 characters 
Allows for an Ex Code to be assigned when a claim is processed after the disenroll date but within the 'Continue Coverage' period.


 
coverage_Type
string or null  <= 32 characters 
Indicates the type of coverage ('Open Enrollment', 'Late Enrollment', etc.).


 
credible_Coverage
integer or null <int32> 
Total number of days for the Credible Coverage period.


 
creditable_Coverage_End
string or null <date-time> 
End date of the Member's 'Credible Coverage' period. These dates are used in the stock ‘Creditable Coverage’ COBRA reports.


 
creditable_Coverage_Start
string or null <date-time> 
Start date of the Member's 'Credible Coverage' period. These dates are used in the stock ‘Creditable Coverage’ COBRA reports.


 
date_Enrolled
string or null <date-time> 
Original enrollment date of the Member.


 
date_Of_Death
string or null <date-time> 
Date of death of the Member.


 
disenroll_Date
string or null <date-time> 
Disenrollment date of the Member.


 
ethnicity_Code
string or null  <= 1 characters 
Ethnicity of the Member.


 
first_Name
string or null  <= 25 characters 
First name of the Member.


 
height
integer or null <int32> 
The members height in inches.


 
initial_Volume
number or null <double> 
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.


 
initial_Volume_Salary_Pct
required
boolean
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.


 
last_Name
string or null  <= 25 characters 
Last name of the Member.


 
marital_Status
string or null  <= 1 characters 
Marital status of the Member.


 
middle_Name
string or null  <= 25 characters 
Middle initial of the Member.


 
name_Suffix
string or null  <= 16 characters 
Suffix or title associated with the Member.


 
notes
string or null
No longer in use. Replaced by NotData, NoteSource and NoteReference tables.


 
other_Insurance
required
boolean
An optional reminder that the Member has an 'Other Insurance'. [Informational Only]


 
other_Name
string or null  <= 96 characters 
Information only used in custom reporting.


 
pend_Ex_Code
string or null  <= 6 characters 
Assigns an Ex Code that can be applied to newly adjudicated Subscriber claims.


 
pend_Flag
string or null  <= 1 characters 
While active, assigned Ex Codes will be applied to any newly adjudicated Subscriber claims.


 
plan_Year_Frequency
integer or null <int32> 
Defines the number of months/years covered by the Member's plan.


 
plan_Year_Frequency_Type
string or null  <= 1 characters 
Specifies the timeframe the Member Plan Year will use.


 
pre_Exist
string or null  <= 1 characters 
Identifies whether the Member has any pre-existing conditions.


 
pre_Exist_End
string or null <date-time> 
End date of pre-existing conditions in relation to the Member's plan.


 
pre_Exist_Ex_Code
string or null  <= 6 characters 
Assigns an Ex Code to pre-existing Claims.


 
relationship
string or null  <= 12 characters 
Relationship of the Member to the Subscriber.


 
ssn
string or null  <= 32 characters 
Social security number of the Member.


 
salutation
string or null  <= 16 characters 
Information only used in custom reporting.


 
sex
string or null  <= 1 characters 
Biological sex of the Member.


 
smoker
required
boolean
Designates whether the Member is a smoker. This may be important in cases where premiums differ between smokers and non-smokers.


 
student
string or null  <= 1 characters 
Identifies that the Member meets the 'Student Status' requirements.


 
student_End
string or null <date-time> 
End date of the Member's approved 'Student Status'. Only claims with a date of service up to this date will be allowed to process through adjudication.


 
unique_ID
string or null  <= 32 characters 
Unique identifier assigned to the Member by the User.


 
use_Member_Plan_Year
required
boolean
Identifies the Member's Plan year if it differs from the group. The User is required to define a number of months or years for the Plan. The Member's Plan year will begin on the first day of enrollment.


 
viP_Flag
string or null  <= 1 characters 
VIP status of the Member. This status can be used as a search filter but is otherwise informational only.


 
weight
integer or null <int32> 
The members weight in pounds.


 
Responses 
200
Success


401
Unauthorized


post/subscribers/{subscriberID}/members
Request samples 
{
  • "subscriber_ID": "string",
  • "member_Seq": "st",
  • "access_Code": "string",
  • "adult_Child": "s",
  • "adult_Dependent": true,
  • "adult_Dependent_End": "2019-08-24T14:15:22Z",
  • "alternate_ID": "string",
  • "birth_Date": "2019-08-24T14:15:22Z",
  • "continue_Coverage": true,
  • "continue_Coverage_End_Date": "2019-08-24T14:15:22Z",
  • "continue_Coverage_Ex_Code": "string",
  • "coverage_Type": "string",
  • "credible_Coverage": 0,
  • "creditable_Coverage_End": "2019-08-24T14:15:22Z",
  • "creditable_Coverage_Start": "2019-08-24T14:15:22Z",
  • "date_Enrolled": "2019-08-24T14:15:22Z",
  • "date_Of_Death": "2019-08-24T14:15:22Z",
  • "disenroll_Date": "2019-08-24T14:15:22Z",
  • "ethnicity_Code": "s",
  • "first_Name": "string",
  • "height": 0,
  • "initial_Volume": 0.1,
  • "initial_Volume_Salary_Pct": true,
  • "last_Name": "string",
  • "marital_Status": "s",
  • "middle_Name": "string",
  • "name_Suffix": "string",
  • "notes": "string",
  • "other_Insurance": true,
  • "other_Name": "string",
  • "pend_Ex_Code": "string",
  • "pend_Flag": "s",
  • "plan_Year_Frequency": 0,
  • "plan_Year_Frequency_Type": "s",
  • "pre_Exist": "s",
  • "pre_Exist_End": "2019-08-24T14:15:22Z",
  • "pre_Exist_Ex_Code": "string",
  • "relationship": "string",
  • "ssn": "string",
  • "salutation": "string",
  • "sex": "s",
  • "smoker": true,
  • "student": "s",
  • "student_End": "2019-08-24T14:15:22Z",
  • "unique_ID": "string",
  • "use_Member_Plan_Year": true,
  • "viP_Flag": "s",
  • "weight": 0
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
List Members
Lists all Members for the given subscriberID


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberID
required
string
Subscriber ID


 
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/subscribers/{subscriberID}/members
Request samples 
Response samples 
No sample
Get Members
Gets Members


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberID
required
string
Subscriber ID


 
memberSeq
required
string
Member Seq


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/subscribers/{subscriberID}/members/{memberSeq}
Request samples 
Response samples 
No sample
Update Members
Updates a specific Members.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberID
required
string
Subscriber ID


 
memberSeq
required
string
Member Seq


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
subscriber_ID
required
string  [ 1 .. 9 ] characters 
References the Subscribers.Subscriber_ID value in the parent table.


 
member_Seq
string or null  <= 2 characters 
Sequential identifier assigned to each Member of this family. In combination with Subscriber_ID, creates a unique identifier.
During creation, if you pass a value for this field, the system will attemot to use the value.   If you do not include a value (eg, leave null), the system will generate a value for you.  The generated value will be the total_count_of_members for the subscriber_id + 1.


 
access_Code
string or null  <= 32 characters 
Access code defined by the User.


 
adult_Child
string or null  <= 1 characters 
Designates whether the Member is an adult or child. This may be important in cases where premiums differ between adult and child members.


 
adult_Dependent
required
boolean
This flag identifies the Member has been approved to continue coverage past the 'Cutoff Age' defined at the 'Group level'.


 
adult_Dependent_End
string or null <date-time> 
End date of the Member's approved 'Adult Dependent Status'. Only claims with a date of service up to this date will be allowed to process through adjudication.


 
alternate_ID
string or null  <= 32 characters 
Allows the User to assign an 'Alternate ID' to the Member.


 
birth_Date
string or null <date-time> 
Date of birth of the Member.


 
continue_Coverage
required
boolean
Allows claims to pay past the disenroll date. Below are some examples: (1) A member terminates coverage but is still inpatient. Checking this box, and designating the end of inpatient stay with the 'Thru Date', will allow the claim(s) to pay during this time. The member will still reflect as inactive. (2) A member is on 'Long Term Disability'. Coverage terminates, but payments still need to be made. Same steps as example (1) above.


 
continue_Coverage_End_Date
string or null <date-time> 
End date of the 'Continued Coverage' period.


 
continue_Coverage_Ex_Code
string or null  <= 6 characters 
Allows for an Ex Code to be assigned when a claim is processed after the disenroll date but within the 'Continue Coverage' period.


 
coverage_Type
string or null  <= 32 characters 
Indicates the type of coverage ('Open Enrollment', 'Late Enrollment', etc.).


 
credible_Coverage
integer or null <int32> 
Total number of days for the Credible Coverage period.


 
creditable_Coverage_End
string or null <date-time> 
End date of the Member's 'Credible Coverage' period. These dates are used in the stock ‘Creditable Coverage’ COBRA reports.


 
creditable_Coverage_Start
string or null <date-time> 
Start date of the Member's 'Credible Coverage' period. These dates are used in the stock ‘Creditable Coverage’ COBRA reports.


 
date_Enrolled
string or null <date-time> 
Original enrollment date of the Member.


 
date_Of_Death
string or null <date-time> 
Date of death of the Member.


 
disenroll_Date
string or null <date-time> 
Disenrollment date of the Member.


 
ethnicity_Code
string or null  <= 1 characters 
Ethnicity of the Member.


 
first_Name
string or null  <= 25 characters 
First name of the Member.


 
height
integer or null <int32> 
The members height in inches.


 
initial_Volume
number or null <double> 
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.


 
initial_Volume_Salary_Pct
required
boolean
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.


 
last_Name
string or null  <= 25 characters 
Last name of the Member.


 
marital_Status
string or null  <= 1 characters 
Marital status of the Member.


 
middle_Name
string or null  <= 25 characters 
Middle initial of the Member.


 
name_Suffix
string or null  <= 16 characters 
Suffix or title associated with the Member.


 
notes
string or null
No longer in use. Replaced by NotData, NoteSource and NoteReference tables.


 
other_Insurance
required
boolean
An optional reminder that the Member has an 'Other Insurance'. [Informational Only]


 
other_Name
string or null  <= 96 characters 
Information only used in custom reporting.


 
pend_Ex_Code
string or null  <= 6 characters 
Assigns an Ex Code that can be applied to newly adjudicated Subscriber claims.


 
pend_Flag
string or null  <= 1 characters 
While active, assigned Ex Codes will be applied to any newly adjudicated Subscriber claims.


 
plan_Year_Frequency
integer or null <int32> 
Defines the number of months/years covered by the Member's plan.


 
plan_Year_Frequency_Type
string or null  <= 1 characters 
Specifies the timeframe the Member Plan Year will use.


 
pre_Exist
string or null  <= 1 characters 
Identifies whether the Member has any pre-existing conditions.


 
pre_Exist_End
string or null <date-time> 
End date of pre-existing conditions in relation to the Member's plan.


 
pre_Exist_Ex_Code
string or null  <= 6 characters 
Assigns an Ex Code to pre-existing Claims.


 
relationship
string or null  <= 12 characters 
Relationship of the Member to the Subscriber.


 
ssn
string or null  <= 32 characters 
Social security number of the Member.


 
salutation
string or null  <= 16 characters 
Information only used in custom reporting.


 
sex
string or null  <= 1 characters 
Biological sex of the Member.


 
smoker
required
boolean
Designates whether the Member is a smoker. This may be important in cases where premiums differ between smokers and non-smokers.


 
student
string or null  <= 1 characters 
Identifies that the Member meets the 'Student Status' requirements.


 
student_End
string or null <date-time> 
End date of the Member's approved 'Student Status'. Only claims with a date of service up to this date will be allowed to process through adjudication.


 
unique_ID
string or null  <= 32 characters 
Unique identifier assigned to the Member by the User.


 
use_Member_Plan_Year
required
boolean
Identifies the Member's Plan year if it differs from the group. The User is required to define a number of months or years for the Plan. The Member's Plan year will begin on the first day of enrollment.


 
viP_Flag
string or null  <= 1 characters 
VIP status of the Member. This status can be used as a search filter but is otherwise informational only.


 
weight
integer or null <int32> 
The members weight in pounds.


 
Responses 
200
Success


401
Unauthorized


put/subscribers/{subscriberID}/members/{memberSeq}
Request samples 
{
  • "subscriber_ID": "string",
  • "member_Seq": "st",
  • "access_Code": "string",
  • "adult_Child": "s",
  • "adult_Dependent": true,
  • "adult_Dependent_End": "2019-08-24T14:15:22Z",
  • "alternate_ID": "string",
  • "birth_Date": "2019-08-24T14:15:22Z",
  • "continue_Coverage": true,
  • "continue_Coverage_End_Date": "2019-08-24T14:15:22Z",
  • "continue_Coverage_Ex_Code": "string",
  • "coverage_Type": "string",
  • "credible_Coverage": 0,
  • "creditable_Coverage_End": "2019-08-24T14:15:22Z",
  • "creditable_Coverage_Start": "2019-08-24T14:15:22Z",
  • "date_Enrolled": "2019-08-24T14:15:22Z",
  • "date_Of_Death": "2019-08-24T14:15:22Z",
  • "disenroll_Date": "2019-08-24T14:15:22Z",
  • "ethnicity_Code": "s",
  • "first_Name": "string",
  • "height": 0,
  • "initial_Volume": 0.1,
  • "initial_Volume_Salary_Pct": true,
  • "last_Name": "string",
  • "marital_Status": "s",
  • "middle_Name": "string",
  • "name_Suffix": "string",
  • "notes": "string",
  • "other_Insurance": true,
  • "other_Name": "string",
  • "pend_Ex_Code": "string",
  • "pend_Flag": "s",
  • "plan_Year_Frequency": 0,
  • "plan_Year_Frequency_Type": "s",
  • "pre_Exist": "s",
  • "pre_Exist_End": "2019-08-24T14:15:22Z",
  • "pre_Exist_Ex_Code": "string",
  • "relationship": "string",
  • "ssn": "string",
  • "salutation": "string",
  • "sex": "s",
  • "smoker": true,
  • "student": "s",
  • "student_End": "2019-08-24T14:15:22Z",
  • "unique_ID": "string",
  • "use_Member_Plan_Year": true,
  • "viP_Flag": "s",
  • "weight": 0
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete Members
Deletes an Members


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberID
required
string
Subscriber ID


 
memberSeq
required
string
Member Seq


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/subscribers/{subscriberID}/members/{memberSeq}
Request samples 
Create or Update Batch Members
Create or Update multiple Members at once.  If the entity exists, it will be updated.  If the entity does not exist, it will be created.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberID
required
string
Subscriber ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
subscriber_ID
required
string  [ 1 .. 9 ] characters 
References the Subscribers.Subscriber_ID value in the parent table.


 
member_Seq
string or null  <= 2 characters 
Sequential identifier assigned to each Member of this family. In combination with Subscriber_ID, creates a unique identifier.
During creation, if you pass a value for this field, the system will attemot to use the value.   If you do not include a value (eg, leave null), the system will generate a value for you.  The generated value will be the total_count_of_members for the subscriber_id + 1.


 
access_Code
string or null  <= 32 characters 
Access code defined by the User.


 
adult_Child
string or null  <= 1 characters 
Designates whether the Member is an adult or child. This may be important in cases where premiums differ between adult and child members.


 
adult_Dependent
required
boolean
This flag identifies the Member has been approved to continue coverage past the 'Cutoff Age' defined at the 'Group level'.


 
adult_Dependent_End
string or null <date-time> 
End date of the Member's approved 'Adult Dependent Status'. Only claims with a date of service up to this date will be allowed to process through adjudication.


 
alternate_ID
string or null  <= 32 characters 
Allows the User to assign an 'Alternate ID' to the Member.


 
birth_Date
string or null <date-time> 
Date of birth of the Member.


 
continue_Coverage
required
boolean
Allows claims to pay past the disenroll date. Below are some examples: (1) A member terminates coverage but is still inpatient. Checking this box, and designating the end of inpatient stay with the 'Thru Date', will allow the claim(s) to pay during this time. The member will still reflect as inactive. (2) A member is on 'Long Term Disability'. Coverage terminates, but payments still need to be made. Same steps as example (1) above.


 
continue_Coverage_End_Date
string or null <date-time> 
End date of the 'Continued Coverage' period.


 
continue_Coverage_Ex_Code
string or null  <= 6 characters 
Allows for an Ex Code to be assigned when a claim is processed after the disenroll date but within the 'Continue Coverage' period.


 
coverage_Type
string or null  <= 32 characters 
Indicates the type of coverage ('Open Enrollment', 'Late Enrollment', etc.).


 
credible_Coverage
integer or null <int32> 
Total number of days for the Credible Coverage period.


 
creditable_Coverage_End
string or null <date-time> 
End date of the Member's 'Credible Coverage' period. These dates are used in the stock ‘Creditable Coverage’ COBRA reports.


 
creditable_Coverage_Start
string or null <date-time> 
Start date of the Member's 'Credible Coverage' period. These dates are used in the stock ‘Creditable Coverage’ COBRA reports.


 
date_Enrolled
string or null <date-time> 
Original enrollment date of the Member.


 
date_Of_Death
string or null <date-time> 
Date of death of the Member.


 
disenroll_Date
string or null <date-time> 
Disenrollment date of the Member.


 
ethnicity_Code
string or null  <= 1 characters 
Ethnicity of the Member.


 
first_Name
string or null  <= 25 characters 
First name of the Member.


 
height
integer or null <int32> 
The members height in inches.


 
initial_Volume
number or null <double> 
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.


 
initial_Volume_Salary_Pct
required
boolean
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.


 
last_Name
string or null  <= 25 characters 
Last name of the Member.


 
marital_Status
string or null  <= 1 characters 
Marital status of the Member.


 
middle_Name
string or null  <= 25 characters 
Middle initial of the Member.


 
name_Suffix
string or null  <= 16 characters 
Suffix or title associated with the Member.


 
notes
string or null
No longer in use. Replaced by NotData, NoteSource and NoteReference tables.


 
other_Insurance
required
boolean
An optional reminder that the Member has an 'Other Insurance'. [Informational Only]


 
other_Name
string or null  <= 96 characters 
Information only used in custom reporting.


 
pend_Ex_Code
string or null  <= 6 characters 
Assigns an Ex Code that can be applied to newly adjudicated Subscriber claims.


 
pend_Flag
string or null  <= 1 characters 
While active, assigned Ex Codes will be applied to any newly adjudicated Subscriber claims.


 
plan_Year_Frequency
integer or null <int32> 
Defines the number of months/years covered by the Member's plan.


 
plan_Year_Frequency_Type
string or null  <= 1 characters 
Specifies the timeframe the Member Plan Year will use.


 
pre_Exist
string or null  <= 1 characters 
Identifies whether the Member has any pre-existing conditions.


 
pre_Exist_End
string or null <date-time> 
End date of pre-existing conditions in relation to the Member's plan.


 
pre_Exist_Ex_Code
string or null  <= 6 characters 
Assigns an Ex Code to pre-existing Claims.


 
relationship
string or null  <= 12 characters 
Relationship of the Member to the Subscriber.


 
ssn
string or null  <= 32 characters 
Social security number of the Member.


 
salutation
string or null  <= 16 characters 
Information only used in custom reporting.


 
sex
string or null  <= 1 characters 
Biological sex of the Member.


 
smoker
required
boolean
Designates whether the Member is a smoker. This may be important in cases where premiums differ between smokers and non-smokers.


 
student
string or null  <= 1 characters 
Identifies that the Member meets the 'Student Status' requirements.


 
student_End
string or null <date-time> 
End date of the Member's approved 'Student Status'. Only claims with a date of service up to this date will be allowed to process through adjudication.


 
unique_ID
string or null  <= 32 characters 
Unique identifier assigned to the Member by the User.


 
use_Member_Plan_Year
required
boolean
Identifies the Member's Plan year if it differs from the group. The User is required to define a number of months or years for the Plan. The Member's Plan year will begin on the first day of enrollment.


 
viP_Flag
string or null  <= 1 characters 
VIP status of the Member. This status can be used as a search filter but is otherwise informational only.


 
weight
integer or null <int32> 
The members weight in pounds.


 
Responses 
207
Success


401
Unauthorized


put/subscribers/{subscriberID}/members-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}
Get MembersDisabilityTaxSummary
Retrieve the MembersDisabilityTaxSummary for the given year


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberID
required
string
Subscriber ID


 
taxYear
required
integer <int32> 
Tax Year


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/subscribers/{subscriberID}/member-disability-tax-summary/{taxYear}
Request samples 
Response samples 
No sample