APIs for VBASoftware
VBASoftware (v1)
- application/json
- text/json
- application/*+json
Unique identifier for the Commission table Note: This field is marked as NOT NULL in the database and therefore required by the API.
Premium Amount Received after previous amounts
First variable used in calculating the rate based on the type
Second variable used in calculating the rate based on the type
Third variable used in calculating the rate based on the type
Used to detemine what date to begin the range for scaling
Unique identifier for the CommissionAgencyRepRate table
Unique identifier for the CommissionTransaction table
Full Commission Amount without adjusting for previous amounts
Full Premium Amount Received without adjusting for previous amounts
- VBAPI VBASoftwarehttps://vbapi.vbasoftware.com/vbasoftware/commission-transactions/{commTransKey}/commissions/{commKey}
- 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-transactions/{commTransKey}/commissions/{commKey}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-H 'vbasoftware-database: string' \
-H 'x-api-key: YOUR_API_KEY_HERE' \
-d '{
"commission_Key": 0,
"account_Key": 0,
"adjustment_Amount": 0.1,
"adjustment_Amount_Received": 0.1,
"calculated_Commission_Amount": 0.1,
"calculated_Premium_Amount": 0.1,
"calculated_Premium_Amount_Received": 0.1,
"check_Batch": 0,
"check_ID": 0,
"comm_Rate": 0.1,
"comm_Rate_Max": 0.1,
"comm_Rate_Min": 0.1,
"comm_Rate_Variable1": 0.1,
"comm_Rate_Variable2": 0.1,
"comm_Rate_Variable3": 0.1,
"comm_Scale_From": 0.1,
"comm_Scale_Thru": 0.1,
"comm_Scale_Timeframe": "string",
"comm_Scale_Type": "string",
"comm_Term_Range_From": 0,
"comm_Term_Range_Thru": 0,
"comm_Term_Range_Type": "s",
"commissionAgencyRepRate_Key": 0,
"commissionAgencyRep_Key": 0,
"commissionRate_Key": 0,
"commissionTransaction_Key": 0,
"commission_Amount": 0.1,
"commission_Basis": "string",
"commission_Cycle": "string",
"commission_Date": "2019-08-24T14:15:22Z",
"dependent_Count": 0,
"division_ID": "string",
"entry_Date": "2019-08-24T14:15:22Z",
"entry_User": "string",
"group_ID": "string",
"invoiceAdjustment_Key": 0,
"invoice_Key": 0,
"license_Number": "string",
"license_State": "st",
"license_Type": "string",
"member_Count": 0,
"new_CommissionAgencyRep_Key": 0,
"original_CommissionAgencyRep_Key": 0,
"payor_ID": "string",
"plan_ID": "string",
"premRate_Key": 0,
"premium_Amount": 0.1,
"premium_Amount_Received": 0.1,
"rep_Split": 0.1,
"rep_Split_Max": 0.1,
"rep_Split_Min": 0.1,
"rep_Split_Priority": 0,
"rep_Split_Type": "string",
"subscriber_Count": 0,
"subscriber_ID": "string",
"update_Date": "2019-08-24T14:15:22Z",
"update_User": "string"
}'- text/plain
- application/json
- text/json
No response example- VBAPI VBASoftwarehttps://vbapi.vbasoftware.com/vbasoftware/commission-transactions/{commTransKey}/commissions/{commKey}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X DELETE \
'https://vbapi.vbasoftware.com/vbasoftware/commission-transactions/{commTransKey}/commissions/{commKey}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'vbasoftware-database: string' \
-H 'x-api-key: YOUR_API_KEY_HERE'Request
Create or Update multiple Commission 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 table Note: This field is marked as NOT NULL in the database and therefore required by the API.
Premium Amount Received after previous amounts
First variable used in calculating the rate based on the type
Second variable used in calculating the rate based on the type
Third variable used in calculating the rate based on the type
Used to detemine what date to begin the range for scaling
Unique identifier for the CommissionAgencyRepRate table
Unique identifier for the CommissionTransaction table
Full Commission Amount without adjusting for previous amounts
Full Premium Amount Received without adjusting for previous amounts
- VBAPI VBASoftwarehttps://vbapi.vbasoftware.com/vbasoftware/commission-transactions/{commTransKey}/commissions-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-transactions/{commTransKey}/commissions-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 '[
{
"commission_Key": 0,
"account_Key": 0,
"adjustment_Amount": 0.1,
"adjustment_Amount_Received": 0.1,
"calculated_Commission_Amount": 0.1,
"calculated_Premium_Amount": 0.1,
"calculated_Premium_Amount_Received": 0.1,
"check_Batch": 0,
"check_ID": 0,
"comm_Rate": 0.1,
"comm_Rate_Max": 0.1,
"comm_Rate_Min": 0.1,
"comm_Rate_Variable1": 0.1,
"comm_Rate_Variable2": 0.1,
"comm_Rate_Variable3": 0.1,
"comm_Scale_From": 0.1,
"comm_Scale_Thru": 0.1,
"comm_Scale_Timeframe": "string",
"comm_Scale_Type": "string",
"comm_Term_Range_From": 0,
"comm_Term_Range_Thru": 0,
"comm_Term_Range_Type": "s",
"commissionAgencyRepRate_Key": 0,
"commissionAgencyRep_Key": 0,
"commissionRate_Key": 0,
"commissionTransaction_Key": 0,
"commission_Amount": 0.1,
"commission_Basis": "string",
"commission_Cycle": "string",
"commission_Date": "2019-08-24T14:15:22Z",
"dependent_Count": 0,
"division_ID": "string",
"entry_Date": "2019-08-24T14:15:22Z",
"entry_User": "string",
"group_ID": "string",
"invoiceAdjustment_Key": 0,
"invoice_Key": 0,
"license_Number": "string",
"license_State": "st",
"license_Type": "string",
"member_Count": 0,
"new_CommissionAgencyRep_Key": 0,
"original_CommissionAgencyRep_Key": 0,
"payor_ID": "string",
"plan_ID": "string",
"premRate_Key": 0,
"premium_Amount": 0.1,
"premium_Amount_Received": 0.1,
"rep_Split": 0.1,
"rep_Split_Max": 0.1,
"rep_Split_Min": 0.1,
"rep_Split_Priority": 0,
"rep_Split_Type": "string",
"subscriber_Count": 0,
"subscriber_ID": "string",
"update_Date": "2019-08-24T14:15:22Z",
"update_User": "string"
}
]'- text/plain
- application/json
- text/json
No response example