Benefits

Create Benefit

Creates a new Benefit

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
benefit_Code
required
string [ 1 .. 10 ] characters

Unique identifier assigned to the Benefit Code.

allow_Flat_Tax
required
boolean

This option allows the User to enter a 'Flat Amt.' within the 'Financial' screen from the Member 'Details' drop-down menu. If this option is not selected, the 'Flat Tax' amount will default to zero when calculating disability payments. Note: This field is marked as NOT NULL in the database and therefore required by the API.

benefit_Category
string or null <= 32 characters

References the BenefitCategory.Benefit_Category table.

benefit_Description
string or null <= 64 characters

Description of the associated Benefit Code.

default_Unit_Type
string or null <= 16 characters

No longer in use.

entry_Date
string <date-time>

Date when the record was added to the system.

entry_User
string or null <= 20 characters

User that first added the record to the system.

hipaA_Code
string or null <= 8 characters

HIPAA code associated with the specified Benefit. 835's require a maped HIPAA code on claims that pay less than the billed amount.

invalid_Diag_Ex_Code
string or null <= 6 characters

No longer in use.

invalid_Procedure_Ex_Code
string or null <= 6 characters

No longer in use.

invalid_Prov_Type_Ex_Code
string or null <= 6 characters

No longer in use.

invalid_Specialty_Ex_Code
string or null <= 6 characters

No longer in use.

medicare
required
string = 1 characters

No longer in use. Note: This field is marked as NOT NULL in the database and therefore required by the API.

pend_Ex_Code
string or null <= 6 characters

The Ex Code to apply when adjudicating a claim that has this benefit if the Pend_Flag is on.

pend_Flag
required
string = 1 characters

Whether or not to apply the Pend_Ex_Code value when adjudicating a claim that has this benefit.

require_Type_Of_Svc
string or null <= 1 characters

No longer in use.

update_Date
string <date-time>

Date when the record was last updated.

update_User
string or null <= 20 characters

User that last updated the record.

Responses
200

Success

401

Unauthorized

post/benefits
Request samples
{
  • "benefit_Code": "string",
  • "allow_Flat_Tax": true,
  • "benefit_Category": "string",
  • "benefit_Description": "string",
  • "default_Unit_Type": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "hipaA_Code": "string",
  • "invalid_Diag_Ex_Code": "string",
  • "invalid_Procedure_Ex_Code": "string",
  • "invalid_Prov_Type_Ex_Code": "string",
  • "invalid_Specialty_Ex_Code": "string",
  • "medicare": "s",
  • "pend_Ex_Code": "string",
  • "pend_Flag": "s",
  • "require_Type_Of_Svc": "s",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List Benefits

Lists all Benefits with optional Benefit Category

SecurityapiKeyAuth and bearerAuth
Request
query Parameters
page
integer <int32>
Default: 1

Page

pageSize
integer <int32>
Default: 100

Page Size

benefitCategory
string

Filter

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/benefits
Request samples 
Response samples 
No sample
List Benefit Riders
Lists all Benefits that are Riders on a specific Plan


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
planId
required
string
PlanId


 
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/plans/{planId}/benefits/riders
Request samples 
Response samples 
No sample
Get a Benefit
Gets a specific Benefit by Benefit Code


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
benefitCode
required
string
Benefit Code


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/benefits/{benefitCode}
Request samples 
Response samples 
No sample
Update Benefit
Updates a specific Benefit


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
benefitCode
required
string
Benefit Code


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
benefit_Code
required
string  [ 1 .. 10 ] characters 
Unique identifier assigned to the Benefit Code.


 
allow_Flat_Tax
required
boolean
This option allows the User to enter a 'Flat Amt.' within the 'Financial' screen from the Member 'Details' drop-down menu. If this option is not selected, the 'Flat Tax' amount will default to zero when calculating disability payments. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
benefit_Category
string or null  <= 32 characters 
References the BenefitCategory.Benefit_Category table.


 
benefit_Description
string or null  <= 64 characters 
Description of the associated Benefit Code.


 
default_Unit_Type
string or null  <= 16 characters 
No longer in use.


 
entry_Date
string <date-time> 
Date when the record was added to the system.


 
entry_User
string or null  <= 20 characters 
User that first added the record to the system.


 
hipaA_Code
string or null  <= 8 characters 
HIPAA code associated with the specified Benefit. 835's require a maped HIPAA code on claims that pay less than the billed amount.


 
invalid_Diag_Ex_Code
string or null  <= 6 characters 
No longer in use.


 
invalid_Procedure_Ex_Code
string or null  <= 6 characters 
No longer in use.


 
invalid_Prov_Type_Ex_Code
string or null  <= 6 characters 
No longer in use.


 
invalid_Specialty_Ex_Code
string or null  <= 6 characters 
No longer in use.


 
medicare
required
string  = 1 characters 
No longer in use. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
pend_Ex_Code
string or null  <= 6 characters 
The Ex Code to apply when adjudicating a claim that has this benefit if the Pend_Flag is on.


 
pend_Flag
required
string  = 1 characters 
Whether or not to apply the Pend_Ex_Code value when adjudicating a claim that has this benefit.


 
require_Type_Of_Svc
string or null  <= 1 characters 
No longer in use.


 
update_Date
string <date-time> 
Date when the record was last updated.


 
update_User
string or null  <= 20 characters 
User that last updated the record.


 
Responses 
200
Success


401
Unauthorized


put/benefits/{benefitCode}
Request samples 
{
  • "benefit_Code": "string",
  • "allow_Flat_Tax": true,
  • "benefit_Category": "string",
  • "benefit_Description": "string",
  • "default_Unit_Type": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "hipaA_Code": "string",
  • "invalid_Diag_Ex_Code": "string",
  • "invalid_Procedure_Ex_Code": "string",
  • "invalid_Prov_Type_Ex_Code": "string",
  • "invalid_Specialty_Ex_Code": "string",
  • "medicare": "s",
  • "pend_Ex_Code": "string",
  • "pend_Flag": "s",
  • "require_Type_Of_Svc": "s",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete a Benefit
Deletes a specific Benefit by Benefit Code


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
benefitCode
required
string
Benefit Code


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/benefits/{benefitCode}
Request samples 
Create or Update Batch of Benefits
Create or Update multiple Benefits 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 
benefit_Code
required
string  [ 1 .. 10 ] characters 
Unique identifier assigned to the Benefit Code.


 
allow_Flat_Tax
required
boolean
This option allows the User to enter a 'Flat Amt.' within the 'Financial' screen from the Member 'Details' drop-down menu. If this option is not selected, the 'Flat Tax' amount will default to zero when calculating disability payments. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
benefit_Category
string or null  <= 32 characters 
References the BenefitCategory.Benefit_Category table.


 
benefit_Description
string or null  <= 64 characters 
Description of the associated Benefit Code.


 
default_Unit_Type
string or null  <= 16 characters 
No longer in use.


 
entry_Date
string <date-time> 
Date when the record was added to the system.


 
entry_User
string or null  <= 20 characters 
User that first added the record to the system.


 
hipaA_Code
string or null  <= 8 characters 
HIPAA code associated with the specified Benefit. 835's require a maped HIPAA code on claims that pay less than the billed amount.


 
invalid_Diag_Ex_Code
string or null  <= 6 characters 
No longer in use.


 
invalid_Procedure_Ex_Code
string or null  <= 6 characters 
No longer in use.


 
invalid_Prov_Type_Ex_Code
string or null  <= 6 characters 
No longer in use.


 
invalid_Specialty_Ex_Code
string or null  <= 6 characters 
No longer in use.


 
medicare
required
string  = 1 characters 
No longer in use. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
pend_Ex_Code
string or null  <= 6 characters 
The Ex Code to apply when adjudicating a claim that has this benefit if the Pend_Flag is on.


 
pend_Flag
required
string  = 1 characters 
Whether or not to apply the Pend_Ex_Code value when adjudicating a claim that has this benefit.


 
require_Type_Of_Svc
string or null  <= 1 characters 
No longer in use.


 
update_Date
string <date-time> 
Date when the record was last updated.


 
update_User
string or null  <= 20 characters 
User that last updated the record.


 
Responses 
207
Success


401
Unauthorized


put/benefits-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}
List Benefit Levels
List of all Benefit Levels with Key, Display and Description


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


 
Responses 
200
Success


401
Unauthorized


get/benefit-levels
Request samples 
Response samples 
No sample
List Benefit Plan Maximum Types
List of all Benefit Plan Maximum Types


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


 
Responses 
200
Success


401
Unauthorized


get/benefit-plan-maximum-types
Request samples 
Response samples 
No sample
List Benefit Plan Maximum Per Types
List of all Benefit Plan Maximum Per Types


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


 
Responses 
200
Success


401
Unauthorized


get/benefit-plan-maximum-per-types
Request samples 
Response samples 
No sample
List Benefit Plan Dental Designation Types
List of all Benefit Plan Dental Designation Types


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


 
Responses 
200
Success


401
Unauthorized


get/benefit-plan-dental-designation-types
Request samples 
Response samples 
No sample
List Benefit Plan Maximum Network Types
List of all Benefit Plan Maximum Network Types


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


 
Responses 
200
Success


401
Unauthorized


get/benefit-plan-maximum-network-types
Request samples 
Response samples 
No sample
List Benefit Plan Maximum Scope Types
List of all Benefit Plan Maximum Coverage Types


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


 
Responses 
200
Success


401
Unauthorized


get/benefit-plan-maximum-coverage-types
Request samples 
Response samples 
No sample
List Benefit Rate Types
List all Benefit Rate Types


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


 
Responses 
200
Success


401
Unauthorized


get/benefit-rate-types
Request samples 
Response samples 
No sample
List Benefit Rate Max Types
List all Benefit Rate Max Types


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


 
Responses 
200
Success


401
Unauthorized


get/benefit-rate-max-types
Request samples 
Response samples 
No sample
List Out of Pocket (OOP) Types
List all Out of Pocket (OOP) Type key/value pairings.


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


 
Responses 
200
Success


401
Unauthorized


get/oop-types
Request samples 
Response samples 
No sample
List Out of Pocket (OOP) Calculations
List all Out of Pocket (OOP) Calculation key/value pairings.


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


 
Responses 
200
Success


401
Unauthorized


get/oop-calculations
Request samples 
Response samples 
No sample
List Plan Benefit Amount Types
List Plan Benefit Amount Types


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


 
Responses 
200
Success


401
Unauthorized


get/plan-benefit-amount-types
Request samples 
Response samples 
No sample
List Plan Benefit Co-Pay Per Types
List Plan Benefit Co-Pay Per Types


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


 
Responses 
200
Success


401
Unauthorized


get/plan-benefit-co-pay-per-types
Request samples 
Response samples 
No sample