Commission Rate Subscribers

Create CommissionRateSubscriber

Creates a new CommissionRateSubscriber

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

CommissionRate Key

subscriberId
required
string

Subscriber ID

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
commissionRate_Key
required
integer <int32>
subscriber_ID
required
string [ 1 .. 9 ] characters
entry_Date
string <date-time>
entry_User
string or null <= 20 characters
update_Date
string <date-time>
update_User
string or null <= 20 characters
Responses
200

Success

401

Unauthorized

post/commission-rates/{commRateKey}/commission-rate-subscribers/{subscriberId}
Request samples
{
  • "commissionRate_Key": 0,
  • "subscriber_ID": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

Get CommissionRateSubscriber

Gets CommissionRateSubscriber

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

CommissionRate Key

subscriberId
required
string

Subscriber ID

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/commission-rates/{commRateKey}/commission-rate-subscribers/{subscriberId}
Request samples 
Response samples 
No sample
Update CommissionRateSubscriber
Updates a specific CommissionRateSubscriber.


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


 
subscriberId
required
string
Subscriber ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
commissionRate_Key
required
integer <int32> 
 
subscriber_ID
required
string  [ 1 .. 9 ] characters 
 
entry_Date
string <date-time> 
 
entry_User
string or null  <= 20 characters 
 
update_Date
string <date-time> 
 
update_User
string or null  <= 20 characters 
 
Responses 
200
Success


401
Unauthorized


put/commission-rates/{commRateKey}/commission-rate-subscribers/{subscriberId}
Request samples 
{
  • "commissionRate_Key": 0,
  • "subscriber_ID": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete CommissionRateSubscriber
Deletes an CommissionRateSubscriber


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


 
subscriberId
required
string
Subscriber ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/commission-rates/{commRateKey}/commission-rate-subscribers/{subscriberId}
Request samples 
List CommissionRateSubscriber
Lists all CommissionRateSubscriber for the given commRateKey


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
commRateKey
required
integer <int32> 
CommissionRate 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-rates/{commRateKey}/commission-rate-subscribers
Request samples 
Response samples 
No sample
Create or Update Batch CommissionRateSubscriber
Create or Update multiple CommissionRateSubscriber 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
commRateKey
required
integer <int32> 
CommissionRate Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
commissionRate_Key
required
integer <int32> 
 
subscriber_ID
required
string  [ 1 .. 9 ] characters 
 
entry_Date
string <date-time> 
 
entry_User
string or null  <= 20 characters 
 
update_Date
string <date-time> 
 
update_User
string or null  <= 20 characters 
 
Responses 
207
Success


401
Unauthorized


put/commission-rates/{commRateKey}/commission-rate-subscribers-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}
List VBA_CommissionRateSubscriber that match provided filters
Retrieves a list of VBA_CommissionRateSubscriber that match provided filters. The endpoint requires a CommissionRate Key, Group ID query parameter and an optional Division ID query parameter. By default, all records, including unassigned, are included. However, the Include Unassigned query parameter can be set to false to exclude unassigned records.


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


 
query Parameters
groupID
required
string
Group ID


 
divisionID
string
Division ID


 
includeUnassigned
boolean
 Default:  true
Include Unassigned


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/commission-rates/{commRateKey}/commission-rate-subscribers-match
Request samples 
Response samples 
No sample