Plan Benefit Place Co-Pays

Create PlanBenefitsPlaceCoPay

Creates a new PlanBenefitsPlaceCoPay

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
planID
required
string

Plan ID

benefitCode
required
string

Benefit Code

header Parameters
vbasoftware-database
required
string

Target database

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

References the PlanBenefitsPlace.Plan_ID value in parent table.

benefit_Code
required
string [ 1 .. 10 ] characters

References the PlanBenefitsPlace.Benefit_Code value in parent table.

place_Code
required
string [ 1 .. 4 ] characters

References the PlanBenefitsPlace.Place_Code value in parent table.

copay_Amt
number or null <double>

Out of Network Co-Pay amount.

copay_Amt_Net
number or null <double>

In Network Co-Pay amount.

copay_Amt_Net_OOP
required
boolean

Indicates that the In Network Co-Pay will continue to be taken after the Out of Pocket has been met. Note: This field is marked as NOT NULL in the database and therefore required by the API.

copay_Amt_OOP
required
boolean

Indicates that the Out of Network Co-Pay will continue to be taken after the Out of Pocket has been met. Note: This field is marked as NOT NULL in the database and therefore required by the API.

copay_Pct
required
string = 1 characters

Indicates whether the Out of Network Co-Pay amount is a percentage. Note: This field is marked as NOT NULL in the database and therefore required by the API.

copay_Pct_Net
required
string = 1 characters

Indicates whether the In Network Co-Pay amount is a percentage. Note: This field is marked as NOT NULL in the database and therefore required by the API.

copay_Per
string or null <= 1 characters

Indicates the frequency that Co-Pay is taken: 1. Day - per service date. 2. Occurrence - per occurrence date on the claim header. 3. Service - per service line. 4. Unit - per unit on the service line. 5. Visit - per day per Provider.

entry_Date
string <date-time>

Date when the record was 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/plans/{planID}/benefits/{benefitCode}/place-co-pays
Request samples
{
  • "plan_ID": "string",
  • "benefit_Code": "string",
  • "place_Code": "stri",
  • "copay_Amt": 0.1,
  • "copay_Amt_Net": 0.1,
  • "copay_Amt_Net_OOP": true,
  • "copay_Amt_OOP": true,
  • "copay_Pct": "s",
  • "copay_Pct_Net": "s",
  • "copay_Per": "s",
  • "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 PlanBenefitsPlaceCoPay

Lists all PlanBenefitsPlaceCoPay for the given planID and benefitCode

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
planID
required
string

Plan ID

benefitCode
required
string

Benefit Code

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/plans/{planID}/benefits/{benefitCode}/place-co-pays
Request samples 
Response samples 
No sample
Get PlanBenefitsPlaceCoPay
Gets PlanBenefitsPlaceCoPay


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
planID
required
string
Plan ID


 
benefitCode
required
string
Benefit Code


 
placeCode
required
string
Place Code


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/plans/{planID}/benefits/{benefitCode}/place-co-pays/{placeCode}
Request samples 
Response samples 
No sample
Update PlanBenefitsPlaceCoPay
Updates a specific PlanBenefitsPlaceCoPay.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
planID
required
string
Plan ID


 
benefitCode
required
string
Benefit Code


 
placeCode
required
string
Place Code


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
plan_ID
required
string  [ 1 .. 20 ] characters 
References the PlanBenefitsPlace.Plan_ID value in parent table.


 
benefit_Code
required
string  [ 1 .. 10 ] characters 
References the PlanBenefitsPlace.Benefit_Code value in parent table.


 
place_Code
required
string  [ 1 .. 4 ] characters 
References the PlanBenefitsPlace.Place_Code value in parent table.


 
copay_Amt
number or null <double> 
Out of Network Co-Pay amount.


 
copay_Amt_Net
number or null <double> 
In Network Co-Pay amount.


 
copay_Amt_Net_OOP
required
boolean
Indicates that the In Network Co-Pay will continue to be taken after the Out of Pocket has been met. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
copay_Amt_OOP
required
boolean
Indicates that the Out of Network Co-Pay will continue to be taken after the Out of Pocket has been met. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
copay_Pct
required
string  = 1 characters 
Indicates whether the Out of Network Co-Pay amount is a percentage. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
copay_Pct_Net
required
string  = 1 characters 
Indicates whether the In Network Co-Pay amount is a percentage. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
copay_Per
string or null  <= 1 characters 
Indicates the frequency that Co-Pay is taken: 1. Day - per service date. 2. Occurrence - per occurrence date on the claim header. 3. Service - per service line. 4. Unit - per unit on the service line. 5. Visit - per day per Provider.


 
entry_Date
string <date-time> 
Date when the record was 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/plans/{planID}/benefits/{benefitCode}/place-co-pays/{placeCode}
Request samples 
{
  • "plan_ID": "string",
  • "benefit_Code": "string",
  • "place_Code": "stri",
  • "copay_Amt": 0.1,
  • "copay_Amt_Net": 0.1,
  • "copay_Amt_Net_OOP": true,
  • "copay_Amt_OOP": true,
  • "copay_Pct": "s",
  • "copay_Pct_Net": "s",
  • "copay_Per": "s",
  • "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 PlanBenefitsPlaceCoPay
Deletes an PlanBenefitsPlaceCoPay


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
planID
required
string
Plan ID


 
benefitCode
required
string
Benefit Code


 
placeCode
required
string
Place Code


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/plans/{planID}/benefits/{benefitCode}/place-co-pays/{placeCode}
Request samples 
Create or Update Batch PlanBenefitsPlaceCoPay
Create or Update multiple PlanBenefitsPlaceCoPay 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
planID
required
string
Plan ID


 
benefitCode
required
string
Benefit Code


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
plan_ID
required
string  [ 1 .. 20 ] characters 
References the PlanBenefitsPlace.Plan_ID value in parent table.


 
benefit_Code
required
string  [ 1 .. 10 ] characters 
References the PlanBenefitsPlace.Benefit_Code value in parent table.


 
place_Code
required
string  [ 1 .. 4 ] characters 
References the PlanBenefitsPlace.Place_Code value in parent table.


 
copay_Amt
number or null <double> 
Out of Network Co-Pay amount.


 
copay_Amt_Net
number or null <double> 
In Network Co-Pay amount.


 
copay_Amt_Net_OOP
required
boolean
Indicates that the In Network Co-Pay will continue to be taken after the Out of Pocket has been met. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
copay_Amt_OOP
required
boolean
Indicates that the Out of Network Co-Pay will continue to be taken after the Out of Pocket has been met. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
copay_Pct
required
string  = 1 characters 
Indicates whether the Out of Network Co-Pay amount is a percentage. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
copay_Pct_Net
required
string  = 1 characters 
Indicates whether the In Network Co-Pay amount is a percentage. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
copay_Per
string or null  <= 1 characters 
Indicates the frequency that Co-Pay is taken: 1. Day - per service date. 2. Occurrence - per occurrence date on the claim header. 3. Service - per service line. 4. Unit - per unit on the service line. 5. Visit - per day per Provider.


 
entry_Date
string <date-time> 
Date when the record was 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/plans/{planID}/benefits/{benefitCode}/place-co-pays-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}