Plan Benefit Place Co-Insurance

Create PlanBenefitsPlaceCoIns

Creates a new PlanBenefitsPlaceCoIns

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.

co_Ins_Net_Pct
required
string = 1 characters

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

co_Ins_Pct
required
string = 1 characters

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

co_Insurance
number or null <double>

Out of Network Co-Insurance amount.

co_Insurance_Net
number or null <double>

In Network Co-Insurance amount.

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-insurance
Request samples
{
  • "plan_ID": "string",
  • "benefit_Code": "string",
  • "place_Code": "stri",
  • "co_Ins_Net_Pct": "s",
  • "co_Ins_Pct": "s",
  • "co_Insurance": 0.1,
  • "co_Insurance_Net": 0.1,
  • "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 PlanBenefitsPlaceCoIns

Lists all PlanBenefitsPlaceCoIns 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-insurance
Request samples
Response samples
No sample

Get PlanBenefitsPlaceCoIns

Gets PlanBenefitsPlaceCoIns

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-insurance/{placeCode}
Request samples
Response samples
No sample

Update PlanBenefitsPlaceCoIns

Updates a specific PlanBenefitsPlaceCoIns.

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.

co_Ins_Net_Pct
required
string = 1 characters

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

co_Ins_Pct
required
string = 1 characters

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

co_Insurance
number or null <double>

Out of Network Co-Insurance amount.

co_Insurance_Net
number or null <double>

In Network Co-Insurance amount.

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-insurance/{placeCode}
Request samples
{
  • "plan_ID": "string",
  • "benefit_Code": "string",
  • "place_Code": "stri",
  • "co_Ins_Net_Pct": "s",
  • "co_Ins_Pct": "s",
  • "co_Insurance": 0.1,
  • "co_Insurance_Net": 0.1,
  • "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 PlanBenefitsPlaceCoIns

Deletes an PlanBenefitsPlaceCoIns

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-insurance/{placeCode}
Request samples

Create or Update Batch PlanBenefitsPlaceCoIns

Create or Update multiple PlanBenefitsPlaceCoIns 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.

co_Ins_Net_Pct
required
string = 1 characters

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

co_Ins_Pct
required
string = 1 characters

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

co_Insurance
number or null <double>

Out of Network Co-Insurance amount.

co_Insurance_Net
number or null <double>

In Network Co-Insurance amount.

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