Group Subscriber Reimbursements

Create SubscriberReimbursement

Creates a new SubscriberReimbursement

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
groupID
required
string

Group ID

planID
required
string

Plan ID

benefitCode
required
string

Benefit Code

maxID
required
string

Max ID

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
subscriberReimbursement_Key
required
integer <int32>

Unique identifier for each remibursement configuration for this Group and Plan. Note: This field is marked as NOT NULL in the database and therefore required by the API.

benefit_Code
required
string [ 1 .. 10 ] characters

References BenefitCodes.Benefit_Code value on parent record.

effective_Date
string or null <date-time>

Effective date of this remibursement configuration.

entry_Date
string <date-time>

User that first added the record to the system.

entry_User
string or null <= 20 characters

Date when the record was first added to the system.

group_ID
required
string [ 1 .. 20 ] characters

References Groups.Group_ID value on parent record.

max_ID
required
string [ 1 .. 10 ] characters

References PlanMaximum.Max_ID value on parent record.

plan_ID
required
string [ 1 .. 20 ] characters

References Plans.Plan_ID value on parent record.

term_Date
string or null <date-time>

Term Date of this reimbursement configuration.

update_Date
string <date-time>

User that last updated the record in the system.

update_User
string or null <= 20 characters

Date when the record was last updated in the system.

Responses
200

Success

401

Unauthorized

post/groups/{groupID}/plans/{planID}/benefits/{benefitCode}/maximums/{maxID}/subscriber-reimbursements
Request samples
{
  • "subscriberReimbursement_Key": 0,
  • "benefit_Code": "string",
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "group_ID": "string",
  • "max_ID": "string",
  • "plan_ID": "string",
  • "term_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List SubscriberReimbursement

Lists all SubscriberReimbursement for the given groupID and planID and benefitCode and maxID

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
groupID
required
string

Group ID

planID
required
string

Plan ID

benefitCode
required
string

Benefit Code

maxID
required
string

Max 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}/plans/{planID}/benefits/{benefitCode}/maximums/{maxID}/subscriber-reimbursements
Request samples 
Response samples 
No sample
Get SubscriberReimbursement
Gets SubscriberReimbursement


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
groupID
required
string
Group ID


 
planID
required
string
Plan ID


 
benefitCode
required
string
Benefit Code


 
maxID
required
string
Max ID


 
subscriberReimbursementKey
required
integer <int32> 
SubscriberReimbursement Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/groups/{groupID}/plans/{planID}/benefits/{benefitCode}/maximums/{maxID}/subscriber-reimbursements/{subscriberReimbursementKey}
Request samples 
Response samples 
No sample
Update SubscriberReimbursement
Updates a specific SubscriberReimbursement.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
groupID
required
string
Group ID


 
planID
required
string
Plan ID


 
benefitCode
required
string
Benefit Code


 
maxID
required
string
Max ID


 
subscriberReimbursementKey
required
integer <int32> 
SubscriberReimbursement Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
subscriberReimbursement_Key
required
integer <int32> 
Unique identifier for each remibursement configuration for this Group and Plan. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
benefit_Code
required
string  [ 1 .. 10 ] characters 
References BenefitCodes.Benefit_Code value on parent record.


 
effective_Date
string or null <date-time> 
Effective date of this remibursement configuration.


 
entry_Date
string <date-time> 
User that first added the record to the system.


 
entry_User
string or null  <= 20 characters 
Date when the record was first added to the system.


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


 
max_ID
required
string  [ 1 .. 10 ] characters 
References PlanMaximum.Max_ID value on parent record.


 
plan_ID
required
string  [ 1 .. 20 ] characters 
References Plans.Plan_ID value on parent record.


 
term_Date
string or null <date-time> 
Term Date of this reimbursement configuration.


 
update_Date
string <date-time> 
User that last updated the record in the system.


 
update_User
string or null  <= 20 characters 
Date when the record was last updated in the system.


 
Responses 
200
Success


401
Unauthorized


put/groups/{groupID}/plans/{planID}/benefits/{benefitCode}/maximums/{maxID}/subscriber-reimbursements/{subscriberReimbursementKey}
Request samples 
{
  • "subscriberReimbursement_Key": 0,
  • "benefit_Code": "string",
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "group_ID": "string",
  • "max_ID": "string",
  • "plan_ID": "string",
  • "term_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete SubscriberReimbursement
Deletes an SubscriberReimbursement


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
groupID
required
string
Group ID


 
planID
required
string
Plan ID


 
benefitCode
required
string
Benefit Code


 
maxID
required
string
Max ID


 
subscriberReimbursementKey
required
integer <int32> 
SubscriberReimbursement Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/groups/{groupID}/plans/{planID}/benefits/{benefitCode}/maximums/{maxID}/subscriber-reimbursements/{subscriberReimbursementKey}
Request samples 
Create or Update Batch SubscriberReimbursement
Create or Update multiple SubscriberReimbursement 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


 
planID
required
string
Plan ID


 
benefitCode
required
string
Benefit Code


 
maxID
required
string
Max ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
subscriberReimbursement_Key
required
integer <int32> 
Unique identifier for each remibursement configuration for this Group and Plan. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
benefit_Code
required
string  [ 1 .. 10 ] characters 
References BenefitCodes.Benefit_Code value on parent record.


 
effective_Date
string or null <date-time> 
Effective date of this remibursement configuration.


 
entry_Date
string <date-time> 
User that first added the record to the system.


 
entry_User
string or null  <= 20 characters 
Date when the record was first added to the system.


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


 
max_ID
required
string  [ 1 .. 10 ] characters 
References PlanMaximum.Max_ID value on parent record.


 
plan_ID
required
string  [ 1 .. 20 ] characters 
References Plans.Plan_ID value on parent record.


 
term_Date
string or null <date-time> 
Term Date of this reimbursement configuration.


 
update_Date
string <date-time> 
User that last updated the record in the system.


 
update_User
string or null  <= 20 characters 
Date when the record was last updated in the system.


 
Responses 
207
Success


401
Unauthorized


put/groups/{groupID}/plans/{planID}/benefits/{benefitCode}/maximums/{maxID}/subscriber-reimbursements-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}