Premium Rate Payees

Create PremRatePayee

Creates a new PremRatePayee

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
premRateKey
required
integer <int32>

PremRate Key

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
premRate_Key
required
integer <int32>
payee_ID
required
string [ 1 .. 20 ] characters
account_Key
integer or null <int32>
amount
number or null <double>
amount_Max
number or null <double>
amount_Pct
required
boolean
dist_Type
string or null <= 8 characters
entry_Date
string <date-time>
entry_User
string or null <= 20 characters
payor_ID
string or null <= 20 characters
policy_Number
string or null <= 25 characters
premRate_Category
string or null <= 32 characters
priority
integer or null <int32>
rate
number or null <double>
rate_Max
number or null <double>
rate_Min
number or null <double>
rate_Round_Precision
integer or null <int32>
rate_Round_Type
string or null <= 16 characters
rate_Var1
number or null <double>
rate_Var2
number or null <double>
rate_Var3
number or null <double>
update_Date
string <date-time>
update_User
string or null <= 20 characters
Responses
200

Success

401

Unauthorized

post/premium-rates/{premRateKey}/payees
Request samples
{
  • "premRate_Key": 0,
  • "payee_ID": "string",
  • "account_Key": 0,
  • "amount": 0.1,
  • "amount_Max": 0.1,
  • "amount_Pct": true,
  • "dist_Type": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "payor_ID": "string",
  • "policy_Number": "string",
  • "premRate_Category": "string",
  • "priority": 0,
  • "rate": 0.1,
  • "rate_Max": 0.1,
  • "rate_Min": 0.1,
  • "rate_Round_Precision": 0,
  • "rate_Round_Type": "string",
  • "rate_Var1": 0.1,
  • "rate_Var2": 0.1,
  • "rate_Var3": 0.1,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List PremRatePayee

Lists all PremRatePayee for the given premRateKey

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
premRateKey
required
integer <int32>

PremRate Key

query Parameters
page
integer <int32>
Default: 1

Page

pageSize
integer <int32>
Default: 100

Page Size

sortBy
string

Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., 'Property1:desc,Property2:asc,Property3:asc' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/premium-rates/{premRateKey}/payees
Request samples 
Response samples 
No sample
Get PremRatePayee
Gets PremRatePayee


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
premRateKey
required
integer <int32> 
PremRate Key


 
payeeID
required
string
Payee ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/premium-rates/{premRateKey}/payees/{payeeID}
Request samples 
Response samples 
No sample
Update PremRatePayee
Updates a specific PremRatePayee.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
premRateKey
required
integer <int32> 
PremRate Key


 
payeeID
required
string
Payee ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
premRate_Key
required
integer <int32> 
 
payee_ID
required
string  [ 1 .. 20 ] characters 
 
account_Key
integer or null <int32> 
 
amount
number or null <double> 
 
amount_Max
number or null <double> 
 
amount_Pct
required
boolean
 
dist_Type
string or null  <= 8 characters 
 
entry_Date
string <date-time> 
 
entry_User
string or null  <= 20 characters 
 
payor_ID
string or null  <= 20 characters 
 
policy_Number
string or null  <= 25 characters 
 
premRate_Category
string or null  <= 32 characters 
 
priority
integer or null <int32> 
 
rate
number or null <double> 
 
rate_Max
number or null <double> 
 
rate_Min
number or null <double> 
 
rate_Round_Precision
integer or null <int32> 
 
rate_Round_Type
string or null  <= 16 characters 
 
rate_Var1
number or null <double> 
 
rate_Var2
number or null <double> 
 
rate_Var3
number or null <double> 
 
update_Date
string <date-time> 
 
update_User
string or null  <= 20 characters 
 
Responses 
200
Success


401
Unauthorized


put/premium-rates/{premRateKey}/payees/{payeeID}
Request samples 
{
  • "premRate_Key": 0,
  • "payee_ID": "string",
  • "account_Key": 0,
  • "amount": 0.1,
  • "amount_Max": 0.1,
  • "amount_Pct": true,
  • "dist_Type": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "payor_ID": "string",
  • "policy_Number": "string",
  • "premRate_Category": "string",
  • "priority": 0,
  • "rate": 0.1,
  • "rate_Max": 0.1,
  • "rate_Min": 0.1,
  • "rate_Round_Precision": 0,
  • "rate_Round_Type": "string",
  • "rate_Var1": 0.1,
  • "rate_Var2": 0.1,
  • "rate_Var3": 0.1,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete PremRatePayee
Deletes an PremRatePayee


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
premRateKey
required
integer <int32> 
PremRate Key


 
payeeID
required
string
Payee ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/premium-rates/{premRateKey}/payees/{payeeID}
Request samples 
Create or Update Batch PremRatePayee
Create or Update multiple PremRatePayee 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
premRateKey
required
integer <int32> 
PremRate Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
premRate_Key
required
integer <int32> 
 
payee_ID
required
string  [ 1 .. 20 ] characters 
 
account_Key
integer or null <int32> 
 
amount
number or null <double> 
 
amount_Max
number or null <double> 
 
amount_Pct
required
boolean
 
dist_Type
string or null  <= 8 characters 
 
entry_Date
string <date-time> 
 
entry_User
string or null  <= 20 characters 
 
payor_ID
string or null  <= 20 characters 
 
policy_Number
string or null  <= 25 characters 
 
premRate_Category
string or null  <= 32 characters 
 
priority
integer or null <int32> 
 
rate
number or null <double> 
 
rate_Max
number or null <double> 
 
rate_Min
number or null <double> 
 
rate_Round_Precision
integer or null <int32> 
 
rate_Round_Type
string or null  <= 16 characters 
 
rate_Var1
number or null <double> 
 
rate_Var2
number or null <double> 
 
rate_Var3
number or null <double> 
 
update_Date
string <date-time> 
 
update_User
string or null  <= 20 characters 
 
Responses 
207
Success


401
Unauthorized


put/premium-rates/{premRateKey}/payees-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}