Commission Activity Parameters

Create CommissionParameter

Creates a new CommissionParameter

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

CommissionActivity Key

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
commissionParameter_Key
required
integer <int32>
billedThru
string or null <date-time>
commissionActivity_Key
required
integer <int32>
commissionAgencyRepKey
integer or null <int32>
commissionDate
string or null <date-time>
commissionDateType
string or null <= 1 characters
end_Date
string or null <date-time>
groupID
string or null <= 20 characters
receivedThru
string or null <date-time>
start_Date
string or null <date-time>
undo_Date
string or null <date-time>
undo_User
string or null <= 16 characters
userID
string or null <= 20 characters
Responses
200

Success

401

Unauthorized

post/commission-activities/{commActivityKey}/commission-parameters
Request samples
{
  • "commissionParameter_Key": 0,
  • "billedThru": "2019-08-24T14:15:22Z",
  • "commissionActivity_Key": 0,
  • "commissionAgencyRepKey": 0,
  • "commissionDate": "2019-08-24T14:15:22Z",
  • "commissionDateType": "s",
  • "end_Date": "2019-08-24T14:15:22Z",
  • "groupID": "string",
  • "receivedThru": "2019-08-24T14:15:22Z",
  • "start_Date": "2019-08-24T14:15:22Z",
  • "undo_Date": "2019-08-24T14:15:22Z",
  • "undo_User": "string",
  • "userID": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List CommissionParameter

Lists all CommissionParameter for the given commActivityKey

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

CommissionActivity 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-activities/{commActivityKey}/commission-parameters
Request samples 
Response samples 
No sample
Get CommissionParameter
Gets CommissionParameter


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


 
commParameterKey
required
integer <int32> 
CommissionParameter Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/commission-activities/{commActivityKey}/commission-parameters/{commParameterKey}
Request samples 
Response samples 
No sample
Update CommissionParameter
Updates a specific CommissionParameter.


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


 
commParameterKey
required
integer <int32> 
CommissionParameter Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
commissionParameter_Key
required
integer <int32> 
 
billedThru
string or null <date-time> 
 
commissionActivity_Key
required
integer <int32> 
 
commissionAgencyRepKey
integer or null <int32> 
 
commissionDate
string or null <date-time> 
 
commissionDateType
string or null  <= 1 characters 
 
end_Date
string or null <date-time> 
 
groupID
string or null  <= 20 characters 
 
receivedThru
string or null <date-time> 
 
start_Date
string or null <date-time> 
 
undo_Date
string or null <date-time> 
 
undo_User
string or null  <= 16 characters 
 
userID
string or null  <= 20 characters 
 
Responses 
200
Success


401
Unauthorized


put/commission-activities/{commActivityKey}/commission-parameters/{commParameterKey}
Request samples 
{
  • "commissionParameter_Key": 0,
  • "billedThru": "2019-08-24T14:15:22Z",
  • "commissionActivity_Key": 0,
  • "commissionAgencyRepKey": 0,
  • "commissionDate": "2019-08-24T14:15:22Z",
  • "commissionDateType": "s",
  • "end_Date": "2019-08-24T14:15:22Z",
  • "groupID": "string",
  • "receivedThru": "2019-08-24T14:15:22Z",
  • "start_Date": "2019-08-24T14:15:22Z",
  • "undo_Date": "2019-08-24T14:15:22Z",
  • "undo_User": "string",
  • "userID": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete CommissionParameter
Deletes an CommissionParameter


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


 
commParameterKey
required
integer <int32> 
CommissionParameter Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/commission-activities/{commActivityKey}/commission-parameters/{commParameterKey}
Request samples 
Create or Update Batch CommissionParameter
Create or Update multiple CommissionParameter 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
commActivityKey
required
integer <int32> 
CommissionActivity Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
commissionParameter_Key
required
integer <int32> 
 
billedThru
string or null <date-time> 
 
commissionActivity_Key
required
integer <int32> 
 
commissionAgencyRepKey
integer or null <int32> 
 
commissionDate
string or null <date-time> 
 
commissionDateType
string or null  <= 1 characters 
 
end_Date
string or null <date-time> 
 
groupID
string or null  <= 20 characters 
 
receivedThru
string or null <date-time> 
 
start_Date
string or null <date-time> 
 
undo_Date
string or null <date-time> 
 
undo_User
string or null  <= 16 characters 
 
userID
string or null  <= 20 characters 
 
Responses 
207
Success


401
Unauthorized


put/commission-activities/{commActivityKey}/commission-parameters-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}