Group Contract Plans

Create GroupContractPlan

Creates a new GroupContractPlan

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
groupID
required
string

Group ID

divisionID
required
string

Division ID

coverageStart
required
string <date-time>

Coverage Start

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
group_ID
required
string [ 1 .. 20 ] characters

References GroupContract.Group_ID value on the parent record.

division_ID
required
string [ 1 .. 20 ] characters

References GroupContract.Division_ID value on the parent record.

coverage_Start
required
string <date-time>

References GroupContract.Coverage_Start value on the parent record. Note: This field is marked as NOT NULL in the database and therefore required by the API.

plan_ID
required
string [ 1 .. 20 ] characters

References Plans.Plan_ID on the parent record.

account_Key
integer or null <int32>

Identifies the banking account associated with the selected contract.

advice_To_Pay
required
boolean

When this option is selected, adjudication to mark every claim as 'Advice to Pay' (ATP). Advice to Pay claims do not produce check records when processed. Note: This field is marked as NOT NULL in the database and therefore required by the API.

bpl
string or null <= 16 characters

No longer in use.

billing_Basis
string or null <= 1 characters

No longer in use.

calc_Interest
required
boolean

Indicates if interest is to be calculated for this contract plan during check processing. Note: This field is marked as NOT NULL in the database and therefore required by the API.

calc_Interest_ACH
required
boolean

For ACH payments, Indicates if interest is to be calculated for this contract plan during check processing. Note: This field is marked as NOT NULL in the database and therefore required by the API.

calc_Interest_ACH_Min
number or null <double>

For ACH payments, If interest is to be calculated, this value determines the minimum interest that can be applied. Any interst calculated below this number is ignored.

calc_Interest_ACH_Network_Option
string or null <= 16 characters

For ACH payments, Indicates if interest is to be calculated by: N - In Network or O - Out of Network. Leave this blank if interest applies to both.

calc_Interest_ACH_On_Adj
required
boolean

For ACH payments, Flag indicating if interest should be calculated on adjustment claims. Note: This field is marked as NOT NULL in the database and therefore required by the API.

calc_Interest_ACH_Option
string or null <= 16 characters

For ACH payments, Indicates what field will be used for interest calculation: B - Billed Amount, A - Allowed Amount or P - Paid Amount.

calc_Interest_ACH_Pct
number or null <double>

For ACH payments, Indicates the interest percentage to be applied during interest calculations.

calc_Interest_ACH_Prompt_Pay_Freq
integer or null <int32>

For ACH payments, This is the frequency of "Calc_Interest_Prompt_Pay_Type" for determining if interest is applicable.

calc_Interest_ACH_Prompt_Pay_Type
string or null <= 1 characters

For ACH payments, This is the "Calc_Interest_Prompt_Pay_Freq" in number of: D - Days, M - Months or Y - Years.

calc_Interest_Min
number or null <double>

If interest is to be calculated, this value determines the minimum interest that can be applied. Any interst calculated below this number is ignored.

calc_Interest_Network_Option
string or null <= 16 characters

Indicates if interest is to be calculated by: N - In Network or O - Out of Network. Leave this blank if interest applies to both.

calc_Interest_On_Adj
required
boolean

Flag indicating if interest should be calculated on adjustment claims. Note: This field is marked as NOT NULL in the database and therefore required by the API.

calc_Interest_Option
string or null <= 16 characters

Indicates what field will be used for interest calculation: B - Billed Amount, A - Allowed Amount or P - Paid Amount.

calc_Interest_Pct
number or null <double>

Indicates the interest percentage to be applied during interest calculations.

calc_Interest_Prompt_Pay_Freq
integer or null <int32>

This is the frequency of "Calc_Interest_Prompt_Pay_Type" for determining if interest is applicable.

calc_Interest_Prompt_Pay_Type
string or null <= 1 characters

This is the "Calc_Interest_Prompt_Pay_Freq" in number of: D - Days, M - Months or Y - Years.

dependent_Contribution
number or null <double>

For flex, determines the Dependent Contribution amount (or Pct if "Dependent_Contribution_Pct" is flagged)

dependent_Contribution_Pct
required
boolean

For flex, notes if the amount entered into "Dependent_Contribution" is a percent or flat amount. Note: This field is marked as NOT NULL in the database and therefore required by the API.

disability_Pay_Through_Day
integer or null <int32>

This is the day number of the week that disability claims created through the disability advisor will run through. This allows a disability claim with an ETD that ends in the middle of a week to be pushed through the end of that week if needed.

employee_Contribution
number or null <double>

For flex, determines the Employee Contribution amount (or Pct if "Employee_Contribution_Pct" is flagged)

employee_Contribution_Pct
required
boolean

For flex, notes if the amount entered into "Employee_Contribution" is a percent or flat amount. Note: This field is marked as NOT NULL in the database and therefore required by the API.

end_Coverage_Age
integer or null <int32>

This is the age of the subscribers on the day based on "End_Coverage_Age_Type" before benefits are no longer eligible.

end_Coverage_Age_Type
string or null <= 16 characters

The type of age in years entered in "End_Coverage_Age" by type: EXACTDATE - Age Exact Date, BEGINMONTH - Age at Beginning of month, ENDMONTH - Age at End of month, BEGINYEAR - Age at the beginning of the year, or ENDYEAR - Age at the End of the year.

entry_Date
string <date-time>

Date when the record was first added to the system.

entry_User
string or null <= 20 characters

User that first added the record to the system.

exempt_Federal
required
boolean

Indicates a federal exemption as part of the selected contract. Note: This field is marked as NOT NULL in the database and therefore required by the API.

exempt_Medicare
required
boolean

indicates a medicare exemption as part of the selected contract. Note: This field is marked as NOT NULL in the database and therefore required by the API.

exempt_SocSec
required
boolean

Indicates a social security exemption as part of the selected contract. Note: This field is marked as NOT NULL in the database and therefore required by the API.

exempt_State
required
boolean

Indicates a state exemption as part of the selected contract. Note: This field is marked as NOT NULL in the database and therefore required by the API.

federal_Tax_Day_Limit
integer or null <int32>

Limit of days for the federal tax exemption.

federal_Wage_Limit
number or null <double>

Wage limit for the federal tax exemption.

locator
string or null <= 16 characters

No longer in use.

medicare_Tax_Day_Limit
integer or null <int32>

Limit of days for the medicare tax exemption.

medicare_Wage_Limit
number or null <double>

Wage liimit for the medicare tax exemption.

minimum_Benefit
number or null <double>

For disability claims, this indicates the minimum benefit (weekly for STD plans or monthly for LTD plans).

paid_Through
string or null <date-time>

Premium Billing setting that holds the premiums paid through for a selection of contracted subscribers.

payor_ID
string or null <= 20 characters

References PayorAccount.Payor_ID value on parent record.

prorate_FICA
required
boolean

Notes if Disability Claims should Prorate the FICA tax based on the disability payment duration. Note: This field is marked as NOT NULL in the database and therefore required by the API.

rX_BIN
string or null <= 64 characters

Information fields used to hold RX information on this Contract Plan for reporting and interfaces.

rX_CS_Contact
string or null <= 128 characters

Information fields used to hold RX information on this Contract Plan for reporting and interfaces.

rX_CS_Phone
string or null <= 32 characters

Information fields used to hold RX information on this Contract Plan for reporting and interfaces.

rX_GRP
string or null <= 64 characters

Information fields used to hold RX information on this Contract Plan for reporting and interfaces.

rX_Name
string or null <= 512 characters

Information fields used to hold RX information on this Contract Plan for reporting and interfaces.

rX_PCN
string or null <= 64 characters

Information fields used to hold RX information on this Contract Plan for reporting and interfaces.

retirement_Plan
required
boolean

Flag to indicate if this plan on this contract is a retirement plan. This is information only. Note: This field is marked as NOT NULL in the database and therefore required by the API.

salary_Pct
number or null <double>

If "Use_Salary_Pct" option is enabled, this indicatres the percent of salary.

socSec_Tax_Day_Limit
integer or null <int32>

Limit of days for the social security tax exemption.

socSec_Wage_Limit
number or null <double>

Wage limite for Social Security tax exemption.

state_Tax_Day_Limit
integer or null <int32>

Limit of days for the state tax exemption.

state_Wage_Limit
number or null <double>

Wage limit for the state tax exemption.

tax_Day_Limit_Type
required
integer <int32>

Indicates if the tax day limitations are by day or calendar months. The database default for this field is '1'. Note: This field is marked as NOT NULL in the database and therefore required by the API.

update_Date
string <date-time>

Date when the record was last updated in the system.

update_User
string or null <= 20 characters

User that last updated the record in the system.

use_Plan_Options
required
boolean

Used on the front end to indicate if the plan options should be shown to the user, has not backend functional impact. Note: This field is marked as NOT NULL in the database and therefore required by the API.

use_Salary_Pct
required
boolean

Indicates that disability should be based upon salary percentage. Note: This field is marked as NOT NULL in the database and therefore required by the API.

volume
number or null <double>

No longer in use.

volume_Max
number or null <double>

Indicates the benefit maximum of the disabiltiy plan.

volume_Min
number or null <double>

Indicates the benefit minimum of the disability plan.

Responses
200

Success

401

Unauthorized

post/groups/{groupID}/divisions/{divisionID}/contracts/{coverageStart}/plans
Request samples
{
  • "group_ID": "string",
  • "division_ID": "string",
  • "coverage_Start": "2019-08-24T14:15:22Z",
  • "plan_ID": "string",
  • "account_Key": 0,
  • "advice_To_Pay": true,
  • "bpl": "string",
  • "billing_Basis": "s",
  • "calc_Interest": true,
  • "calc_Interest_ACH": true,
  • "calc_Interest_ACH_Min": 0.1,
  • "calc_Interest_ACH_Network_Option": "string",
  • "calc_Interest_ACH_On_Adj": true,
  • "calc_Interest_ACH_Option": "string",
  • "calc_Interest_ACH_Pct": 0.1,
  • "calc_Interest_ACH_Prompt_Pay_Freq": 0,
  • "calc_Interest_ACH_Prompt_Pay_Type": "s",
  • "calc_Interest_Min": 0.1,
  • "calc_Interest_Network_Option": "string",
  • "calc_Interest_On_Adj": true,
  • "calc_Interest_Option": "string",
  • "calc_Interest_Pct": 0.1,
  • "calc_Interest_Prompt_Pay_Freq": 0,
  • "calc_Interest_Prompt_Pay_Type": "s",
  • "dependent_Contribution": 0.1,
  • "dependent_Contribution_Pct": true,
  • "disability_Pay_Through_Day": 0,
  • "employee_Contribution": 0.1,
  • "employee_Contribution_Pct": true,
  • "end_Coverage_Age": 0,
  • "end_Coverage_Age_Type": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "exempt_Federal": true,
  • "exempt_Medicare": true,
  • "exempt_SocSec": true,
  • "exempt_State": true,
  • "federal_Tax_Day_Limit": 0,
  • "federal_Wage_Limit": 0.1,
  • "locator": "string",
  • "medicare_Tax_Day_Limit": 0,
  • "medicare_Wage_Limit": 0.1,
  • "minimum_Benefit": 0.1,
  • "paid_Through": "2019-08-24T14:15:22Z",
  • "payor_ID": "string",
  • "prorate_FICA": true,
  • "rX_BIN": "string",
  • "rX_CS_Contact": "string",
  • "rX_CS_Phone": "string",
  • "rX_GRP": "string",
  • "rX_Name": "string",
  • "rX_PCN": "string",
  • "retirement_Plan": true,
  • "salary_Pct": 0.1,
  • "socSec_Tax_Day_Limit": 0,
  • "socSec_Wage_Limit": 0.1,
  • "state_Tax_Day_Limit": 0,
  • "state_Wage_Limit": 0.1,
  • "tax_Day_Limit_Type": 0,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "use_Plan_Options": true,
  • "use_Salary_Pct": true,
  • "volume": 0.1,
  • "volume_Max": 0.1,
  • "volume_Min": 0.1
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List GroupContractPlan

Lists all GroupContractPlan for the given groupID and divisionID and coverageStart

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
groupID
required
string

Group ID

divisionID
required
string

Division ID

coverageStart
required
string <date-time>

Coverage Start

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/groups/{groupID}/divisions/{divisionID}/contracts/{coverageStart}/plans
Request samples 
Response samples 
No sample
List Plans by Group and Division
A unique list of Plans for all GroupContractPlan for the given groupID and divisionID


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
groupID
required
string
Group ID


 
divisionID
required
string
Division ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/groups/{groupID}/divisions/{divisionID}/plans-no-contracts
Request samples 
Response samples 
No sample
Get GroupContractPlan
Gets GroupContractPlan


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
groupID
required
string
Group ID


 
divisionID
required
string
Division ID


 
coverageStart
required
string <date-time> 
Coverage Start


 
planID
required
string
Plan ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/groups/{groupID}/divisions/{divisionID}/contracts/{coverageStart}/plans/{planID}
Request samples 
Response samples 
No sample
Update GroupContractPlan
Updates a specific GroupContractPlan.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
groupID
required
string
Group ID


 
divisionID
required
string
Division ID


 
coverageStart
required
string <date-time> 
Coverage Start


 
planID
required
string
Plan ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
group_ID
required
string  [ 1 .. 20 ] characters 
References GroupContract.Group_ID value on the parent record.


 
division_ID
required
string  [ 1 .. 20 ] characters 
References GroupContract.Division_ID value on the parent record.


 
coverage_Start
required
string <date-time> 
References GroupContract.Coverage_Start value on the parent record. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
plan_ID
required
string  [ 1 .. 20 ] characters 
References Plans.Plan_ID on the parent record.


 
account_Key
integer or null <int32> 
Identifies the banking account associated with the selected contract.


 
advice_To_Pay
required
boolean
When this option is selected, adjudication to mark every claim as 'Advice to Pay' (ATP). Advice to Pay claims do not produce check records when processed. Note: This field is marked as NOT NULL in the database and therefore required by the API.


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


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


 
calc_Interest
required
boolean
Indicates if interest is to be calculated for this contract plan during check processing. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
calc_Interest_ACH
required
boolean
For ACH payments, Indicates if interest is to be calculated for this contract plan during check processing. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
calc_Interest_ACH_Min
number or null <double> 
For ACH payments, If interest is to be calculated, this value determines the minimum interest that can be applied. Any interst calculated below this number is ignored.


 
calc_Interest_ACH_Network_Option
string or null  <= 16 characters 
For ACH payments, Indicates if interest is to be calculated by: N - In Network or O - Out of Network. Leave this blank if interest applies to both.


 
calc_Interest_ACH_On_Adj
required
boolean
For ACH payments, Flag indicating if interest should be calculated on adjustment claims. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
calc_Interest_ACH_Option
string or null  <= 16 characters 
For ACH payments, Indicates what field will be used for interest calculation: B - Billed Amount, A - Allowed Amount or P - Paid Amount.


 
calc_Interest_ACH_Pct
number or null <double> 
For ACH payments, Indicates the interest percentage to be applied during interest calculations.


 
calc_Interest_ACH_Prompt_Pay_Freq
integer or null <int32> 
For ACH payments, This is the frequency of "Calc_Interest_Prompt_Pay_Type" for determining if interest is applicable.


 
calc_Interest_ACH_Prompt_Pay_Type
string or null  <= 1 characters 
For ACH payments, This is the "Calc_Interest_Prompt_Pay_Freq" in number of: D - Days, M - Months or Y - Years.


 
calc_Interest_Min
number or null <double> 
If interest is to be calculated, this value determines the minimum interest that can be applied. Any interst calculated below this number is ignored.


 
calc_Interest_Network_Option
string or null  <= 16 characters 
Indicates if interest is to be calculated by: N - In Network or O - Out of Network. Leave this blank if interest applies to both.


 
calc_Interest_On_Adj
required
boolean
Flag indicating if interest should be calculated on adjustment claims. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
calc_Interest_Option
string or null  <= 16 characters 
Indicates what field will be used for interest calculation: B - Billed Amount, A - Allowed Amount or P - Paid Amount.


 
calc_Interest_Pct
number or null <double> 
Indicates the interest percentage to be applied during interest calculations.


 
calc_Interest_Prompt_Pay_Freq
integer or null <int32> 
This is the frequency of "Calc_Interest_Prompt_Pay_Type" for determining if interest is applicable.


 
calc_Interest_Prompt_Pay_Type
string or null  <= 1 characters 
This is the "Calc_Interest_Prompt_Pay_Freq" in number of: D - Days, M - Months or Y - Years.


 
dependent_Contribution
number or null <double> 
For flex, determines the Dependent Contribution amount (or Pct if "Dependent_Contribution_Pct" is flagged)


 
dependent_Contribution_Pct
required
boolean
For flex, notes if the amount entered into "Dependent_Contribution" is a percent or flat amount. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
disability_Pay_Through_Day
integer or null <int32> 
This is the day number of the week that disability claims created through the disability advisor will run through. This allows a disability claim with an ETD that ends in the middle of a week to be pushed through the end of that week if needed.


 
employee_Contribution
number or null <double> 
For flex, determines the Employee Contribution amount (or Pct if "Employee_Contribution_Pct" is flagged)


 
employee_Contribution_Pct
required
boolean
For flex, notes if the amount entered into "Employee_Contribution" is a percent or flat amount. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
end_Coverage_Age
integer or null <int32> 
This is the age of the subscribers on the day based on "End_Coverage_Age_Type" before benefits are no longer eligible.


 
end_Coverage_Age_Type
string or null  <= 16 characters 
The type of age in years entered in "End_Coverage_Age" by type: EXACTDATE - Age Exact Date, BEGINMONTH - Age at Beginning of month, ENDMONTH - Age at End of month, BEGINYEAR - Age at the beginning of the year, or ENDYEAR - Age at the End of the year.


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


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


 
exempt_Federal
required
boolean
Indicates a federal exemption as part of the selected contract. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
exempt_Medicare
required
boolean
indicates a medicare exemption as part of the selected contract. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
exempt_SocSec
required
boolean
Indicates a social security exemption as part of the selected contract. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
exempt_State
required
boolean
Indicates a state exemption as part of the selected contract. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
federal_Tax_Day_Limit
integer or null <int32> 
Limit of days for the federal tax exemption.


 
federal_Wage_Limit
number or null <double> 
Wage limit for the federal tax exemption.


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


 
medicare_Tax_Day_Limit
integer or null <int32> 
Limit of days for the medicare tax exemption.


 
medicare_Wage_Limit
number or null <double> 
Wage liimit for the medicare tax exemption.


 
minimum_Benefit
number or null <double> 
For disability claims, this indicates the minimum benefit (weekly for STD plans or monthly for LTD plans).


 
paid_Through
string or null <date-time> 
Premium Billing setting that holds the premiums paid through for a selection of contracted subscribers.


 
payor_ID
string or null  <= 20 characters 
References PayorAccount.Payor_ID value on parent record.


 
prorate_FICA
required
boolean
Notes if Disability Claims should Prorate the FICA tax based on the disability payment duration. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
rX_BIN
string or null  <= 64 characters 
Information fields used to hold RX information on this Contract Plan for reporting and interfaces.


 
rX_CS_Contact
string or null  <= 128 characters 
Information fields used to hold RX information on this Contract Plan for reporting and interfaces.


 
rX_CS_Phone
string or null  <= 32 characters 
Information fields used to hold RX information on this Contract Plan for reporting and interfaces.


 
rX_GRP
string or null  <= 64 characters 
Information fields used to hold RX information on this Contract Plan for reporting and interfaces.


 
rX_Name
string or null  <= 512 characters 
Information fields used to hold RX information on this Contract Plan for reporting and interfaces.


 
rX_PCN
string or null  <= 64 characters 
Information fields used to hold RX information on this Contract Plan for reporting and interfaces.


 
retirement_Plan
required
boolean
Flag to indicate if this plan on this contract is a retirement plan. This is information only. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
salary_Pct
number or null <double> 
If "Use_Salary_Pct" option is enabled, this indicatres the percent of salary.


 
socSec_Tax_Day_Limit
integer or null <int32> 
Limit of days for the social security tax exemption.


 
socSec_Wage_Limit
number or null <double> 
Wage limite for Social Security tax exemption.


 
state_Tax_Day_Limit
integer or null <int32> 
Limit of days for the state tax exemption.


 
state_Wage_Limit
number or null <double> 
Wage limit for the state tax exemption.


 
tax_Day_Limit_Type
required
integer <int32> 
Indicates if the tax day limitations are by day or calendar months.  The database default for this field is '1'.  Note: This field is marked as NOT NULL in the database and therefore required by the API.


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


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


 
use_Plan_Options
required
boolean
Used on the front end to indicate if the plan options should be shown to the user, has not backend functional impact. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
use_Salary_Pct
required
boolean
Indicates that disability should be based upon salary percentage. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
volume
number or null <double> 
No longer in use.


 
volume_Max
number or null <double> 
Indicates the benefit maximum of the disabiltiy plan.


 
volume_Min
number or null <double> 
Indicates the benefit minimum of the disability plan.


 
Responses 
200
Success


401
Unauthorized


put/groups/{groupID}/divisions/{divisionID}/contracts/{coverageStart}/plans/{planID}
Request samples 
{
  • "group_ID": "string",
  • "division_ID": "string",
  • "coverage_Start": "2019-08-24T14:15:22Z",
  • "plan_ID": "string",
  • "account_Key": 0,
  • "advice_To_Pay": true,
  • "bpl": "string",
  • "billing_Basis": "s",
  • "calc_Interest": true,
  • "calc_Interest_ACH": true,
  • "calc_Interest_ACH_Min": 0.1,
  • "calc_Interest_ACH_Network_Option": "string",
  • "calc_Interest_ACH_On_Adj": true,
  • "calc_Interest_ACH_Option": "string",
  • "calc_Interest_ACH_Pct": 0.1,
  • "calc_Interest_ACH_Prompt_Pay_Freq": 0,
  • "calc_Interest_ACH_Prompt_Pay_Type": "s",
  • "calc_Interest_Min": 0.1,
  • "calc_Interest_Network_Option": "string",
  • "calc_Interest_On_Adj": true,
  • "calc_Interest_Option": "string",
  • "calc_Interest_Pct": 0.1,
  • "calc_Interest_Prompt_Pay_Freq": 0,
  • "calc_Interest_Prompt_Pay_Type": "s",
  • "dependent_Contribution": 0.1,
  • "dependent_Contribution_Pct": true,
  • "disability_Pay_Through_Day": 0,
  • "employee_Contribution": 0.1,
  • "employee_Contribution_Pct": true,
  • "end_Coverage_Age": 0,
  • "end_Coverage_Age_Type": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "exempt_Federal": true,
  • "exempt_Medicare": true,
  • "exempt_SocSec": true,
  • "exempt_State": true,
  • "federal_Tax_Day_Limit": 0,
  • "federal_Wage_Limit": 0.1,
  • "locator": "string",
  • "medicare_Tax_Day_Limit": 0,
  • "medicare_Wage_Limit": 0.1,
  • "minimum_Benefit": 0.1,
  • "paid_Through": "2019-08-24T14:15:22Z",
  • "payor_ID": "string",
  • "prorate_FICA": true,
  • "rX_BIN": "string",
  • "rX_CS_Contact": "string",
  • "rX_CS_Phone": "string",
  • "rX_GRP": "string",
  • "rX_Name": "string",
  • "rX_PCN": "string",
  • "retirement_Plan": true,
  • "salary_Pct": 0.1,
  • "socSec_Tax_Day_Limit": 0,
  • "socSec_Wage_Limit": 0.1,
  • "state_Tax_Day_Limit": 0,
  • "state_Wage_Limit": 0.1,
  • "tax_Day_Limit_Type": 0,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "use_Plan_Options": true,
  • "use_Salary_Pct": true,
  • "volume": 0.1,
  • "volume_Max": 0.1,
  • "volume_Min": 0.1
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete GroupContractPlan
Deletes an GroupContractPlan


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
groupID
required
string
Group ID


 
divisionID
required
string
Division ID


 
coverageStart
required
string <date-time> 
Coverage Start


 
planID
required
string
Plan ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/groups/{groupID}/divisions/{divisionID}/contracts/{coverageStart}/plans/{planID}
Request samples 
Create or Update Batch GroupContractPlan
Create or Update multiple GroupContractPlan 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
groupID
required
string
Group ID


 
divisionID
required
string
Division ID


 
coverageStart
required
string <date-time> 
Coverage Start


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
group_ID
required
string  [ 1 .. 20 ] characters 
References GroupContract.Group_ID value on the parent record.


 
division_ID
required
string  [ 1 .. 20 ] characters 
References GroupContract.Division_ID value on the parent record.


 
coverage_Start
required
string <date-time> 
References GroupContract.Coverage_Start value on the parent record. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
plan_ID
required
string  [ 1 .. 20 ] characters 
References Plans.Plan_ID on the parent record.


 
account_Key
integer or null <int32> 
Identifies the banking account associated with the selected contract.


 
advice_To_Pay
required
boolean
When this option is selected, adjudication to mark every claim as 'Advice to Pay' (ATP). Advice to Pay claims do not produce check records when processed. Note: This field is marked as NOT NULL in the database and therefore required by the API.


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


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


 
calc_Interest
required
boolean
Indicates if interest is to be calculated for this contract plan during check processing. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
calc_Interest_ACH
required
boolean
For ACH payments, Indicates if interest is to be calculated for this contract plan during check processing. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
calc_Interest_ACH_Min
number or null <double> 
For ACH payments, If interest is to be calculated, this value determines the minimum interest that can be applied. Any interst calculated below this number is ignored.


 
calc_Interest_ACH_Network_Option
string or null  <= 16 characters 
For ACH payments, Indicates if interest is to be calculated by: N - In Network or O - Out of Network. Leave this blank if interest applies to both.


 
calc_Interest_ACH_On_Adj
required
boolean
For ACH payments, Flag indicating if interest should be calculated on adjustment claims. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
calc_Interest_ACH_Option
string or null  <= 16 characters 
For ACH payments, Indicates what field will be used for interest calculation: B - Billed Amount, A - Allowed Amount or P - Paid Amount.


 
calc_Interest_ACH_Pct
number or null <double> 
For ACH payments, Indicates the interest percentage to be applied during interest calculations.


 
calc_Interest_ACH_Prompt_Pay_Freq
integer or null <int32> 
For ACH payments, This is the frequency of "Calc_Interest_Prompt_Pay_Type" for determining if interest is applicable.


 
calc_Interest_ACH_Prompt_Pay_Type
string or null  <= 1 characters 
For ACH payments, This is the "Calc_Interest_Prompt_Pay_Freq" in number of: D - Days, M - Months or Y - Years.


 
calc_Interest_Min
number or null <double> 
If interest is to be calculated, this value determines the minimum interest that can be applied. Any interst calculated below this number is ignored.


 
calc_Interest_Network_Option
string or null  <= 16 characters 
Indicates if interest is to be calculated by: N - In Network or O - Out of Network. Leave this blank if interest applies to both.


 
calc_Interest_On_Adj
required
boolean
Flag indicating if interest should be calculated on adjustment claims. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
calc_Interest_Option
string or null  <= 16 characters 
Indicates what field will be used for interest calculation: B - Billed Amount, A - Allowed Amount or P - Paid Amount.


 
calc_Interest_Pct
number or null <double> 
Indicates the interest percentage to be applied during interest calculations.


 
calc_Interest_Prompt_Pay_Freq
integer or null <int32> 
This is the frequency of "Calc_Interest_Prompt_Pay_Type" for determining if interest is applicable.


 
calc_Interest_Prompt_Pay_Type
string or null  <= 1 characters 
This is the "Calc_Interest_Prompt_Pay_Freq" in number of: D - Days, M - Months or Y - Years.


 
dependent_Contribution
number or null <double> 
For flex, determines the Dependent Contribution amount (or Pct if "Dependent_Contribution_Pct" is flagged)


 
dependent_Contribution_Pct
required
boolean
For flex, notes if the amount entered into "Dependent_Contribution" is a percent or flat amount. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
disability_Pay_Through_Day
integer or null <int32> 
This is the day number of the week that disability claims created through the disability advisor will run through. This allows a disability claim with an ETD that ends in the middle of a week to be pushed through the end of that week if needed.


 
employee_Contribution
number or null <double> 
For flex, determines the Employee Contribution amount (or Pct if "Employee_Contribution_Pct" is flagged)


 
employee_Contribution_Pct
required
boolean
For flex, notes if the amount entered into "Employee_Contribution" is a percent or flat amount. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
end_Coverage_Age
integer or null <int32> 
This is the age of the subscribers on the day based on "End_Coverage_Age_Type" before benefits are no longer eligible.


 
end_Coverage_Age_Type
string or null  <= 16 characters 
The type of age in years entered in "End_Coverage_Age" by type: EXACTDATE - Age Exact Date, BEGINMONTH - Age at Beginning of month, ENDMONTH - Age at End of month, BEGINYEAR - Age at the beginning of the year, or ENDYEAR - Age at the End of the year.


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


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


 
exempt_Federal
required
boolean
Indicates a federal exemption as part of the selected contract. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
exempt_Medicare
required
boolean
indicates a medicare exemption as part of the selected contract. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
exempt_SocSec
required
boolean
Indicates a social security exemption as part of the selected contract. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
exempt_State
required
boolean
Indicates a state exemption as part of the selected contract. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
federal_Tax_Day_Limit
integer or null <int32> 
Limit of days for the federal tax exemption.


 
federal_Wage_Limit
number or null <double> 
Wage limit for the federal tax exemption.


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


 
medicare_Tax_Day_Limit
integer or null <int32> 
Limit of days for the medicare tax exemption.


 
medicare_Wage_Limit
number or null <double> 
Wage liimit for the medicare tax exemption.


 
minimum_Benefit
number or null <double> 
For disability claims, this indicates the minimum benefit (weekly for STD plans or monthly for LTD plans).


 
paid_Through
string or null <date-time> 
Premium Billing setting that holds the premiums paid through for a selection of contracted subscribers.


 
payor_ID
string or null  <= 20 characters 
References PayorAccount.Payor_ID value on parent record.


 
prorate_FICA
required
boolean
Notes if Disability Claims should Prorate the FICA tax based on the disability payment duration. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
rX_BIN
string or null  <= 64 characters 
Information fields used to hold RX information on this Contract Plan for reporting and interfaces.


 
rX_CS_Contact
string or null  <= 128 characters 
Information fields used to hold RX information on this Contract Plan for reporting and interfaces.


 
rX_CS_Phone
string or null  <= 32 characters 
Information fields used to hold RX information on this Contract Plan for reporting and interfaces.


 
rX_GRP
string or null  <= 64 characters 
Information fields used to hold RX information on this Contract Plan for reporting and interfaces.


 
rX_Name
string or null  <= 512 characters 
Information fields used to hold RX information on this Contract Plan for reporting and interfaces.


 
rX_PCN
string or null  <= 64 characters 
Information fields used to hold RX information on this Contract Plan for reporting and interfaces.


 
retirement_Plan
required
boolean
Flag to indicate if this plan on this contract is a retirement plan. This is information only. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
salary_Pct
number or null <double> 
If "Use_Salary_Pct" option is enabled, this indicatres the percent of salary.


 
socSec_Tax_Day_Limit
integer or null <int32> 
Limit of days for the social security tax exemption.


 
socSec_Wage_Limit
number or null <double> 
Wage limite for Social Security tax exemption.


 
state_Tax_Day_Limit
integer or null <int32> 
Limit of days for the state tax exemption.


 
state_Wage_Limit
number or null <double> 
Wage limit for the state tax exemption.


 
tax_Day_Limit_Type
required
integer <int32> 
Indicates if the tax day limitations are by day or calendar months.  The database default for this field is '1'.  Note: This field is marked as NOT NULL in the database and therefore required by the API.


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


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


 
use_Plan_Options
required
boolean
Used on the front end to indicate if the plan options should be shown to the user, has not backend functional impact. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
use_Salary_Pct
required
boolean
Indicates that disability should be based upon salary percentage. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
volume
number or null <double> 
No longer in use.


 
volume_Max
number or null <double> 
Indicates the benefit maximum of the disabiltiy plan.


 
volume_Min
number or null <double> 
Indicates the benefit minimum of the disability plan.


 
Responses 
207
Success


401
Unauthorized


put/groups/{groupID}/divisions/{divisionID}/contracts/{coverageStart}/plans-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}