Skip to content
/
Create or Update Batch Pl...

Create or Update Batch PlanBenefitRate

Request

Create or Update multiple PlanBenefitRate at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.

Security
apiKeyAuth and bearerAuth
Path
planIDstringrequired

Plan ID

benefitCodestringrequired

Benefit Code

Headers
vbasoftware-databasestringrequired

Target database

Bodyapplication/jsonrequired
Array [
planBenefitRate_Keyinteger, (int32)required

Unique idenfiter assigned to the Plan Benefit Rate. Note: The database will apply a default value of 0 for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of 0 to meet the API requirements and ensure that the functionality occurs as expected.

benefit_Codestring, [ 1 .. 10 ] charactersrequired

References the PlanBenefits.Benefit_Code value in parent table.

effective_Datestring, (date-time)required

Date when the Rate becomes effective.

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.

ex_Codestring or null, <= 6 characters

This code is applied to any claim that utilizes the benefit rate.

network_IDstring or null, <= 10 characters

Network ID associated with the Plan Benefit Rate

plan_IDstring, [ 1 .. 20 ] charactersrequired

References the PlanBenefits.Plan_ID value in parent table.

ratenumber, (double)required

This area will allow for a limit (dollar or percentage) of how much of the allowed amount can be paid out, per claim detail line, by the specific plan benefit. Note: The database will apply a default value of 0 for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of 0 to meet the API requirements and ensure that the functionality occurs as expected.

rate_Maxnumber or null, (double)

Max rate that can be paid out.

rate_Max_Typestring or null, <= 6 characters

Type of Benefit Level Maximum: Per Calendar Year - January 1st through December 31st. Per Plan Year - per plan year as defined by the Group.

rate_Pctbooleanrequired

Indicates whether the Rate will be a percentage or fixed amount. Note: The database will apply a default value of False for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of False to meet the API requirements and ensure that the functionality occurs as expected.

rate_Typestring, [ 1 .. 6 ] charactersrequired

Type of Benefit Rate: Per Service Line - rate is applied to each service line. Per Day - rate is applied per service date. Per Visit - rate is applied per service date per Provider. Per Unit - rate is multiplied by the number of units on the matching service line.

term_Datestring or null, (date-time)

Date when the Rate expires.

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 PUT \
  'https://vbapi.vbasoftware.com/vbasoftware/plans/{planID}/benefits/{benefitCode}/rates-batch' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'vbasoftware-database: string' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '[
    {
      "planBenefitRate_Key": 0,
      "benefit_Code": "string",
      "effective_Date": "2019-08-24T14:15:22Z",
      "entry_Date": "2019-08-24T14:15:22Z",
      "entry_User": "string",
      "ex_Code": "string",
      "network_ID": "string",
      "plan_ID": "string",
      "rate": 0.1,
      "rate_Max": 0.1,
      "rate_Max_Type": "string",
      "rate_Pct": true,
      "rate_Type": "string",
      "term_Date": "2019-08-24T14:15:22Z",
      "update_Date": "2019-08-24T14:15:22Z",
      "update_User": "string"
    }
  ]'

Responses

Success

Bodyapplication/json
dataArray of objects or null
errorobject
debugobject
Response
{
  "data": [ … ],
  "error": { … },
  "debug": { … }
}