Adv. Commission

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 
Undo CommissionActivity Advanced API 
Undo Commissions by Commission Activity


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
commActivityKey
required
integer <int32> 
CommissionActivity Key


 
query Parameters
undoUser
string
Undo User


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


post/commission-activities-undo/{commActivityKey}
Request samples 
Response samples 
No sample
Undo CommissionActivity by Rep or Group Advanced API 
Undo Commissions by Commission Activity based on the passed in optional parameters of commAgencyRep or groupId.  Group undo takes priory if passed in with a Rep Key.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
commActivityKey
required
integer <int32> 
CommissionActivity Key


 
query Parameters
undoUser
string
Undo User


 
groupId
string
Group ID


 
commAgencyRepKey
integer <int32> 
Agency Rep Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


post/commission-activities-undo-by-rep/{commActivityKey}
Request samples 
Response samples 
No sample
Generate Commission Checks Advanced API 
Send in a list of Commission Checks to be generated.


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


 
Request Body schema: 
required
 Array 
selected
integer <int32> 
 
check_Number
string or null
 
check_Date
string or null <date-time> 
 
check_Type
string or null
 
name_On_Check
string or null
 
check_Status
string or null
 
amount_Due
number or null <double> 
 
paid_Amount
number or null <double> 
 
create_Date
string <date-time> 
 
create_User
string or null
 
check_Batch
integer <int32> 
 
payee_ID
string or null
 
payor_ID
string or null
 
account_Key
integer or null <int32> 
 
pay_To_ID
string or null
 
address_On_Check
string or null
 
address2_On_Check
string or null
 
city_On_Check
string or null
 
state_On_Check
string or null
 
zip_On_Check
string or null
 
send_Check_To
string or null
 
name_On_Address
string or null
 
payment_Method
string or null
 
signature_Key
integer or null <int32> 
 
check_Paid_Date
string or null <date-time> 
 
account_Balance
number or null <double> 
 
Responses 
200
Success


401
Unauthorized


post/commission-generate-checks
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": 0,
  • "error": {
    },
  • "debug": {
    }
}
Generate Commissions Advanced API 
Generates the Commission Activity records to be used by the Commission backend process for generation.


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


 
Request Body schema: 
required
commission_Date_Type
string or null
 
commission_Date
string or null <date-time> 
 
received_Thru
string or null <date-time> 
 
billed_Thru
string or null <date-time> 
 
commission_Run_By_Option
integer <int32> 
 
payment_Interval
string or null
 
current_Only
boolean
 
user_ID
string or null
 
machine_ID
string or null
 
reps
Array of integers or null <int32> 
 
groups
Array of strings or null
 
Responses 
202
Accepted for processing


401
Unauthorized


post/commission-generate-activity
Request samples 
{
  • "commission_Date_Type": "string",
  • "commission_Date": "2019-08-24T14:15:22Z",
  • "received_Thru": "2019-08-24T14:15:22Z",
  • "billed_Thru": "2019-08-24T14:15:22Z",
  • "commission_Run_By_Option": 0,
  • "payment_Interval": "string",
  • "current_Only": true,
  • "user_ID": "string",
  • "machine_ID": "string",
  • "reps": [
    ],
  • "groups": [
    ]
}
Process Automation for Generate Commissions Advanced API 
Utilizing a Commission Transaction Key produced after generating commissions, fire process automation configuration.


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


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
202
Accepted for processing


401
Unauthorized


post/commission-transaction-process-automation/{commTransKey}
Request samples