Commissions

Create Commission

Creates a new Commission

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

CommissionTransaction Key

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
commission_Key
required
integer <int32>

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

account_Key
integer or null <int32>

Unique identifier for the Account

adjustment_Amount
number or null <double>

Adjustment Amounts to this Commission

adjustment_Amount_Received
number or null <double>

Adjustment Amounts Received to this Commission

calculated_Commission_Amount
number or null <double>

Commission Amount after previous amounts

calculated_Premium_Amount
number or null <double>

Premium Amount after previous amounts

calculated_Premium_Amount_Received
number or null <double>

Premium Amount Received after previous amounts

check_Batch
integer or null <int32>

Check Batch for this Commission

check_ID
integer or null <int32>

Check for this Commission

comm_Rate
number or null <double>

Decimal value that defines the base rate

comm_Rate_Max
number or null <double>

Maximum the rate will be regardless of the calculation

comm_Rate_Min
number or null <double>

Minimum the rate will be regardless of the calculation

comm_Rate_Variable1
number or null <double>

First variable used in calculating the rate based on the type

comm_Rate_Variable2
number or null <double>

Second variable used in calculating the rate based on the type

comm_Rate_Variable3
number or null <double>

Third variable used in calculating the rate based on the type

comm_Scale_From
number or null <double>

Beginning range of the amount used for scaling

comm_Scale_Thru
number or null <double>

Ending range of the amount used for scaling

comm_Scale_Timeframe
string or null <= 16 characters

Used to detemine what date to begin the range for scaling

comm_Scale_Type
string or null <= 16 characters

Determines what amount the scale is based off of

comm_Term_Range_From
integer or null <int32>

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

comm_Term_Range_Thru
integer or null <int32>

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

comm_Term_Range_Type
string or null <= 1 characters

Determines if Term Range is Days, Months, or Years

commissionAgencyRepRate_Key
integer or null <int32>

Unique identifier for the CommissionAgencyRepRate table

commissionAgencyRep_Key
integer or null <int32>
commissionRate_Key
integer or null <int32>
commissionTransaction_Key
integer or null <int32>

Unique identifier for the CommissionTransaction table

commission_Amount
number or null <double>

Full Commission Amount without adjusting for previous amounts

commission_Basis
string or null <= 8 characters

Basis of the Commission

commission_Cycle
string or null <= 8 characters

Cycle of the Commission

commission_Date
string or null <date-time>

Date the Commission was calculated for

dependent_Count
integer or null <int32>

Number of Dependents used for this Commission

division_ID
string or null <= 20 characters

Division for this Commission

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 for this Commission

invoiceAdjustment_Key
integer or null <int32>

Unique identifier for the InvoiceAdjustment table

invoice_Key
integer or null <int32>

Unique identifier for the PremInvoice table

license_Number
string or null <= 128 characters

Not used

license_State
string or null <= 2 characters

Not used

license_Type
string or null <= 32 characters

Not used

member_Count
integer or null <int32>

Number of Members used for this Commission

new_CommissionAgencyRep_Key
integer or null <int32>

Not used

original_CommissionAgencyRep_Key
integer or null <int32>

Not used

payor_ID
string or null <= 20 characters

Unique identifier for the Payor

plan_ID
string or null <= 20 characters

Plan for this Commission

premRate_Key
integer or null <int32>

PremRate for this Commission

premium_Amount
number or null <double>

Full Premium Amount without adjusting for previous amounts

premium_Amount_Received
number or null <double>

Full Premium Amount Received without adjusting for previous amounts

rep_Split
number or null <double>

The amount or percentage of the split

rep_Split_Max
number or null <double>

Maximum amount of the split

rep_Split_Min
number or null <double>

Minimum amount of the split

rep_Split_Priority
integer or null <int32>

Priority of the split

rep_Split_Type
string or null <= 16 characters

Determines if split is percent or flat amount

subscriber_Count
integer or null <int32>

Number of Subscribers used for this Commission

subscriber_ID
string or null <= 20 characters

Subscriber for this Commission

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

Responses
200

Success

401

Unauthorized

post/commission-transactions/{commTransKey}/commissions
Request samples
{
  • "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"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List Commission

Lists all Commission for the given commTransKey

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

CommissionTransaction 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/commission-transactions/{commTransKey}/commissions
Request samples 
Response samples 
No sample
Commission Generate Advanced API 
Generates Commission records and attaches those to a new Commission Transaction based on entered criteria.


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


 
Responses 
204
Success


401
Unauthorized


post/commission-generate
Request samples 
List Unassigned Commission
Lists all Commissions that are not assigned to a Commission Transaction.


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/unassigned-commissions
Request samples 
Response samples 
No sample
Get Commission
Gets Commission


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
commTransKey
required
integer <int32> 
CommissionTransaction Key


 
commKey
required
integer <int32> 
Commission Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/commission-transactions/{commTransKey}/commissions/{commKey}
Request samples 
Response samples 
No sample
Update Commission
Updates a specific Commission.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
commTransKey
required
integer <int32> 
CommissionTransaction Key


 
commKey
required
integer <int32> 
Commission Key


 
header Parameters
vbasoftware-database
required
string
Target database


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


 
account_Key
integer or null <int32> 
Unique identifier for the Account


 
adjustment_Amount
number or null <double> 
Adjustment Amounts to this Commission


 
adjustment_Amount_Received
number or null <double> 
Adjustment Amounts Received to this Commission


 
calculated_Commission_Amount
number or null <double> 
Commission Amount after previous amounts


 
calculated_Premium_Amount
number or null <double> 
Premium Amount after previous amounts


 
calculated_Premium_Amount_Received
number or null <double> 
Premium Amount Received after previous amounts


 
check_Batch
integer or null <int32> 
Check Batch for this Commission


 
check_ID
integer or null <int32> 
Check for this Commission


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


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


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


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


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


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


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


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


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


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


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


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


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


 
commissionAgencyRepRate_Key
integer or null <int32> 
Unique identifier for the CommissionAgencyRepRate table


 
commissionAgencyRep_Key
integer or null <int32> 
 
commissionRate_Key
integer or null <int32> 
 
commissionTransaction_Key
integer or null <int32> 
Unique identifier for the CommissionTransaction table


 
commission_Amount
number or null <double> 
Full Commission Amount without adjusting for previous amounts


 
commission_Basis
string or null  <= 8 characters 
Basis of the Commission


 
commission_Cycle
string or null  <= 8 characters 
Cycle of the Commission


 
commission_Date
string or null <date-time> 
Date the Commission was calculated for


 
dependent_Count
integer or null <int32> 
Number of Dependents used for this Commission


 
division_ID
string or null  <= 20 characters 
Division for this Commission


 
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 for this Commission


 
invoiceAdjustment_Key
integer or null <int32> 
Unique identifier for the InvoiceAdjustment table


 
invoice_Key
integer or null <int32> 
Unique identifier for the PremInvoice table


 
license_Number
string or null  <= 128 characters 
Not used


 
license_State
string or null  <= 2 characters 
Not used


 
license_Type
string or null  <= 32 characters 
Not used


 
member_Count
integer or null <int32> 
Number of Members used for this Commission


 
new_CommissionAgencyRep_Key
integer or null <int32> 
Not used


 
original_CommissionAgencyRep_Key
integer or null <int32> 
Not used


 
payor_ID
string or null  <= 20 characters 
Unique identifier for the Payor


 
plan_ID
string or null  <= 20 characters 
Plan for this Commission


 
premRate_Key
integer or null <int32> 
PremRate for this Commission


 
premium_Amount
number or null <double> 
Full Premium Amount without adjusting for previous amounts


 
premium_Amount_Received
number or null <double> 
Full Premium Amount Received without adjusting for previous amounts


 
rep_Split
number or null <double> 
The amount or percentage of the split


 
rep_Split_Max
number or null <double> 
Maximum amount of the split


 
rep_Split_Min
number or null <double> 
Minimum amount of the split


 
rep_Split_Priority
integer or null <int32> 
Priority of the split


 
rep_Split_Type
string or null  <= 16 characters 
Determines if split is percent or flat amount


 
subscriber_Count
integer or null <int32> 
Number of Subscribers used for this Commission


 
subscriber_ID
string or null  <= 20 characters 
Subscriber for this Commission


 
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


 
Responses 
200
Success


401
Unauthorized


put/commission-transactions/{commTransKey}/commissions/{commKey}
Request samples 
{
  • "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"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete Commission
Deletes an Commission


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
commTransKey
required
integer <int32> 
CommissionTransaction Key


 
commKey
required
integer <int32> 
Commission Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/commission-transactions/{commTransKey}/commissions/{commKey}
Request samples 
Create or Update Batch Commission
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.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
commTransKey
required
integer <int32> 
CommissionTransaction Key


 
header Parameters
vbasoftware-database
required
string
Target database


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


 
account_Key
integer or null <int32> 
Unique identifier for the Account


 
adjustment_Amount
number or null <double> 
Adjustment Amounts to this Commission


 
adjustment_Amount_Received
number or null <double> 
Adjustment Amounts Received to this Commission


 
calculated_Commission_Amount
number or null <double> 
Commission Amount after previous amounts


 
calculated_Premium_Amount
number or null <double> 
Premium Amount after previous amounts


 
calculated_Premium_Amount_Received
number or null <double> 
Premium Amount Received after previous amounts


 
check_Batch
integer or null <int32> 
Check Batch for this Commission


 
check_ID
integer or null <int32> 
Check for this Commission


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


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


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


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


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


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


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


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


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


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


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


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


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


 
commissionAgencyRepRate_Key
integer or null <int32> 
Unique identifier for the CommissionAgencyRepRate table


 
commissionAgencyRep_Key
integer or null <int32> 
 
commissionRate_Key
integer or null <int32> 
 
commissionTransaction_Key
integer or null <int32> 
Unique identifier for the CommissionTransaction table


 
commission_Amount
number or null <double> 
Full Commission Amount without adjusting for previous amounts


 
commission_Basis
string or null  <= 8 characters 
Basis of the Commission


 
commission_Cycle
string or null  <= 8 characters 
Cycle of the Commission


 
commission_Date
string or null <date-time> 
Date the Commission was calculated for


 
dependent_Count
integer or null <int32> 
Number of Dependents used for this Commission


 
division_ID
string or null  <= 20 characters 
Division for this Commission


 
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 for this Commission


 
invoiceAdjustment_Key
integer or null <int32> 
Unique identifier for the InvoiceAdjustment table


 
invoice_Key
integer or null <int32> 
Unique identifier for the PremInvoice table


 
license_Number
string or null  <= 128 characters 
Not used


 
license_State
string or null  <= 2 characters 
Not used


 
license_Type
string or null  <= 32 characters 
Not used


 
member_Count
integer or null <int32> 
Number of Members used for this Commission


 
new_CommissionAgencyRep_Key
integer or null <int32> 
Not used


 
original_CommissionAgencyRep_Key
integer or null <int32> 
Not used


 
payor_ID
string or null  <= 20 characters 
Unique identifier for the Payor


 
plan_ID
string or null  <= 20 characters 
Plan for this Commission


 
premRate_Key
integer or null <int32> 
PremRate for this Commission


 
premium_Amount
number or null <double> 
Full Premium Amount without adjusting for previous amounts


 
premium_Amount_Received
number or null <double> 
Full Premium Amount Received without adjusting for previous amounts


 
rep_Split
number or null <double> 
The amount or percentage of the split


 
rep_Split_Max
number or null <double> 
Maximum amount of the split


 
rep_Split_Min
number or null <double> 
Minimum amount of the split


 
rep_Split_Priority
integer or null <int32> 
Priority of the split


 
rep_Split_Type
string or null  <= 16 characters 
Determines if split is percent or flat amount


 
subscriber_Count
integer or null <int32> 
Number of Subscribers used for this Commission


 
subscriber_ID
string or null  <= 20 characters 
Subscriber for this Commission


 
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


 
Responses 
207
Success


401
Unauthorized


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