APIs for VBASoftware
VBASoftware (v1)
- application/json
- text/json
- application/*+json
Unique identifier for the Commission Rate Note: This field is marked as NOT NULL in the database and therefore required by the API.
Holds the lower bound of the applicable age range for the commission rate record.
Holds the upper bound of the applicable age range for the commission rate record.
Holds the abbreviated state name for the commission rate record.
Defines which CommissionRateCluster.Rate_Cluster is a parent to this commission rate record.
Holds the plan_type for which this commission rate record applies.
TBD Note: This field is marked as NOT NULL in the database and therefore required by the API.
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.
Used to detemine what date to begin the range for scaling
Used to detemine what date to begin the range for scaling
- VBAPI VBASoftwarehttps://vbapi.vbasoftware.com/vbasoftware/commission-rates/{commRateKey}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
- application/json
- text/json
- application/*+json
curl -i -X PUT \
'https://vbapi.vbasoftware.com/vbasoftware/commission-rates/{commRateKey}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-H 'vbasoftware-database: string' \
-H 'x-api-key: YOUR_API_KEY_HERE' \
-d '{
"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
}'- text/plain
- application/json
- text/json
No response example- VBAPI VBASoftwarehttps://vbapi.vbasoftware.com/vbasoftware/commission-rates/{commRateKey}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X DELETE \
'https://vbapi.vbasoftware.com/vbasoftware/commission-rates/{commRateKey}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'vbasoftware-database: string' \
-H 'x-api-key: YOUR_API_KEY_HERE'Request
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.
- application/json
- text/json
- application/*+json
Unique identifier for the Commission Rate Note: This field is marked as NOT NULL in the database and therefore required by the API.
Holds the lower bound of the applicable age range for the commission rate record.
Holds the upper bound of the applicable age range for the commission rate record.
Holds the abbreviated state name for the commission rate record.
Defines which CommissionRateCluster.Rate_Cluster is a parent to this commission rate record.
Holds the plan_type for which this commission rate record applies.
TBD Note: This field is marked as NOT NULL in the database and therefore required by the API.
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.
Used to detemine what date to begin the range for scaling
Used to detemine what date to begin the range for scaling
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.
- VBAPI VBASoftwarehttps://vbapi.vbasoftware.com/vbasoftware/commission-rates-batch
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
- application/json
- text/json
- application/*+json
curl -i -X PUT \
https://vbapi.vbasoftware.com/vbasoftware/commission-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 '[
{
"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
}
]'- text/plain
- application/json
- text/json
No response example