Skip to content

Create GroupPlanYear

Request

Creates a new GroupPlanYear

Security
apiKeyAuth and bearerAuth
Path
groupIDstringrequired

Group ID

divisionIDstringrequired

Division ID

Headers
vbasoftware-databasestringrequired

Target database

Bodyapplication/jsonrequired
group_IDstring, [ 1 .. 20 ] charactersrequired

References GroupDivision.Group_ID value on the parent record.

division_IDstring, [ 1 .. 20 ] charactersrequired

References GroupDivision.Division_ID value on the parent record.

plan_Yearstring, [ 1 .. 8 ] charactersrequired

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_Datestring, (date-time)

Date when the record was first added to the system.

entry_Userstring or null, <= 20 characters

User that first added the record to the system.

ex_Codestring or null, <= 6 characters

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

from_Datestring or null, (date-time)

The date range for this Plan Year.

plan_Typestring 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_Accumbooleanrequired

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_Codestring 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_Deductiblebooleanrequired

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_Datestring 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_Memberbooleanrequired

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_Pocketbooleanrequired

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_Typestring 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_PlanYearstring 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_Subscriberbooleanrequired

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_Datestring 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_Datestring or null, (date-time)

The date range for this Plan Year.

update_Datestring, (date-time)

Date when the record was last updated in the system.

update_Userstring or null, <= 20 characters

User that last updated the record in the system.

curl -i -X POST \
  'https://vbapi.vbasoftware.com/vbasoftware/groups/{groupID}/divisions/{divisionID}/plan-years' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'vbasoftware-database: string' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "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"
  }'

Responses

Success

Bodyapplication/json
dataobject
errorobject
debugobject
Response
{
  "data": { … },
  "error": { … },
  "debug": { … }
}