Commission Rates

Create CommissionRate

Creates a new CommissionRate

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
commissionRate_Key
required
integer <int32>

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

account_Key
integer or null <int32>

Account of the Commission Rate

commissionRate_Category
string or null <= 32 characters

Category of the Commission Rate

commissionRate_ID
string or null <= 32 characters

User defind identifier for the Commission Rate

commissionRate_Type
string or null <= 16 characters

Type of the Commission Rate

commission_Basis
string or null <= 8 characters

Commission Basis used for the rate

commission_Cycle
string or null <= 8 characters

Commission Cycle used for the rate

description
string or null <= 128 characters

Description of the Commission Rate

division_ID
string or null <= 20 characters

Division of the Commission Rate

effective_Date
string or null <date-time>

Effective Date of the Commission Rate

end_Date
string or null <date-time>

End Date of the Commission Rate

entry_Date
string <date-time>

Date record was first added to the system

entry_User
string or null <= 20 characters

User that first added the record to the system

group_ID
string or null <= 20 characters

Group of the Commission Rate

issue_Age_From
integer or null <int32>

Holds the lower bound of the applicable age range for the commission rate record.

issue_Age_Thru
integer or null <int32>

Holds the upper bound of the applicable age range for the commission rate record.

issue_State
string or null <= 2 characters

Holds the abbreviated state name for the commission rate record.

member_Seq
string or null <= 2 characters

Member Sequnce of the Commission Rate

parent_CommissionRate_Key
integer or null <int32>

Commission Rate that this record is a child of

parent_Rate_Cluster
string or null <= 32 characters

Defines which CommissionRateCluster.Rate_Cluster is a parent to this commission rate record.

payor_ID
string or null <= 20 characters

Payor of the Commission Rate

plan_ID
string or null <= 20 characters

Plan of the Commission Rate

plan_Type
string or null <= 6 characters

Holds the plan_type for which this commission rate record applies.

pre_Payment_Adjustment_Reason
string or null <= 8 characters

TBD

pre_Payment_Rate
required
boolean

TBD Note: This field is marked as NOT NULL in the database and therefore required by the API.

pre_Payment_Type
string or null <= 32 characters

TBD

premRate_Key
integer or null <int32>

Not used

rate
number or null <double>

Decimal value that defines the base rate

rate_Max
number or null <double>

Maximum the rate will be regardless of the calculation

rate_Min
number or null <double>

Minimum the rate will be regardless of the calculation

rate_Round_Precision
integer or null <int32>

Precision that the rate is rounded to

rate_Round_Type
string or null <= 16 characters

Type that determine how the rate is rounded

rate_Variable1
number or null <double>

First variable used in calculating the rate based on the type

rate_Variable2
number or null <double>

Second variable used in calculating the rate based on the type

rate_Variable3
number or null <double>

Third variable used in calculating the rate based on the type

scale_Exclude_Header_Adjustments
required
boolean

Determines if Header Adjustments are included in the scaling Note: This field is marked as NOT NULL in the database and therefore required by the API.

scale_From
number or null <double>

Beginning range of the amount used for scaling

scale_Thru
number or null <double>

Ending range of the amount used for scaling

scale_Timeframe
string or null <= 16 characters

Used to detemine what date to begin the range for scaling

scale_Type
string or null <= 16 characters

Determines what amount the scale is based off of

subscriber_ID
string or null <= 9 characters

Subscriber of the Commission Rate

term_Range_Date_Type
string or null <= 16 characters

Used to detemine what date to begin the range for scaling

term_Range_From
integer or null <int32>

Beginning range of a number of Days, Months, or Years

term_Range_Thru
integer or null <int32>

Ending range of a number of Days, Months, or Years

term_Range_Type
string or null <= 1 characters

Determines if Term Range is Days, Months, or Years

update_Date
string <date-time>

Date the record was last updated in the system

update_User
string or null <= 20 characters

User that last updated the record in the system

use_Initial_Premium
required
boolean

Flag to calculate commission based on the first calculated premium for this rate and then agent. Note: This field is marked as NOT NULL in the database and therefore required by the API.

Responses
200

Success

401

Unauthorized

post/commission-rates
Request samples
{
  • "commissionRate_Key": 0,
  • "account_Key": 0,
  • "commissionRate_Category": "string",
  • "commissionRate_ID": "string",
  • "commissionRate_Type": "string",
  • "commission_Basis": "string",
  • "commission_Cycle": "string",
  • "description": "string",
  • "division_ID": "string",
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "end_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "group_ID": "string",
  • "issue_Age_From": 0,
  • "issue_Age_Thru": 0,
  • "issue_State": "st",
  • "member_Seq": "st",
  • "parent_CommissionRate_Key": 0,
  • "parent_Rate_Cluster": "string",
  • "payor_ID": "string",
  • "plan_ID": "string",
  • "plan_Type": "string",
  • "pre_Payment_Adjustment_Reason": "string",
  • "pre_Payment_Rate": true,
  • "pre_Payment_Type": "string",
  • "premRate_Key": 0,
  • "rate": 0.1,
  • "rate_Max": 0.1,
  • "rate_Min": 0.1,
  • "rate_Round_Precision": 0,
  • "rate_Round_Type": "string",
  • "rate_Variable1": 0.1,
  • "rate_Variable2": 0.1,
  • "rate_Variable3": 0.1,
  • "scale_Exclude_Header_Adjustments": true,
  • "scale_From": 0.1,
  • "scale_Thru": 0.1,
  • "scale_Timeframe": "string",
  • "scale_Type": "string",
  • "subscriber_ID": "string",
  • "term_Range_Date_Type": "string",
  • "term_Range_From": 0,
  • "term_Range_Thru": 0,
  • "term_Range_Type": "s",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "use_Initial_Premium": true
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List CommissionRate

Lists all CommissionRate

SecurityapiKeyAuth and bearerAuth
Request
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/commission-rates
Request samples 
Response samples 
No sample
Create CommissionRate from Template
Creates a new CommissionRate from a template CommissionRate.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
commRateKey
required
integer <int32> 
CommissionRate Key


 
groupId
required
string
Group ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


post/commission-rates/{commRateKey}/commission-rates-group/{groupId}
Request samples 
Response samples 
No sample
Copies CommissionRate from Rate
Creates a new CommissionRate from a given CommissionRate.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
commRateKey
required
integer <int32> 
CommissionRate Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


post/commission-rate-copy/{commRateKey}
Request samples 
Response samples 
No sample
Create CommissionRate from Rate Cluster
Creates a new CommissionRate records from a cluster of templated rates.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
commRateCluster
required
string
Rate Cluster


 
groupId
required
string
Group ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


post/commission-rates-cluster/{commRateCluster}/commission-rates-group/{groupId}
Request samples 
Response samples 
No sample
List Commission Rates nested by Division/Plan
Lists all Commission Rates for the given groupID and have it nested by Division, then by Plan.


SecurityapiKeyAuth and bearerAuth 
Request 
query Parameters
groupID
string
Group ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/commission-rates-nested
Request samples 
Response samples 
No sample
Get CommissionRate
Gets CommissionRate


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
commRateKey
required
integer <int32> 
CommissionRate Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/commission-rates/{commRateKey}
Request samples 
Response samples 
No sample
Update CommissionRate
Updates a specific CommissionRate.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
commRateKey
required
integer <int32> 
CommissionRate Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
commissionRate_Key
required
integer <int32> 
Unique identifier for the Commission Rate Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
account_Key
integer or null <int32> 
Account of the Commission Rate


 
commissionRate_Category
string or null  <= 32 characters 
Category of the Commission Rate


 
commissionRate_ID
string or null  <= 32 characters 
User defind identifier for the Commission Rate


 
commissionRate_Type
string or null  <= 16 characters 
Type of the Commission Rate


 
commission_Basis
string or null  <= 8 characters 
Commission Basis used for the rate


 
commission_Cycle
string or null  <= 8 characters 
Commission Cycle used for the rate


 
description
string or null  <= 128 characters 
Description of the Commission Rate


 
division_ID
string or null  <= 20 characters 
Division of the Commission Rate


 
effective_Date
string or null <date-time> 
Effective Date of the Commission Rate


 
end_Date
string or null <date-time> 
End Date of the Commission Rate


 
entry_Date
string <date-time> 
Date record was first added to the system


 
entry_User
string or null  <= 20 characters 
User that first added the record to the system


 
group_ID
string or null  <= 20 characters 
Group of the Commission Rate


 
issue_Age_From
integer or null <int32> 
Holds the lower bound of the applicable age range for the commission rate record.


 
issue_Age_Thru
integer or null <int32> 
Holds the upper bound of the applicable age range for the commission rate record.


 
issue_State
string or null  <= 2 characters 
Holds the abbreviated state name for the commission rate record.


 
member_Seq
string or null  <= 2 characters 
Member Sequnce of the Commission Rate


 
parent_CommissionRate_Key
integer or null <int32> 
Commission Rate that this record is a child of


 
parent_Rate_Cluster
string or null  <= 32 characters 
Defines which CommissionRateCluster.Rate_Cluster is a parent to this commission rate record.


 
payor_ID
string or null  <= 20 characters 
Payor of the Commission Rate


 
plan_ID
string or null  <= 20 characters 
Plan of the Commission Rate


 
plan_Type
string or null  <= 6 characters 
Holds the plan_type for which this commission rate record applies.


 
pre_Payment_Adjustment_Reason
string or null  <= 8 characters 
TBD


 
pre_Payment_Rate
required
boolean
TBD Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
pre_Payment_Type
string or null  <= 32 characters 
TBD


 
premRate_Key
integer or null <int32> 
Not used


 
rate
number or null <double> 
Decimal value that defines the base rate


 
rate_Max
number or null <double> 
Maximum the rate will be regardless of the calculation


 
rate_Min
number or null <double> 
Minimum the rate will be regardless of the calculation


 
rate_Round_Precision
integer or null <int32> 
Precision that the rate is rounded to


 
rate_Round_Type
string or null  <= 16 characters 
Type that determine how the rate is rounded


 
rate_Variable1
number or null <double> 
First variable used in calculating the rate based on the type


 
rate_Variable2
number or null <double> 
Second variable used in calculating the rate based on the type


 
rate_Variable3
number or null <double> 
Third variable used in calculating the rate based on the type


 
scale_Exclude_Header_Adjustments
required
boolean
Determines if Header Adjustments are included in the scaling Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
scale_From
number or null <double> 
Beginning range of the amount used for scaling


 
scale_Thru
number or null <double> 
Ending range of the amount used for scaling


 
scale_Timeframe
string or null  <= 16 characters 
Used to detemine what date to begin the range for scaling


 
scale_Type
string or null  <= 16 characters 
Determines what amount the scale is based off of


 
subscriber_ID
string or null  <= 9 characters 
Subscriber of the Commission Rate


 
term_Range_Date_Type
string or null  <= 16 characters 
Used to detemine what date to begin the range for scaling


 
term_Range_From
integer or null <int32> 
Beginning range of a number of Days, Months, or Years


 
term_Range_Thru
integer or null <int32> 
Ending range of a number of Days, Months, or Years


 
term_Range_Type
string or null  <= 1 characters 
Determines if Term Range is Days, Months, or Years


 
update_Date
string <date-time> 
Date the record was last updated in the system


 
update_User
string or null  <= 20 characters 
User that last updated the record in the system


 
use_Initial_Premium
required
boolean
Flag to calculate commission based on the first calculated premium for this rate and then agent. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
Responses 
200
Success


401
Unauthorized


put/commission-rates/{commRateKey}
Request samples 
{
  • "commissionRate_Key": 0,
  • "account_Key": 0,
  • "commissionRate_Category": "string",
  • "commissionRate_ID": "string",
  • "commissionRate_Type": "string",
  • "commission_Basis": "string",
  • "commission_Cycle": "string",
  • "description": "string",
  • "division_ID": "string",
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "end_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "group_ID": "string",
  • "issue_Age_From": 0,
  • "issue_Age_Thru": 0,
  • "issue_State": "st",
  • "member_Seq": "st",
  • "parent_CommissionRate_Key": 0,
  • "parent_Rate_Cluster": "string",
  • "payor_ID": "string",
  • "plan_ID": "string",
  • "plan_Type": "string",
  • "pre_Payment_Adjustment_Reason": "string",
  • "pre_Payment_Rate": true,
  • "pre_Payment_Type": "string",
  • "premRate_Key": 0,
  • "rate": 0.1,
  • "rate_Max": 0.1,
  • "rate_Min": 0.1,
  • "rate_Round_Precision": 0,
  • "rate_Round_Type": "string",
  • "rate_Variable1": 0.1,
  • "rate_Variable2": 0.1,
  • "rate_Variable3": 0.1,
  • "scale_Exclude_Header_Adjustments": true,
  • "scale_From": 0.1,
  • "scale_Thru": 0.1,
  • "scale_Timeframe": "string",
  • "scale_Type": "string",
  • "subscriber_ID": "string",
  • "term_Range_Date_Type": "string",
  • "term_Range_From": 0,
  • "term_Range_Thru": 0,
  • "term_Range_Type": "s",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "use_Initial_Premium": true
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete CommissionRate
Deletes an CommissionRate


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
commRateKey
required
integer <int32> 
CommissionRate Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/commission-rates/{commRateKey}
Request samples 
Create or Update Batch CommissionRate
Create or Update multiple CommissionRate at once.  If the entity exists, it will be updated.  If the entity does not exist, it will be created.


SecurityapiKeyAuth and bearerAuth 
Request 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
commissionRate_Key
required
integer <int32> 
Unique identifier for the Commission Rate Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
account_Key
integer or null <int32> 
Account of the Commission Rate


 
commissionRate_Category
string or null  <= 32 characters 
Category of the Commission Rate


 
commissionRate_ID
string or null  <= 32 characters 
User defind identifier for the Commission Rate


 
commissionRate_Type
string or null  <= 16 characters 
Type of the Commission Rate


 
commission_Basis
string or null  <= 8 characters 
Commission Basis used for the rate


 
commission_Cycle
string or null  <= 8 characters 
Commission Cycle used for the rate


 
description
string or null  <= 128 characters 
Description of the Commission Rate


 
division_ID
string or null  <= 20 characters 
Division of the Commission Rate


 
effective_Date
string or null <date-time> 
Effective Date of the Commission Rate


 
end_Date
string or null <date-time> 
End Date of the Commission Rate


 
entry_Date
string <date-time> 
Date record was first added to the system


 
entry_User
string or null  <= 20 characters 
User that first added the record to the system


 
group_ID
string or null  <= 20 characters 
Group of the Commission Rate


 
issue_Age_From
integer or null <int32> 
Holds the lower bound of the applicable age range for the commission rate record.


 
issue_Age_Thru
integer or null <int32> 
Holds the upper bound of the applicable age range for the commission rate record.


 
issue_State
string or null  <= 2 characters 
Holds the abbreviated state name for the commission rate record.


 
member_Seq
string or null  <= 2 characters 
Member Sequnce of the Commission Rate


 
parent_CommissionRate_Key
integer or null <int32> 
Commission Rate that this record is a child of


 
parent_Rate_Cluster
string or null  <= 32 characters 
Defines which CommissionRateCluster.Rate_Cluster is a parent to this commission rate record.


 
payor_ID
string or null  <= 20 characters 
Payor of the Commission Rate


 
plan_ID
string or null  <= 20 characters 
Plan of the Commission Rate


 
plan_Type
string or null  <= 6 characters 
Holds the plan_type for which this commission rate record applies.


 
pre_Payment_Adjustment_Reason
string or null  <= 8 characters 
TBD


 
pre_Payment_Rate
required
boolean
TBD Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
pre_Payment_Type
string or null  <= 32 characters 
TBD


 
premRate_Key
integer or null <int32> 
Not used


 
rate
number or null <double> 
Decimal value that defines the base rate


 
rate_Max
number or null <double> 
Maximum the rate will be regardless of the calculation


 
rate_Min
number or null <double> 
Minimum the rate will be regardless of the calculation


 
rate_Round_Precision
integer or null <int32> 
Precision that the rate is rounded to


 
rate_Round_Type
string or null  <= 16 characters 
Type that determine how the rate is rounded


 
rate_Variable1
number or null <double> 
First variable used in calculating the rate based on the type


 
rate_Variable2
number or null <double> 
Second variable used in calculating the rate based on the type


 
rate_Variable3
number or null <double> 
Third variable used in calculating the rate based on the type


 
scale_Exclude_Header_Adjustments
required
boolean
Determines if Header Adjustments are included in the scaling Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
scale_From
number or null <double> 
Beginning range of the amount used for scaling


 
scale_Thru
number or null <double> 
Ending range of the amount used for scaling


 
scale_Timeframe
string or null  <= 16 characters 
Used to detemine what date to begin the range for scaling


 
scale_Type
string or null  <= 16 characters 
Determines what amount the scale is based off of


 
subscriber_ID
string or null  <= 9 characters 
Subscriber of the Commission Rate


 
term_Range_Date_Type
string or null  <= 16 characters 
Used to detemine what date to begin the range for scaling


 
term_Range_From
integer or null <int32> 
Beginning range of a number of Days, Months, or Years


 
term_Range_Thru
integer or null <int32> 
Ending range of a number of Days, Months, or Years


 
term_Range_Type
string or null  <= 1 characters 
Determines if Term Range is Days, Months, or Years


 
update_Date
string <date-time> 
Date the record was last updated in the system


 
update_User
string or null  <= 20 characters 
User that last updated the record in the system


 
use_Initial_Premium
required
boolean
Flag to calculate commission based on the first calculated premium for this rate and then agent. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
Responses 
207
Success


401
Unauthorized


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