Commission Rep Groups

Create CommissionRepGroup

Creates a new CommissionRepGroup

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

CommissionRep Key

header Parameters
vbasoftware-database
required
string

Target database

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

Success

401

Unauthorized

post/commission-reps/{commRepKey}/commission-rep-groups
Request samples
{
  • "commissionRepGroup_Key": 0,
  • "commissionRep_Key": 0,
  • "division_ID": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "group_ID": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List CommissionRepGroup

Lists all CommissionRepGroup for the given commRepKey

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

CommissionRep 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-reps/{commRepKey}/commission-rep-groups
Request samples 
Response samples 
No sample
Get CommissionRepGroup
Gets CommissionRepGroup


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
commRepKey
required
integer <int32> 
CommissionRep Key


 
commRepGroupKey
required
integer <int32> 
CommissionRepGroup Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/commission-reps/{commRepKey}/commission-rep-groups/{commRepGroupKey}
Request samples 
Response samples 
No sample
Update CommissionRepGroup
Updates a specific CommissionRepGroup.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
commRepKey
required
integer <int32> 
CommissionRep Key


 
commRepGroupKey
required
integer <int32> 
CommissionRepGroup Key


 
header Parameters
vbasoftware-database
required
string
Target database


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


401
Unauthorized


put/commission-reps/{commRepKey}/commission-rep-groups/{commRepGroupKey}
Request samples 
{
  • "commissionRepGroup_Key": 0,
  • "commissionRep_Key": 0,
  • "division_ID": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "group_ID": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete CommissionRepGroup
Deletes an CommissionRepGroup


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
commRepKey
required
integer <int32> 
CommissionRep Key


 
commRepGroupKey
required
integer <int32> 
CommissionRepGroup Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/commission-reps/{commRepKey}/commission-rep-groups/{commRepGroupKey}
Request samples 
Create or Update Batch CommissionRepGroup
Create or Update multiple CommissionRepGroup 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
commRepKey
required
integer <int32> 
CommissionRep Key


 
header Parameters
vbasoftware-database
required
string
Target database


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


401
Unauthorized


put/commission-reps/{commRepKey}/commission-rep-groups-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}