Skip to content

Create PlanBenefitsPlaceCoPay

Request

Creates a new PlanBenefitsPlaceCoPay

Security
apiKeyAuth and bearerAuth
Path
planIDstringrequired

Plan ID

benefitCodestringrequired

Benefit Code

Headers
vbasoftware-databasestringrequired

Target database

Bodyapplication/jsonrequired
plan_IDstring, [ 1 .. 20 ] charactersrequired

References the PlanBenefitsPlace.Plan_ID value in parent table.

benefit_Codestring, [ 1 .. 10 ] charactersrequired

References the PlanBenefitsPlace.Benefit_Code value in parent table.

place_Codestring, [ 1 .. 4 ] charactersrequired

References the PlanBenefitsPlace.Place_Code value in parent table.

copay_Amtnumber or null, (double)

Out of Network Co-Pay amount.

copay_Amt_Netnumber or null, (double)

In Network Co-Pay amount.

copay_Amt_Net_OOPbooleanrequired

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_OOPbooleanrequired

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_Pctstring, = 1 charactersrequired

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_Netstring, = 1 charactersrequired

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_Perstring 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_Datestring, (date-time)

Date when the record was added to the system.

entry_Userstring or null, <= 20 characters

User that first added the record to the system.

update_Datestring, (date-time)

Date when the record was last updated in the system.

update_Userstring or null, <= 20 characters

User that last updated the record in the system.

curl -i -X POST \
  'https://vbapi.vbasoftware.com/vbasoftware/plans/{planID}/benefits/{benefitCode}/place-co-pays' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'vbasoftware-database: string' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "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"
  }'

Responses

Success

Bodyapplication/json
dataobject
errorobject
debugobject
Response
{
  "data": { … },
  "error": { … },
  "debug": { … }
}