Group Plan Prior Accum Auto Generators

Create GroupPlanYearAutoPriorAccum

Creates a new GroupPlanYearAutoPriorAccum

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
groupPlanYearAutoPriorAccum_Key
required
integer <int32>

Unique identifer for each auto prior accum configuration. Note: This field is marked as NOT NULL in the database and therefore required by the API.

division_ID
required
string [ 1 .. 20 ] characters

References GroupPlanYear.Division_ID value on the parent record.

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.

group_ID
required
string [ 1 .. 20 ] characters

References GroupPlanYear.Group_ID value on the parent record.

plan_Type
required
string [ 1 .. 6 ] characters

References GroupPlanYear.Plan_Type value on the parent record.

plan_Year
required
string [ 1 .. 20 ] characters

References GroupPlanYear.Plan_Year value on the parent record.

prior_Accum_Benefit_Code
string or null <= 10 characters

When auto prior accums are set, this indicates the Benefit_Code value to be written to the prior accum record.

prior_Accum_Plan_Type
required
string [ 1 .. 6 ] characters

When auto prior accums are set, this indicates the Plan_Type value to be written to the prior accum record.

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/{planYear}/prior-accum-auto-generators
Request samples
{
  • "groupPlanYearAutoPriorAccum_Key": 0,
  • "division_ID": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "group_ID": "string",
  • "plan_Type": "string",
  • "plan_Year": "string",
  • "prior_Accum_Benefit_Code": "string",
  • "prior_Accum_Plan_Type": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List GroupPlanYearAutoPriorAccum

Lists all GroupPlanYearAutoPriorAccum for the given groupID and divisionID and planYear

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
groupID
required
string

Group ID

divisionID
required
string

Division ID

planYear
required
string

Plan Year

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/{planYear}/prior-accum-auto-generators
Request samples 
Response samples 
No sample
Get GroupPlanYearAutoPriorAccum
Gets GroupPlanYearAutoPriorAccum


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
groupID
required
string
Group ID


 
divisionID
required
string
Division ID


 
planYear
required
string
Plan Year


 
groupPlanYearAutoPriorAccumKey
required
integer <int32> 
GroupPlanYearAutoPriorAccum Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/groups/{groupID}/divisions/{divisionID}/plan-years/{planYear}/prior-accum-auto-generators/{groupPlanYearAutoPriorAccumKey}
Request samples 
Response samples 
No sample
Update GroupPlanYearAutoPriorAccum
Updates a specific GroupPlanYearAutoPriorAccum.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
groupID
required
string
Group ID


 
divisionID
required
string
Division ID


 
planYear
required
string
Plan Year


 
groupPlanYearAutoPriorAccumKey
required
integer <int32> 
GroupPlanYearAutoPriorAccum Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
groupPlanYearAutoPriorAccum_Key
required
integer <int32> 
Unique identifer for each auto prior accum configuration. Note: This field is marked as NOT NULL in the database and therefore required by the API.


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


 
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.


 
group_ID
required
string  [ 1 .. 20 ] characters 
References GroupPlanYear.Group_ID value on the parent record.


 
plan_Type
required
string  [ 1 .. 6 ] characters 
References GroupPlanYear.Plan_Type value on the parent record.


 
plan_Year
required
string  [ 1 .. 20 ] characters 
References GroupPlanYear.Plan_Year value on the parent record.


 
prior_Accum_Benefit_Code
string or null  <= 10 characters 
When auto prior accums are set, this indicates the Benefit_Code value to be written to the prior accum record.


 
prior_Accum_Plan_Type
required
string  [ 1 .. 6 ] characters 
When auto prior accums are set, this indicates the Plan_Type value to be written to the prior accum record.


 
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}/prior-accum-auto-generators/{groupPlanYearAutoPriorAccumKey}
Request samples 
{
  • "groupPlanYearAutoPriorAccum_Key": 0,
  • "division_ID": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "group_ID": "string",
  • "plan_Type": "string",
  • "plan_Year": "string",
  • "prior_Accum_Benefit_Code": "string",
  • "prior_Accum_Plan_Type": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete GroupPlanYearAutoPriorAccum
Deletes an GroupPlanYearAutoPriorAccum


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
groupID
required
string
Group ID


 
divisionID
required
string
Division ID


 
planYear
required
string
Plan Year


 
groupPlanYearAutoPriorAccumKey
required
integer <int32> 
GroupPlanYearAutoPriorAccum Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/groups/{groupID}/divisions/{divisionID}/plan-years/{planYear}/prior-accum-auto-generators/{groupPlanYearAutoPriorAccumKey}
Request samples 
Create or Update Batch GroupPlanYearAutoPriorAccum
Create or Update multiple GroupPlanYearAutoPriorAccum 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


 
planYear
required
string
Plan Year


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
groupPlanYearAutoPriorAccum_Key
required
integer <int32> 
Unique identifer for each auto prior accum configuration. Note: This field is marked as NOT NULL in the database and therefore required by the API.


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


 
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.


 
group_ID
required
string  [ 1 .. 20 ] characters 
References GroupPlanYear.Group_ID value on the parent record.


 
plan_Type
required
string  [ 1 .. 6 ] characters 
References GroupPlanYear.Plan_Type value on the parent record.


 
plan_Year
required
string  [ 1 .. 20 ] characters 
References GroupPlanYear.Plan_Year value on the parent record.


 
prior_Accum_Benefit_Code
string or null  <= 10 characters 
When auto prior accums are set, this indicates the Benefit_Code value to be written to the prior accum record.


 
prior_Accum_Plan_Type
required
string  [ 1 .. 6 ] characters 
When auto prior accums are set, this indicates the Plan_Type value to be written to the prior accum record.


 
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/{planYear}/prior-accum-auto-generators-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}