Group Payor Account Benefits

Create GroupPayorAccountBenefit

Creates a new GroupPayorAccountBenefit

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
groupID
required
string

Group ID

settingID
required
string

Setting ID

header Parameters
vbasoftware-database
required
string

Target database

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

References GroupPayorAccount.Group_ID on the parent record.

setting_ID
required
string [ 1 .. 32 ] characters

References GroupPayorAccount.Setting_ID on the parent record.

benefit_Code
required
string [ 1 .. 10 ] characters

If the setting is Benefit Code specific, you would include the Benefit Code here.

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.

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}/payor-account-settings/{settingID}/benefits
Request samples
{
  • "group_ID": "string",
  • "setting_ID": "string",
  • "benefit_Code": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List GroupPayorAccountBenefit

Lists all GroupPayorAccountBenefit for the given groupID and settingID

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
groupID
required
string

Group ID

settingID
required
string

Setting 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}/payor-account-settings/{settingID}/benefits
Request samples 
Response samples 
No sample
Get GroupPayorAccountBenefit
Gets GroupPayorAccountBenefit


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
groupID
required
string
Group ID


 
settingID
required
string
Setting ID


 
benefitCode
required
string
Benefit Code


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/groups/{groupID}/payor-account-settings/{settingID}/benefits/{benefitCode}
Request samples 
Response samples 
No sample
Update GroupPayorAccountBenefit
Updates a specific GroupPayorAccountBenefit.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
groupID
required
string
Group ID


 
settingID
required
string
Setting ID


 
benefitCode
required
string
Benefit Code


 
header Parameters
vbasoftware-database
required
string
Target database


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


 
setting_ID
required
string  [ 1 .. 32 ] characters 
References GroupPayorAccount.Setting_ID on the parent record.


 
benefit_Code
required
string  [ 1 .. 10 ] characters 
If the setting is Benefit Code specific, you would include the Benefit Code here.


 
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.


 
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}/payor-account-settings/{settingID}/benefits/{benefitCode}
Request samples 
{
  • "group_ID": "string",
  • "setting_ID": "string",
  • "benefit_Code": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete GroupPayorAccountBenefit
Deletes an GroupPayorAccountBenefit


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
groupID
required
string
Group ID


 
settingID
required
string
Setting ID


 
benefitCode
required
string
Benefit Code


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/groups/{groupID}/payor-account-settings/{settingID}/benefits/{benefitCode}
Request samples 
Create or Update Batch GroupPayorAccountBenefit
Create or Update multiple GroupPayorAccountBenefit 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


 
settingID
required
string
Setting ID


 
header Parameters
vbasoftware-database
required
string
Target database


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


 
setting_ID
required
string  [ 1 .. 32 ] characters 
References GroupPayorAccount.Setting_ID on the parent record.


 
benefit_Code
required
string  [ 1 .. 10 ] characters 
If the setting is Benefit Code specific, you would include the Benefit Code here.


 
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.


 
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}/payor-account-settings/{settingID}/benefits-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}