Group Flex Auto-Create

Create GroupFlexCreate

Creates a new GroupFlexCreate

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
groupID
required
string

Group ID

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
groupFlexCreate_Key
required
integer <int32>

Unique identifier for each auto-create flex setting. Note: This field is marked as NOT NULL in the database and therefore required by the API.

co_Ins
required
boolean

Flag notifing if this piece of the member responsibility should be created as a Flex payment. Note: This field is marked as NOT NULL in the database and therefore required by the API.

co_Pay
required
boolean

Flag notifing if this piece of the member responsibility should be created as a Flex payment. Note: This field is marked as NOT NULL in the database and therefore required by the API.

combine
required
boolean

Indicates if the various member responsibility amounts selected for auto flex creation should be combined into a single claim payment. Note: This field is marked as NOT NULL in the database and therefore required by the API.

create_From_Plan_ID
string or null <= 20 characters

Indicates the Plan (typically the medical plan) that will have the claim with member responsibility that needs to be moved to a flex submission.

create_To_Plan_ID
string or null <= 20 characters

Indicates the Plan (the Flex plan) that will have the member responsibility moved to in order to create the flex submission.

deductible
required
boolean

Flag notifing if this piece of the member responsibility should be created as a Flex payment. Note: This field is marked as NOT NULL in the database and therefore required by the API.

effective_Date
string or null <date-time>

The effective date of this auto-create processing rule.

employee_Only
required
boolean

A flag indicating auto created flex claims should be created for employees only, not members. Note: This field is marked as NOT NULL in the database and therefore required by the API.

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

The Ex Code that is applied to the newly created flex claim.

group_ID
required
string [ 1 .. 20 ] characters

References Groups.Group_ID value on the parent record.

not_Covered
required
boolean

Flag notifing if this piece of the member responsibility should be created as a Flex payment. Note: This field is marked as NOT NULL in the database and therefore required by the API.

term_Date
string or null <date-time>

The term date for this auto-create processing rule.

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}/flex-auto-creates
Request samples
{
  • "groupFlexCreate_Key": 0,
  • "co_Ins": true,
  • "co_Pay": true,
  • "combine": true,
  • "create_From_Plan_ID": "string",
  • "create_To_Plan_ID": "string",
  • "deductible": true,
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "employee_Only": true,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "ex_Code": "string",
  • "group_ID": "string",
  • "not_Covered": true,
  • "term_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List GroupFlexCreate

Lists all GroupFlexCreate for the given groupID

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
groupID
required
string

Group 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}/flex-auto-creates
Request samples 
Response samples 
No sample
Get GroupFlexCreate
Gets GroupFlexCreate


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
groupID
required
string
Group ID


 
groupFlexCreateKey
required
integer <int32> 
GroupFlexCreate Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/groups/{groupID}/flex-auto-creates/{groupFlexCreateKey}
Request samples 
Response samples 
No sample
Update GroupFlexCreate
Updates a specific GroupFlexCreate.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
groupID
required
string
Group ID


 
groupFlexCreateKey
required
integer <int32> 
GroupFlexCreate Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
groupFlexCreate_Key
required
integer <int32> 
Unique identifier for each auto-create flex setting. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
co_Ins
required
boolean
Flag notifing if this piece of the member responsibility should be created as a Flex payment. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
co_Pay
required
boolean
Flag notifing if this piece of the member responsibility should be created as a Flex payment. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
combine
required
boolean
Indicates if the various member responsibility amounts selected for auto flex creation should be combined into a single claim payment. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
create_From_Plan_ID
string or null  <= 20 characters 
Indicates the Plan (typically the medical plan) that will have the claim with member responsibility that needs to be moved to a flex submission.


 
create_To_Plan_ID
string or null  <= 20 characters 
Indicates the Plan (the Flex plan) that will have the member responsibility moved to in order to create the flex submission.


 
deductible
required
boolean
Flag notifing if this piece of the member responsibility should be created as a Flex payment. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
effective_Date
string or null <date-time> 
The effective date of this auto-create processing rule.


 
employee_Only
required
boolean
A flag indicating auto created flex claims should be created for employees only, not members. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
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 
The Ex Code that is applied to the newly created flex claim.


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


 
not_Covered
required
boolean
Flag notifing if this piece of the member responsibility should be created as a Flex payment. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
term_Date
string or null <date-time> 
The term date for this auto-create processing rule.


 
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}/flex-auto-creates/{groupFlexCreateKey}
Request samples 
{
  • "groupFlexCreate_Key": 0,
  • "co_Ins": true,
  • "co_Pay": true,
  • "combine": true,
  • "create_From_Plan_ID": "string",
  • "create_To_Plan_ID": "string",
  • "deductible": true,
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "employee_Only": true,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "ex_Code": "string",
  • "group_ID": "string",
  • "not_Covered": true,
  • "term_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete GroupFlexCreate
Deletes an GroupFlexCreate


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
groupID
required
string
Group ID


 
groupFlexCreateKey
required
integer <int32> 
GroupFlexCreate Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/groups/{groupID}/flex-auto-creates/{groupFlexCreateKey}
Request samples 
Create or Update Batch GroupFlexCreate
Create or Update multiple GroupFlexCreate 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


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
groupFlexCreate_Key
required
integer <int32> 
Unique identifier for each auto-create flex setting. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
co_Ins
required
boolean
Flag notifing if this piece of the member responsibility should be created as a Flex payment. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
co_Pay
required
boolean
Flag notifing if this piece of the member responsibility should be created as a Flex payment. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
combine
required
boolean
Indicates if the various member responsibility amounts selected for auto flex creation should be combined into a single claim payment. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
create_From_Plan_ID
string or null  <= 20 characters 
Indicates the Plan (typically the medical plan) that will have the claim with member responsibility that needs to be moved to a flex submission.


 
create_To_Plan_ID
string or null  <= 20 characters 
Indicates the Plan (the Flex plan) that will have the member responsibility moved to in order to create the flex submission.


 
deductible
required
boolean
Flag notifing if this piece of the member responsibility should be created as a Flex payment. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
effective_Date
string or null <date-time> 
The effective date of this auto-create processing rule.


 
employee_Only
required
boolean
A flag indicating auto created flex claims should be created for employees only, not members. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
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 
The Ex Code that is applied to the newly created flex claim.


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


 
not_Covered
required
boolean
Flag notifing if this piece of the member responsibility should be created as a Flex payment. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
term_Date
string or null <date-time> 
The term date for this auto-create processing rule.


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