Skip to content

Create PremRateAddOn

Request

Creates a new PremRateAddOn

Security
apiKeyAuth and bearerAuth
Path
PremRate_Keyinteger, (int32)required

PremRate Key

Headers
vbasoftware-databasestringrequired

Target database

Bodyapplication/jsonrequired
premRateAddOn_Keyinteger, (int32)required

Unique ID of the Add On Rate associated with a given Premium Rate Note: This field is marked as NOT NULL in the database and therefore required by the API.

addOn_PremRate_Keyinteger, (int32)required

Unique ID of the Add On Rate Note: This field is marked as NOT NULL in the database and therefore required by the API.

add_On_Grouping_IDstring or null, <= 32 characters

Used to identify Add On rates by Group

entry_Datestring, (date-time)

Date when the record was first added to the system.

entry_Userstring or null, <= 20 characters

User that first added the record to the system.

premRate_Keyinteger, (int32)required

Unique ID for the Premium Rate Note: This field is marked as NOT NULL in the database and therefore required by the API.

sequenceinteger or null, (int32)

The suquence of this Category on the "INV" report.

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/premium-rates/{PremRate_Key}/add-ons' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'vbasoftware-database: string' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "premRateAddOn_Key": 0,
    "addOn_PremRate_Key": 0,
    "add_On_Grouping_ID": "string",
    "entry_Date": "2019-08-24T14:15:22Z",
    "entry_User": "string",
    "premRate_Key": 0,
    "sequence": 0,
    "update_Date": "2019-08-24T14:15:22Z",
    "update_User": "string"
  }'

Responses

Success

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