Group Plan Years

Create GroupPlanYear

Creates a new GroupPlanYear

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
groupID
required
string

Group ID

divisionID
required
string

Division ID

header Parameters
vbasoftware-database
required
string

Target database

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

References GroupDivision.Group_ID value on the parent record.

division_ID
required
string [ 1 .. 20 ] characters

References GroupDivision.Division_ID value on the parent record.

plan_Year
required
string [ 1 .. 8 ] characters

User defined Plan Year value for this accumulator period. Should denote the values in From_Date and Thru_Date. Example: Plan Year "CY2009" would be 1/1/2009 - 12/31/2009.

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.

ex_Code
string or null <= 6 characters

If an Ex_Code should be applied when a claim is identified for carry over, place that here.

from_Date
string or null <date-time>

The date range for this Plan Year.

plan_Type
string or null <= 6 characters

If this Plan Year is specific to a Plan Type, you would denote that here. Normally no value is set for standard accumulation.

qtr4_Accum
required
boolean

Indicates if this Plan Year has 4th quarter carry-over. Note: This field is marked as NOT NULL in the database and therefore required by the API.

qtr4_Benefit_Code
string or null <= 10 characters

When accumulators are carried over they are bucketed into a single Benefit Code (typically a shell Benefit Code to catch the carry-over dollars).

qtr4_Deductible
required
boolean

Indicates if carry-over applies to Deductible. Note: This field is marked as NOT NULL in the database and therefore required by the API.

qtr4_From_Date
string or null <date-time>

If this Plan Year has 4th quarter carrry-over, this would indiate the dates, inside From_Date and Thru_Date, that signify the 4th quarter carry-over period.

qtr4_Member
required
boolean

Indicates if the carry-over applies to Member level accumulators. Note: This field is marked as NOT NULL in the database and therefore required by the API.

qtr4_Out_Of_Pocket
required
boolean

Indicates if carry-over applies to Out of Pocket. Note: This field is marked as NOT NULL in the database and therefore required by the API.

qtr4_Out_Of_Pocket_Type
string or null <= 16 characters

If Out of Pocket carry-over is flagged, this identifies what constitutes Out of Pocket (Deductible, Co-Ins, Co-Pay).

qtr4_PlanYear
string or null <= 8 characters

Indicates which Plan Year these carry-over accumulators will carry over to (typically a plan year on the other side of the carry-over period).

qtr4_Subscriber
required
boolean

Indicates if the carry-over applies to the entire Family for accumulators. Note: This field is marked as NOT NULL in the database and therefore required by the API.

qtr4_Thru_Date
string or null <date-time>

If this Plan Year has 4th quarter carrry-over, this would indiate the dates, inside From_Date and Thru_Date, that signify the 4th quarter carry-over period.

thru_Date
string or null <date-time>

The date range for this Plan Year.

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.

Responses
200

Success

401

Unauthorized

post/groups/{groupID}/divisions/{divisionID}/plan-years
Request samples
{
  • "group_ID": "string",
  • "division_ID": "string",
  • "plan_Year": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "ex_Code": "string",
  • "from_Date": "2019-08-24T14:15:22Z",
  • "plan_Type": "string",
  • "qtr4_Accum": true,
  • "qtr4_Benefit_Code": "string",
  • "qtr4_Deductible": true,
  • "qtr4_From_Date": "2019-08-24T14:15:22Z",
  • "qtr4_Member": true,
  • "qtr4_Out_Of_Pocket": true,
  • "qtr4_Out_Of_Pocket_Type": "string",
  • "qtr4_PlanYear": "string",
  • "qtr4_Subscriber": true,
  • "qtr4_Thru_Date": "2019-08-24T14:15:22Z",
  • "thru_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List GroupPlanYear

Lists all GroupPlanYear for the given groupID and divisionID

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
groupID
required
string

Group ID

divisionID
required
string

Division 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/groups/{groupID}/divisions/{divisionID}/plan-years
Request samples 
Response samples 
No sample
Get GroupPlanYear
Gets GroupPlanYear


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
groupID
required
string
Group ID


 
divisionID
required
string
Division ID


 
planYear
required
string
Plan Year


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/groups/{groupID}/divisions/{divisionID}/plan-years/{planYear}
Request samples 
Response samples 
No sample
Update GroupPlanYear
Updates a specific GroupPlanYear.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
groupID
required
string
Group ID


 
divisionID
required
string
Division ID


 
planYear
required
string
Plan Year


 
header Parameters
vbasoftware-database
required
string
Target database


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


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


 
plan_Year
required
string  [ 1 .. 8 ] characters 
User defined Plan Year value for this accumulator period. Should denote the values in From_Date and Thru_Date. Example: Plan Year "CY2009" would be 1/1/2009 - 12/31/2009.


 
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.


 
ex_Code
string or null  <= 6 characters 
If an Ex_Code should be applied when a claim is identified for carry over, place that here.


 
from_Date
string or null <date-time> 
The date range for this Plan Year.


 
plan_Type
string or null  <= 6 characters 
If this Plan Year is specific to a Plan Type, you would denote that here. Normally no value is set for standard accumulation.


 
qtr4_Accum
required
boolean
Indicates if this Plan Year has 4th quarter carry-over. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
qtr4_Benefit_Code
string or null  <= 10 characters 
When accumulators are carried over they are bucketed into a single Benefit Code (typically a shell Benefit Code to catch the carry-over dollars).


 
qtr4_Deductible
required
boolean
Indicates if carry-over applies to Deductible. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
qtr4_From_Date
string or null <date-time> 
If this Plan Year has 4th quarter carrry-over, this would indiate the dates, inside From_Date and Thru_Date, that signify the 4th quarter carry-over period.


 
qtr4_Member
required
boolean
Indicates if the carry-over applies to Member level accumulators. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
qtr4_Out_Of_Pocket
required
boolean
Indicates if carry-over applies to Out of Pocket. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
qtr4_Out_Of_Pocket_Type
string or null  <= 16 characters 
If Out of Pocket carry-over is flagged, this identifies what constitutes Out of Pocket (Deductible, Co-Ins, Co-Pay).


 
qtr4_PlanYear
string or null  <= 8 characters 
Indicates which Plan Year these carry-over accumulators will carry over to (typically a plan year on the other side of the carry-over period).


 
qtr4_Subscriber
required
boolean
Indicates if the carry-over applies to the entire Family for accumulators. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
qtr4_Thru_Date
string or null <date-time> 
If this Plan Year has 4th quarter carrry-over, this would indiate the dates, inside From_Date and Thru_Date, that signify the 4th quarter carry-over period.


 
thru_Date
string or null <date-time> 
The date range for this Plan Year.


 
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.


 
Responses 
200
Success


401
Unauthorized


put/groups/{groupID}/divisions/{divisionID}/plan-years/{planYear}
Request samples 
{
  • "group_ID": "string",
  • "division_ID": "string",
  • "plan_Year": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "ex_Code": "string",
  • "from_Date": "2019-08-24T14:15:22Z",
  • "plan_Type": "string",
  • "qtr4_Accum": true,
  • "qtr4_Benefit_Code": "string",
  • "qtr4_Deductible": true,
  • "qtr4_From_Date": "2019-08-24T14:15:22Z",
  • "qtr4_Member": true,
  • "qtr4_Out_Of_Pocket": true,
  • "qtr4_Out_Of_Pocket_Type": "string",
  • "qtr4_PlanYear": "string",
  • "qtr4_Subscriber": true,
  • "qtr4_Thru_Date": "2019-08-24T14:15:22Z",
  • "thru_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete GroupPlanYear
Deletes an GroupPlanYear


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
groupID
required
string
Group ID


 
divisionID
required
string
Division ID


 
planYear
required
string
Plan Year


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/groups/{groupID}/divisions/{divisionID}/plan-years/{planYear}
Request samples 
Create or Update Batch GroupPlanYear
Create or Update multiple GroupPlanYear 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


 
header Parameters
vbasoftware-database
required
string
Target database


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


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


 
plan_Year
required
string  [ 1 .. 8 ] characters 
User defined Plan Year value for this accumulator period. Should denote the values in From_Date and Thru_Date. Example: Plan Year "CY2009" would be 1/1/2009 - 12/31/2009.


 
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.


 
ex_Code
string or null  <= 6 characters 
If an Ex_Code should be applied when a claim is identified for carry over, place that here.


 
from_Date
string or null <date-time> 
The date range for this Plan Year.


 
plan_Type
string or null  <= 6 characters 
If this Plan Year is specific to a Plan Type, you would denote that here. Normally no value is set for standard accumulation.


 
qtr4_Accum
required
boolean
Indicates if this Plan Year has 4th quarter carry-over. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
qtr4_Benefit_Code
string or null  <= 10 characters 
When accumulators are carried over they are bucketed into a single Benefit Code (typically a shell Benefit Code to catch the carry-over dollars).


 
qtr4_Deductible
required
boolean
Indicates if carry-over applies to Deductible. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
qtr4_From_Date
string or null <date-time> 
If this Plan Year has 4th quarter carrry-over, this would indiate the dates, inside From_Date and Thru_Date, that signify the 4th quarter carry-over period.


 
qtr4_Member
required
boolean
Indicates if the carry-over applies to Member level accumulators. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
qtr4_Out_Of_Pocket
required
boolean
Indicates if carry-over applies to Out of Pocket. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
qtr4_Out_Of_Pocket_Type
string or null  <= 16 characters 
If Out of Pocket carry-over is flagged, this identifies what constitutes Out of Pocket (Deductible, Co-Ins, Co-Pay).


 
qtr4_PlanYear
string or null  <= 8 characters 
Indicates which Plan Year these carry-over accumulators will carry over to (typically a plan year on the other side of the carry-over period).


 
qtr4_Subscriber
required
boolean
Indicates if the carry-over applies to the entire Family for accumulators. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
qtr4_Thru_Date
string or null <date-time> 
If this Plan Year has 4th quarter carrry-over, this would indiate the dates, inside From_Date and Thru_Date, that signify the 4th quarter carry-over period.


 
thru_Date
string or null <date-time> 
The date range for this Plan Year.


 
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.


 
Responses 
207
Success


401
Unauthorized


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